DataGrid.AllowCustomPaging DataGrid.AllowCustomPaging DataGrid.AllowCustomPaging DataGrid.AllowCustomPaging Property

Definizione

Ottiene o imposta un valore che indica se la funzionalità di spostamento personalizzato è abilitata.Gets or sets a value that indicates whether custom paging is enabled.

public:
 virtual property bool AllowCustomPaging { bool get(); void set(bool value); };
public virtual bool AllowCustomPaging { get; set; }
member this.AllowCustomPaging : bool with get, set
Public Overridable Property AllowCustomPaging As Boolean

Valore della proprietà

true se il paging personalizzato è abilitato; in caso contrario, false.true if custom paging is enabled; otherwise, false. Il valore predefinito è false.The default value is false.

Esempi

Nell'esempio di codice riportato di seguito viene illustrato AllowCustomPaging come utilizzare la proprietà per abilitare il paging personalizzato.The following code example demonstrates how to use the AllowCustomPaging property to enable custom paging.

<%@ Page Language="C#" AutoEventWireup="True" %>
<%@ Import Namespace="System.Data" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >

   <script runat="server">

      // Normally, an entire data source is loaded in the DataGrid control, 
      // which can take up a lot of resources. This example uses custom 
      // paging, which loads only the segment of data needed to fill a
      // single page. In order to query for the appropriate segment of
      // data, the index of the first item displayed on a page must be
      // tracked as the user navigates between pages.
      int startIndex = 0;

      ICollection CreateDataSource() 
      {

         // Create sample data for the DataGrid control.
         DataTable dt = new DataTable();
         DataRow dr;

         // Define the columns of the table.
         dt.Columns.Add(new DataColumn("IntegerValue", typeof(Int32)));
         dt.Columns.Add(new DataColumn("StringValue", typeof(string)));
         dt.Columns.Add(new DataColumn("DateTimeValue", typeof(string)));
         dt.Columns.Add(new DataColumn("BoolValue", typeof(bool)));

         // Populate the table with sample values. When using custom paging,
         // a query should only return enough data to fill a single page, 
         // beginning at the start index.
         for (int i = startIndex; i < (startIndex + MyDataGrid.PageSize); i++) 
         {
             dr = dt.NewRow();

             dr[0] = i;
             dr[1] = "Item " + i.ToString();
             dr[2] = DateTime.Now.ToShortDateString();
             dr[3] = (i % 2 != 0) ? true : false;

             dt.Rows.Add(dr);
         }

         DataView dv = new DataView(dt);
         return dv;

      }

      void Page_Load(Object sender, EventArgs e) 
      {

         // Load sample data only once, when the page is first loaded.
         if (!IsPostBack) 
         {

            // Set the virtual item count, which specifies the total number
            // items displayed in the DataGrid control when custom paging
            // is used.
            MyDataGrid.VirtualItemCount = 200;

            // Retrieve the segment of data to display on the page from the
            // data source and bind it to the DataGrid control.
            BindGrid();

         }

      }

      void MyDataGrid_Page(Object sender, DataGridPageChangedEventArgs e) 
      {

         // For the DataGrid control to navigate to the correct page when
         // paging is allowed, the CurrentPageIndex property must be updated
         // programmatically. This process is usually accomplished in the
         // event-handling method for the PageIndexChanged event.

         // Set CurrentPageIndex to the page the user clicked.
         MyDataGrid.CurrentPageIndex = e.NewPageIndex;

         // Calculate the index of the first item to display on the page 
         // using the current page index and the page size.
         startIndex = MyDataGrid.CurrentPageIndex * MyDataGrid.PageSize;

         // Retrieve the segment of data to display on the page from the 
         // data source and bind it to the DataGrid control.
         BindGrid();

      }

      void BindGrid() 
      {

         MyDataGrid.DataSource = CreateDataSource();
         MyDataGrid.DataBind();

      }

   </script>

<head runat="server">
    <title> DataGrid Custom Paging Example </title>
