Home Library Learn Downloads Support Community
Sign in | United States - English | |
This topic has not yet been rated - Rate this topic

DataGridPagerStyle Class

.NET Framework 4

Specifies the style for the pager of the DataGrid control. This class cannot be inherited.

System.Object
  System.MarshalByRefObject
    System.ComponentModel.Component
      System.Web.UI.WebControls.Style
        System.Web.UI.WebControls.TableItemStyle
          System.Web.UI.WebControls.DataGridPagerStyle

Namespace:  System.Web.UI.WebControls
Assembly:  System.Web (in System.Web.dll)
C#
C++
F#
VB
Copy 
public sealed class DataGridPagerStyle : TableItemStyle

The DataGridPagerStyle type exposes the following members.

  Name Description
Public property BackColor Gets or sets the background color of the Web server control. (Inherited from Style.)
Public property BorderColor Gets or sets the border color of the Web server control. (Inherited from Style.)
Public property BorderStyle Gets or sets the border style of the Web server control. (Inherited from Style.)
Public property BorderWidth Gets or sets the border width of the Web server control. (Inherited from Style.)
Protected property CanRaiseEvents Gets a value indicating whether the component can raise an event. (Inherited from Component.)
Public property Container Gets the IContainer that contains the Component. (Inherited from Component.)
Public property CssClass Gets or sets the cascading style sheet (CSS) class rendered by the Web server control on the client. (Inherited from Style.)
Protected property DesignMode Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component.)
Protected property Events Gets the list of event handlers that are attached to this Component. (Inherited from Component.)
Public property Font Gets the font properties associated with the Web server control. (Inherited from Style.)
Public property ForeColor Gets or sets the foreground color (typically the color of the text) of the Web server control. (Inherited from Style.)
Public property Height Gets or sets the height of the Web server control. (Inherited from Style.)
Public property HorizontalAlign Gets or sets the horizontal alignment of the contents in a cell. (Inherited from TableItemStyle.)
Public property IsEmpty Infrastructure. A protected property. Gets a value indicating whether any style elements have been defined in the state bag. (Inherited from Style.)
Protected property IsTrackingViewState Returns a value indicating whether any style elements have been defined in the state bag. (Inherited from Style.)
Public property Mode Gets or sets a value that specifies whether the pager element displays buttons that link to the next and previous page, or numeric buttons that link directly to a page.
Public property NextPageText Gets or sets the text displayed for the next page button.
Public property PageButtonCount Gets or sets the number of numeric buttons to display concurrently in the pager element of the DataGrid control.
Public property Position Gets or sets the position of the pager element in the DataGrid control.
Public property PrevPageText Gets or sets the text displayed for the previous page button.
Public property RegisteredCssClass Gets the cascading style sheet (CSS) class that is registered with the control. (Inherited from Style.)
Public property Site Gets or sets the ISite of the Component. (Inherited from Component.)
Public property VerticalAlign Gets or sets the vertical alignment of the contents in a cell. (Inherited from TableItemStyle.)
Protected property ViewState Infrastructure. Gets the state bag that holds the style elements. (Inherited from Style.)
Public property Visible Gets or sets a value indicating whether the pager is displayed in the DataGrid control.
Public property Width Gets or sets the width of the Web server control. (Inherited from Style.)
Public property Wrap Gets or sets a value indicating whether the contents of a cell wrap in the cell. (Inherited from TableItemStyle.)
Top
  Name Description
Public method AddAttributesToRender(HtmlTextWriter) Adds HTML attributes and styles that need to be rendered to the specified System.Web.UI.HtmlTextWriter. This method is primarily used by control developers. (Inherited from Style.)
Public method AddAttributesToRender(HtmlTextWriter, WebControl) Adds information about horizontal alignment, vertical alignment, and wrap to the list of attributes to render. (Inherited from TableItemStyle.)
Public method CopyFrom Copies the style of the specified Style object into this instance of the DataGridPagerStyle class. (Overrides TableItemStyle.CopyFrom(Style).)
Public method CreateObjRef Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
Public method Dispose() Releases all resources used by the Component. (Inherited from Component.)
Protected method Dispose(Boolean) Releases the unmanaged resources used by the Component and optionally releases the managed resources. (Inherited from Component.)
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method FillStyleAttributes Adds the specified object's style properties to a System.Web.UI.CssStyleCollection object. (Inherited from Style.)
Protected method Finalize Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (Inherited from Component.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetLifetimeService Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected method GetService Returns an object that represents a service provided by the Component or by its Container. (Inherited from Component.)
Public method GetStyleAttributes Retrieves the System.Web.UI.CssStyleCollection object for the specified System.Web.UI.IUrlResolutionService-implemented object. (Inherited from Style.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method InitializeLifetimeService Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected method LoadViewState Loads the previously saved state. (Inherited from Style.)
Protected method MemberwiseClone() Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method MemberwiseClone(Boolean) Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
Public method MergeWith Merges the style of the specified Style object with this instance of the DataGridPagerStyle class. (Overrides TableItemStyle.MergeWith(Style).)
Public method Reset Restores the DataGridPagerStyle object to its default values. (Overrides TableItemStyle.Reset().)
Protected method SaveViewState A protected method. Saves any state that has been modified after the TrackViewState method was invoked. (Inherited from Style.)
Protected method SetBit Infrastructure. A protected internal method. Sets an internal bitmask field that indicates the style properties that are stored in the state bag. (Inherited from Style.)
Public method SetDirty Marks the Style so that its state will be recorded in view state. (Inherited from Style.)
Public method ToString Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component.)
Protected method TrackViewState A protected method. Marks the beginning for tracking state changes on the control. Any changes made after tracking has begun will be tracked and saved as part of the control view state. (Inherited from Style.)
Top
  Name Description
Public event Disposed Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)
Top
  Name Description