</head>
<body>

   <form id="form1" runat="server">
 
      <h3> DataGrid Custom Paging Example </h3>

      <asp:DataGrid id="MyDataGrid" 
           AllowCustomPaging="True" 
           AllowPaging="True" 
           PageSize="10" 
           OnPageIndexChanged="MyDataGrid_Page" 
           runat="server">

         <HeaderStyle BackColor="Navy" 
                      ForeColor="White" 
                      Font-Bold="True" />

         <PagerStyle Mode="NumericPages" 
                     HorizontalAlign="Right" />

      </asp:DataGrid>

   </form>

</body>
</html>

<%@ Page Language="VB" AutoEventWireup="True" %>
<%@ Import Namespace="System.Data" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >

   <script runat="server">

      ' Normally, an entire data source is loaded in the DataGrid control, 
      ' which can take up a lot of resources. This example uses custom 
      ' paging, which loads only the segment of data needed to fill a
      ' single page. In order to query for the appropriate segment of
      ' data, the index of the first item displayed on a page must be
      ' tracked as the user navigates between pages.
      Dim startIndex As Integer = 0

      Function CreateDataSource() As ICollection 

         ' Create sample data for the DataGrid control.
         Dim dt As DataTable = New DataTable()
         Dim dr As DataRow

         ' Define the columns of the table.
         dt.Columns.Add(New DataColumn("IntegerValue", GetType(Int32)))
         dt.Columns.Add(New DataColumn("StringValue", GetType(String)))
         dt.Columns.Add(New DataColumn("DateTimeValue", GetType(String)))
         dt.Columns.Add(New DataColumn("BoolValue", GetType(Boolean)))

         ' Populate the table with sample values. When using custom paging,
         ' a query should only return enough data to fill a single page, 
         ' beginning at the start index.
         Dim i As Integer         

         For i = startIndex To ((startIndex + MyDataGrid.PageSize) - 1) 

             dr = dt.NewRow()

             dr(0) = i
             dr(1) = "Item " & i.ToString()
             dr(2) = DateTime.Now.ToShortDateString()
             If (i Mod 2 <> 0) Then
                dr(3) = True
             Else
                dr(3) = False
             End If

             dt.Rows.Add(dr)

         Next i

         Dim dv As DataView = New DataView(dt)
         Return dv

      End Function

      Sub Page_Load(sender As Object, e As EventArgs) 

         ' Load sample data only once, when the page is first loaded.
         If Not IsPostBack Then 

            ' Set the virtual item count, which specifies the total number
            ' items displayed in the DataGrid control when custom paging
            ' is used.
            MyDataGrid.VirtualItemCount = 200

            ' Retrieve the segment of data to display on the page from the 
            ' data source and bind it to the DataGrid control.
            BindGrid()

         End If

      End Sub

      Sub MyDataGrid_Page(sender as Object, e As DataGridPageChangedEventArgs) 

         ' For the DataGrid control to navigate to the correct page when
         ' paging is allowed, the CurrentPageIndex property must be updated
         ' programmatically. This process is usually accomplished in the
         ' event-handling method for the PageIndexChanged event.

         ' Set CurrentPageIndex to the page the user clicked.
         MyDataGrid.CurrentPageIndex = e.NewPageIndex

         ' Calculate the index of the first item to display on the page 
         ' using the current page index and the page size.
         startIndex = MyDataGrid.CurrentPageIndex * MyDataGrid.PageSize

         ' Retrieve the segment of data to display on the page from the 
         ' data source and bind it to the DataGrid control.
         BindGrid()

      End Sub

      Sub BindGrid() 

         MyDataGrid.DataSource = CreateDataSource()
         MyDataGrid.DataBind()

      End Sub

   </script>

<head runat="server">
    <title> DataGrid Custom Paging Example </title>
</head>
<body>

   <form id="form1" runat="server">
 
      <h3> DataGrid Custom Paging Example </h3>

      <asp:DataGrid id="MyDataGrid" 
           AllowCustomPaging="True" 
           AllowPaging="True" 
           PageSize="10" 
           OnPageIndexChanged="MyDataGrid_Page" 
           runat="server">

         <HeaderStyle BackColor="Navy" 
                      ForeColor="White" 
                      Font-Bold="True" />

         <PagerStyle Mode="NumericPages" 
                     HorizontalAlign="Right" />

      </asp:DataGrid>

   </form>

</body>
</html>

Commenti

Il paging consente di visualizzare il contenuto del DataGrid controllo nei segmenti di pagina.Paging allows you to display the contents of the DataGrid control in page segments. Il numero di elementi in una pagina è determinato dalla PageSize proprietà.The number of items on a page is determined by the PageSize property. Se non viene specificato alcun valore per PageSize la proprietà DataGrid , visualizzerà 10 elementi in una pagina.If no value is specified for the PageSize property, the DataGrid will display 10 items on a page.

In genere, un'origine dati contenente ogni riga nel DataGrid controllo viene caricata ogni volta che il DataGrid controllo si sposta in una pagina diversa.Normally, a data source that contains every row in the DataGrid control is loaded every time the DataGrid control moves to a different page. In questo modo è possibile utilizzare molte risorse quando l'origine dati è di dimensioni molto elevate.This can consume a lot of resources when the data source is very large. Il paging personalizzato consente di caricare solo il segmento di dati necessario per visualizzare una singola pagina.Custom paging allows you to load just the segment of data needed to display a single page.

Per abilitare il paging personalizzato, impostare entrambe AllowPaging le AllowCustomPaging proprietà e truesu.To enable custom paging, set both the AllowPaging and AllowCustomPaging properties to true. Fornire quindi il codice per gestire l' PageIndexChanged evento.Next, provide code to handle the PageIndexChanged event.

La logica tipica per il PageIndexChanged gestore eventi è la prima CurrentPageIndex impostazione della proprietà sull'indice della pagina che si desidera visualizzare.The typical logic for the PageIndexChanged event handler is to first set the CurrentPageIndex property to the index of the page you want to display.

Nota

Il gestore eventi riceve un DataGridPageChangedEventArgs oggetto come parametro.The event handler receives a DataGridPageChangedEventArgs object as a parameter. È possibile utilizzare la NewPageIndex proprietà di questo parametro per determinare l'indice della pagina selezionata dall'utente dagli elementi DataGrid di selezione della pagina del controllo.You can use the NewPageIndex property of this parameter to determine the index of the page selected by the user from the page selection elements of the DataGrid control.

Successivamente, creare un'origine dati che contenga i dati da visualizzare in una singola pagina, quindi utilizzare DataBind il metodo per associare i dati DataGrid al controllo.Next, create a data source that contains the data to display on a single page and then use the DataBind method to bind the data to the DataGrid control.

Nota

Poiché viene caricato solo un segmento dei dati, è necessario impostare la VirtualItemCount proprietà sul numero totale di elementi DataGrid nel controllo.Because only a segment of the data is loaded, you must set the VirtualItemCount property to the total number of items in the DataGrid control. Ciò consente al controllo di determinare il numero totale di pagine necessarie per visualizzare ogni elemento nel DataGrid controllo.This allows the control to determine the total number of pages needed to display every item in the DataGrid control. Questa proprietà viene in genere impostata a livello di codice una volta determinato il numero DataGrid totale di elementi nel controllo.This property is normally programmatically set once the total number of items in the DataGrid control is determined.

Quando il paging è abilitato con AllowCustomPaging la proprietà è impostata falsesu, DataGrid il controllo presuppone che l'origine dati contenga tutti gli elementi da visualizzare.When paging is enabled with the AllowCustomPaging property is set to false, the DataGrid control assumes that the data source contains all the items to be displayed. Il DataGrid controllo calcola gli indici degli elementi nella pagina visualizzata in base all'indice della pagina, specificato CurrentPageIndex dalla proprietà e al numero di elementi in una PageSize pagina, specificato dalla proprietà.The DataGrid control calculates the indexes of the items on the displayed page based on the page index, specified by the CurrentPageIndex property, and the number of items on a page, specified by the PageSize property.

Quando la AllowCustomPaging proprietà è impostata su true, il DataGrid controllo presuppone che l'origine dati contenga VirtualItemCount solo gli elementi come determinato dalla proprietà.When the AllowCustomPaging property is set to true, the DataGrid control assumes that the data source only contains the items as determined by the VirtualItemCount property. Vengono visualizzati tutti gli elementi fino al numero di elementi specificato PageSize dalla proprietà.All items up to the number of items specified by the PageSize property are displayed.

Si applica a

Vedi anche