Explicit interface implemetation Private property IStateManager.IsTrackingViewState Gets a value that indicates whether a server control is tracking its view state changes. (Inherited from Style.)
Explicit interface implemetation Private method IStateManager.LoadViewState Infrastructure. Loads the previously saved state. (Inherited from Style.)
Explicit interface implemetation Private method IStateManager.SaveViewState Infrastructure. Returns the object containing state changes. (Inherited from Style.)
Explicit interface implemetation Private method IStateManager.TrackViewState Infrastructure. Starts tracking state changes. (Inherited from Style.)
Top

The pager is an element on the DataGrid control that allows you to link to other pages when paging is enabled. The PagerStyle property of the DataGrid control uses an instance of this class to represent the style properties for the pager.

For more information on paging, see AllowPaging and AllowCustomPaging.

The following code example demonstrates how to use a DataGridPagerStyle object to represent the style of the pager element in the PagerStyle property. The DataGridPagerStyle object sets the display mode and alignment of the paging element.

C#
VB
Copy 

<%@ 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 language="C#" runat="server">

      ICollection CreateDataSource() 
      {
         DataTable dt = new DataTable();
         DataRow dr;

         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)));

         for (int i = 0; i < 100; 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) 
      {
         if (chk1.Checked)
            MyDataGrid.PagerStyle.Mode = PagerMode.NumericPages;
         else 
            MyDataGrid.PagerStyle.Mode = PagerMode.NextPrev;

         BindGrid();
      }

      void MyDataGrid_Page(Object sender, DataGridPageChangedEventArgs e) 
      {
         MyDataGrid.CurrentPageIndex = e.NewPageIndex;
         BindGrid();
      }

      void BindGrid() 
      {
         MyDataGrid.DataSource = CreateDataSource();
         MyDataGrid.DataBind();
         ShowStats();
      }

      void ShowStats() 
      {
         lblEnabled.Text = "AllowPaging is " + MyDataGrid.AllowPaging;
         lblCurrentIndex.Text = "CurrentPageIndex is " + MyDataGrid.CurrentPageIndex;
         lblPageCount.Text = "PageCount is " + MyDataGrid.PageCount;
         lblPageSize.Text = "PageSize is " + MyDataGrid.PageSize;
      }


   </script>

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

   <h3>Paging with DataGrid</h3>

   <form id="form1" runat="server">

      <asp:DataGrid id="MyDataGrid" runat="server"
           AllowPaging="True"
           PageSize="10"
           PagerStyle-Mode="NumericPages"
           PagerStyle-HorizontalAlign="Right"
           OnPageIndexChanged="MyDataGrid_Page"
           BorderColor="black"
           BorderWidth="1"
           GridLines="Both"
           CellPadding="3"
           CellSpacing="0"
           Font-Names="Verdana"
           Font-Size="8pt"
           HeaderStyle-BackColor="#aaaadd"
           AlternatingItemStyle-BackColor="#eeeeee"/>

      <br />

      <asp:Checkbox id="chk1" runat="server"
           Text="Show numeric page navigation buttons"
           Font-Names="Verdana"
           Font-Size="8pt"
           AutoPostBack="true"/>

      <br />

      <table style="background-color:#eeeeee; padding:6">
         <tr>
            <td style="display:inline">


                  <asp:Label id="lblEnabled" 
                       runat="server"/><br />
                  <asp:Label id="lblCurrentIndex" 
                       runat="server"/><br />
                  <asp:Label id="lblPageCount" 
                       runat="server"/><br />
                  <asp:Label id="lblPageSize" 
                        runat="server"/><br />


            </td>
         </tr>
      </table>

   </form>

</body>
</html>

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