DataPager Class
Provides paging functionality for data-bound controls that implement the IPageableItemContainer interface, such as the ListView control.
Assembly: System.Web.Extensions (in System.Web.Extensions.dll)
| Name | Description | |
|---|---|---|
![]() | DataPager() | Initializes a new instance of the DataPager class. |
| Name | Description | |
|---|---|---|
![]() | Adapter | Gets the browser-specific adapter for the control.(Inherited from Control.) |
![]() | AppRelativeTemplateSourceDirectory | Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control.(Inherited from Control.) |
![]() | Attributes | Gets a collection of custom attribute name/value pairs for the DataPager control. |
![]() | BindingContainer | This API supports the product infrastructure and is not intended to be used directly from your code. Gets the control that contains this control's data binding.(Inherited from Control.) |
![]() | ChildControlsCreated | Gets a value that indicates whether the server control's child controls have been created.(Inherited from Control.) |
![]() | ClientID | Gets the control ID for HTML markup that is generated by ASP.NET.(Inherited from Control.) |
![]() | ClientIDMode | |
![]() | ClientIDSeparator | |
![]() | Context | Gets the HttpContext object associated with the server control for the current Web request.(Inherited from Control.) |
![]() | Controls | Gets a ControlCollection object that represents the child controls for the DataPager control in the UI hierarchy.(Overrides Control.Controls.) |
![]() | DataItemContainer | Gets a reference to the naming container if the naming container implements IDataItemContainer.(Inherited from Control.) |
![]() | DataKeysContainer | Gets a reference to the naming container if the naming container implements IDataKeysControl.(Inherited from Control.) |
![]() | DesignMode | Gets a value indicating whether a control is being used on a design surface.(Inherited from Control.) |
![]() | EnableTheming | Gets or sets a value indicating whether themes apply to this control.(Inherited from Control.) |
![]() | EnableViewState | Gets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client.(Inherited from Control.) |
![]() | Events | Gets a list of event handler delegates for the control. This property is read-only.(Inherited from Control.) |
![]() | Fields | Gets a collection of DataPagerField objects that represent the pager fields that are specified in a DataPager control. |
![]() | HasChildViewState | Gets a value indicating whether the current server control's child controls have any saved view-state settings.(Inherited from Control.) |
![]() | ID | Gets or sets the programmatic identifier assigned to the server control.(Inherited from Control.) |
![]() | IdSeparator | This API supports the product infrastructure and is not intended to be used directly from your code. Gets the character used to separate control identifiers.(Inherited from Control.) |
![]() | IsChildControlStateCleared | Gets a value indicating whether controls contained within this control have control state.(Inherited from Control.) |
![]() | IsTrackingViewState | Gets a value that indicates whether the server control is saving changes to its view state.(Inherited from Control.) |
![]() | IsViewStateEnabled | Gets a value indicating whether view state is enabled for this control.(Inherited from Control.) |
![]() | LoadViewStateByID | |
![]() | MaximumRows | Gets the maximum number of records that are displayed for each page of data. |
![]() | NamingContainer | Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same Control.ID property value.(Inherited from Control.) |
![]() | Page | |
![]() | PagedControlID | Gets or sets the ID of the control that contains the data that will be paged by the DataPager control. |
![]() | PageSize | Gets or sets the number of records that are displayed for each page of data. |
![]() | Parent | Gets a reference to the server control's parent control in the page control hierarchy.(Inherited from Control.) |
![]() | QueryStringField | Gets or sets the name of the query string field. |
![]() | RenderingCompatibility | Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with.(Inherited from Control.) |
![]() | Site | Gets information about the container that hosts the current control when rendered on a design surface.(Inherited from Control.) |
![]() | SkinID | Gets or sets the skin to apply to the control.(Inherited from Control.) |
![]() | StartRowIndex | Gets the index of the first record that is displayed on a page of data . |
![]() | TagKey | Gets the HTML element that is used to render the DataPager control. |
![]() | TemplateControl | Gets or sets a reference to the template that contains this control. (Inherited from Control.) |
![]() | TemplateSourceDirectory | Gets the virtual directory of the Page or UserControl that contains the current server control.(Inherited from Control.) |
![]() | TotalRowCount | Gets the total number of records that are retrieved by the underlying data source object that is referenced by the associated data-bound control. |
![]() | UniqueID | Gets the unique, hierarchically qualified identifier for the server control.(Inherited from Control.) |
![]() | ValidateRequestMode | Gets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values.(Inherited from Control.) |
![]() | ViewState | Gets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page.(Inherited from Control.) |
![]() | ViewStateIgnoresCase | |
![]() | ViewStateMode | Gets or sets the view-state mode of this control.(Inherited from Control.) |
![]() | Visible | Gets or sets a value that indicates whether a server control is rendered as UI on the page.(Inherited from Control.) |
| Name | Description | |
|---|---|---|
![]() | AddAttributesToRender(HtmlTextWriter) | Adds HTML attributes and styles to be rendered in the browser to the specified HtmlTextWriter object. |
![]() | AddedControl(Control, Int32) | |
![]() | AddParsedSubObject(Object) | Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's ControlCollection object.(Inherited from Control.) |
![]() | ApplyStyleSheetSkin(Page) | Applies the style properties defined in the page style sheet to the control.(Inherited from Control.) |
![]() | BeginRenderTracing(TextWriter, Object) | Begins design-time tracing of rendering data.(Inherited from Control.) |
![]() | BuildProfileTree(String, Boolean) | |
![]() | ClearCachedClientID() | |
![]() | ClearChildControlState() | Deletes the control-state information for the server control's child controls. (Inherited from Control.) |
![]() | ClearChildState() | Deletes the view-state and control-state information for all the server control's child controls.(Inherited from Control.) |
![]() | ClearChildViewState() | Deletes the view-state information for all the server control's child controls.(Inherited from Control.) |
![]() | ClearEffectiveClientIDMode() | This API supports the product infrastructure and is not intended to be used directly from your code. Sets the ClientIDMode property of the current control instance and of any child controls to Inherit.(Inherited from Control.) |
![]() | ConnectToEvents(IPageableItemContainer) | Connects events to event handler methods in the DataPager control. |
![]() | CreateChildControls() | Called by the ASP.NET page framework to notify server controls that use composition-based implementation to create any child controls they contain in preparation for posting back or rendering.(Inherited from Control.) |
![]() | CreateControlCollection() | Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control.(Inherited from Control.) |
![]() | CreatePagerFields() | Creates the DataPagerField objects that are contained by the Fields property of the DataPager control. |
![]() | DataBind() | Binds the DataPager control and all its child controls to a data source.(Overrides Control.DataBind().) |
![]() | DataBind(Boolean) | Binds a data source to the invoked server control and all its child controls with an option to raise the DataBinding event. (Inherited from Control.) |
![]() | DataBindChildren() | Binds a data source to the server control's child controls.(Inherited from Control.) |
![]() | Dispose() | Enables a server control to perform final clean up before it is released from memory.(Inherited from Control.) |
![]() | EndRenderTracing(TextWriter, Object) | Ends design-time tracing of rendering data.(Inherited from Control.) |
![]() | EnsureChildControls() | Determines whether the server control contains child controls. If it does not, it creates child controls.(Inherited from Control.) |
![]() | EnsureID() | Creates an identifier for controls that do not have an identifier assigned.(Inherited from Control.) |
![]() | Equals(Object) | Determines whether the specified object is equal to the current object.(Inherited from Object.) |
![]() | Finalize() | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.) |
![]() | FindControl(String) | Searches the current naming container for a server control with the specified id parameter.(Inherited from Control.) |
![]() | FindControl(String, Int32) | This API supports the product infrastructure and is not intended to be used directly from your code. Searches the current naming container for a server control with the specified id and an integer, specified in the pathOffset parameter, which aids in the search. You should not override this version of the FindControl method.(Inherited from Control.) |
![]() | FindPageableItemContainer() | Retrieves the data-bound control that is associated with the DataPager control. |
![]() | Focus() | Sets input focus to a control.(Inherited from Control.) |
![]() | GetDesignModeState() | This API supports the product infrastructure and is not intended to be used directly from your code. Gets design-time data for a control.(Inherited from Control.) |
![]() | GetHashCode() | Serves as the default hash function. (Inherited from Object.) |
![]() | GetRouteUrl(Object) | Gets the URL that corresponds to a set of route parameters.(Inherited from Control.) |
![]() | GetRouteUrl(RouteValueDictionary) | Gets the URL that corresponds to a set of route parameters.(Inherited from Control.) |
![]() | GetRouteUrl(String, Object) | Gets the URL that corresponds to a set of route parameters and a route name.(Inherited from Control.) |
![]() | GetRouteUrl(String, RouteValueDictionary) | Gets the URL that corresponds to a set of route parameters and a route name.(Inherited from Control.) |
![]() | GetType() | |
![]() | GetUniqueIDRelativeTo(Control) | |
![]() | HasControls() | Determines if the server control contains any child controls.(Inherited from Control.) |
![]() | HasEvents() | Returns a value indicating whether events are registered for the control or any child controls.(Inherited from Control.) |
![]() | IsLiteralContent() | This API supports the product infrastructure and is not intended to be used directly from your code. Determines if the server control holds only literal content.(Inherited from Control.) |
![]() | LoadControlState(Object) | This API supports the product infrastructure and is not intended to be used directly from your code. Loads the state information for the properties in the DataPager control that must be persisted between postbacks, even when the EnableViewState property is set to false.(Overrides Control.LoadControlState(Object).) |
![]() | LoadViewState(Object) | Restores view-state information for the DataPager control that was saved by the SaveViewState method during a previous page request.(Overrides Control.LoadViewState(Object).) |
![]() | MapPathSecure(String) | Retrieves the physical path that a virtual path, either absolute or relative, maps to.(Inherited from Control.) |
![]() | MemberwiseClone() | |
![]() | OnBubbleEvent(Object, EventArgs) | Determines whether an event for the DataPager control is passed up the page's user interface (UI) server control hierarchy(Overrides Control.OnBubbleEvent(Object, EventArgs).) |
![]() | OnDataBinding(EventArgs) | Raises the DataBinding event.(Inherited from Control.) |
![]() | OnInit(EventArgs) | This API supports the product infrastructure and is not intended to be used directly from your code. Raises the Init event.(Overrides Control.OnInit(EventArgs).) |
![]() | OnLoad(EventArgs) | This API supports the product infrastructure and is not intended to be used directly from your code. Raises the Load event.(Overrides Control.OnLoad(EventArgs).) |
![]() | OnPreRender(EventArgs) | |
![]() | OnTotalRowCountAvailable(Object, PageEventArgs) | Handles the IPageableItemContainer.TotalRowCountAvailable event. |
![]() | OnUnload(EventArgs) | |
![]() | OpenFile(String) | |
![]() | RaiseBubbleEvent(Object, EventArgs) | Assigns any sources of the event and its information to the control's parent.(Inherited from Control.) |
![]() | RecreateChildControls() | Creates child controls of the DataPager control at design time. |
![]() | RemovedControl(Control) | |
![]() | Render(HtmlTextWriter) | This API supports the product infrastructure and is not intended to be used directly from your code. Sends the DataPager control content to the specified HtmlTextWriter object, which writes the content to be rendered to the browser.(Overrides Control.Render(HtmlTextWriter).) |
![]() | RenderBeginTag(HtmlTextWriter) | Renders the HTML opening tag of the DataPager control to the specified writer. |
![]() | RenderChildren(HtmlTextWriter) | Outputs the content of a server control's children to a provided HtmlTextWriter object, which writes the content to be rendered on the client.(Inherited from Control.) |
![]() | RenderContents(HtmlTextWriter) | Renders the contents of the DataPager control to the specified writer. |
![]() | RenderControl(HtmlTextWriter) | Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled.(Inherited from Control.) |
![]() | RenderControl(HtmlTextWriter, ControlAdapter) | Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object.(Inherited from Control.) |
![]() | ResolveAdapter() | Gets the control adapter responsible for rendering the specified control.(Inherited from Control.) |
![]() | ResolveClientUrl(String) | Gets a URL that can be used by the browser.(Inherited from Control.) |
![]() | ResolveUrl(String) | Converts a URL into one that is usable on the requesting client.(Inherited from Control.) |
![]() | SaveControlState() | This API supports the product infrastructure and is not intended to be used directly from your code. Saves the state of the properties in the DataPager control that must be persisted between postbacks, even when the EnableViewState property is set to false.(Overrides Control.SaveControlState().) |
![]() | SaveViewState() | Saves any changes to an DataPager control's view-state that have occurred since the time the page was posted back to the server.(Overrides Control.SaveViewState().) |
![]() | SetDesignModeState(IDictionary) | Sets design-time data for a control.(Inherited from Control.) |
![]() | SetPageProperties(Int32, Int32, Boolean) | Sets the page-related properties in the DataPager control. |
![]() | SetRenderMethodDelegate(RenderMethod) | This API supports the product infrastructure and is not intended to be used directly from your code. Assigns an event handler delegate to render the server control and its content into its parent control.(Inherited from Control.) |
![]() | SetTraceData(Object, Object) | Sets trace data for design-time tracing of rendering data, using the trace data key and the trace data value.(Inherited from Control.) |
![]() | SetTraceData(Object, Object, Object) | Sets trace data for design-time tracing of rendering data, using the traced object, the trace data key, and the trace data value.(Inherited from Control.) |
![]() | ToString() | Returns a string that represents the current object.(Inherited from Object.) |
![]() | TrackViewState() | Tracks view-state changes to the DataPager control so that they can be stored in the control's StateBag object. This object can be accessed through the ViewState property.(Overrides Control.TrackViewState().) |
| Name | Description | |
|---|---|---|
![]() | DataBinding | Occurs when the server control binds to a data source.(Inherited from Control.) |
![]() | Disposed | Occurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested.(Inherited from Control.) |
![]() | Init | Occurs when the server control is initialized, which is the first step in its lifecycle.(Inherited from Control.) |
![]() | Load | |
![]() | PreRender | |
![]() | Unload | Occurs when the server control is unloaded from memory.(Inherited from Control.) |
| Name | Description | |
|---|---|---|
![]() ![]() | IAttributeAccessor.GetAttribute(String) | This API supports the product infrastructure and is not intended to be used directly from your code. Retrieves the attribute value with the specified name from the DataPager control. |
![]() ![]() | IAttributeAccessor.SetAttribute(String, String) | This API supports the product infrastructure and is not intended to be used directly from your code. Sets an attribute of the DataPager control with the specified name and value. |
![]() ![]() | IControlDesignerAccessor.GetDesignModeState() | For a description of this member, see IControlDesignerAccessor.GetDesignModeState.(Inherited from Control.) |
![]() ![]() | IControlDesignerAccessor.SetDesignModeState(IDictionary) | For a description of this member, see IControlDesignerAccessor.SetDesignModeState. (Inherited from Control.) |
![]() ![]() | IControlDesignerAccessor.SetOwnerControl(Control) | This API supports the product infrastructure and is not intended to be used directly from your code. For a description of this member, see IControlDesignerAccessor.SetOwnerControl. (Inherited from Control.) |
![]() ![]() | IParserAccessor.AddParsedSubObject(Object) | For a description of this member, see IParserAccessor.AddParsedSubObject. (Inherited from Control.) |
![]() ![]() | ICompositeControlDesignerAccessor.RecreateChildControls() | This API supports the product infrastructure and is not intended to be used directly from your code. Creates the child controls of the DataPager control at design time. |
![]() ![]() | IControlBuilderAccessor.ControlBuilder | For a description of this member, see IControlBuilderAccessor.ControlBuilder. (Inherited from Control.) |
![]() ![]() | IControlDesignerAccessor.UserData | For a description of this member, see IControlDesignerAccessor.UserData. (Inherited from Control.) |
![]() ![]() | IDataBindingsAccessor.DataBindings | For a description of this member, see IDataBindingsAccessor.DataBindings. (Inherited from Control.) |
![]() ![]() | IDataBindingsAccessor.HasDataBindings | For a description of this member, see IDataBindingsAccessor.HasDataBindings. (Inherited from Control.) |
![]() ![]() | IExpressionsAccessor.Expressions | For a description of this member, see IExpressionsAccessor.Expressions. (Inherited from Control.) |
![]() ![]() | IExpressionsAccessor.HasExpressions | For a description of this member, see IExpressionsAccessor.HasExpressions. (Inherited from Control.) |
| Name | Description | |
|---|---|---|
![]() | EnableDynamicData(Type) | Overloaded. Enables Dynamic Data behavior for the specified data control.(Defined by DataControlExtensions.) |
![]() | EnableDynamicData(Type, IDictionary<String, Object>) | Overloaded. Enables Dynamic Data behavior for the specified data control.(Defined by DataControlExtensions.) |
![]() | EnableDynamicData(Type, Object) | Overloaded. Enables Dynamic Data behavior for the specified data control.(Defined by DataControlExtensions.) |
![]() | FindDataSourceControl() | Returns the data source that is associated with the data control for the specified control.(Defined by DynamicDataExtensions.) |
![]() | FindFieldTemplate(String) | Returns the field template for the specified column in the specified control's naming container.(Defined by DynamicDataExtensions.) |
![]() | FindMetaTable() | Returns the metatable object for the containing data control.(Defined by DynamicDataExtensions.) |
![]() | GetDefaultValues() | Overloaded. Gets the collection of the default values for the specified data control.(Defined by DynamicDataExtensions.) |
![]() | GetMetaTable() | Overloaded. Gets the table metadata for the specified data control.(Defined by DynamicDataExtensions.) |
![]() | SetMetaTable(MetaTable) | Overloaded. Sets the table metadata for the specified data control.(Defined by DynamicDataExtensions.) |
![]() | SetMetaTable(MetaTable, IDictionary<String, Object>) | Overloaded. Sets the table metadata and default value mapping for the specified data control.(Defined by DynamicDataExtensions.) |
![]() | SetMetaTable(MetaTable, Object) | Overloaded. Sets the table metadata and default value mapping for the specified data control.(Defined by DynamicDataExtensions.) |
![]() | TryGetMetaTable(MetaTable) | Overloaded. Determines whether table metadata is available.(Defined by DynamicDataExtensions.) |
The DataPager class is used to page data and to display navigation controls for data-bound controls that implement the IPageableItemContainer interface. (An example of a control that implements the interface is the ListView control.)
You can associate the DataPager control with the data-bound control by using the PagedControlID property. Alternatively, you can put the DataPager control inside the data-bound control hierarchy. For example, in the ListView control, you can put the DataPager control inside the ListView.LayoutTemplate template.
You can customize the number of items that are displayed for each page of data by changing the PageSize property. You can also change the way a page is submitted to the server by setting the QueryStringField property.
In order for the DataPager control to display navigation controls, you must add pager fields to the control. The pager fields derive from the DataPagerField class. The following table lists the pager field types that you can use.
Pager field type | Description |
|---|---|
Enables users to navigate through pages one page at a time, or to jump to the first or last page. | |
Enables users to select a page by page number. | |
Enables you to create a custom paging UI. |
To declaratively add pager fields to the DataPager control, add a Fields element to the DataPager control. You can then add the pager fields to the Fields element. The pager fields are added to the Fields collection in the order that they appear in the Fields element. The Fields collection enables you to programmatically manage the pager fields in the DataPager control.
The following table lists read-only properties of the DataPager control that specify characteristics of the page of data. These properties are usually used for binding expressions in the TemplatePagerField object.
Property | Description |
|---|---|
The maximum number of records that are displayed for each page of data. | |
The index of the first record that is displayed on a page of data. | |
The total number of records that are available in the underlying data source. |
The default markup that is rendered default for this control might not comply with accessibility standards, such as the Web Content Accessibility Guidelines 1.0 (WCAG) priority 1 guidelines. For details about accessibility support for this control, see ASP.NET Controls and Accessibility.
<asp:DataPager EnableTheming="True|False" EnableViewState="True|False" ID="string" OnDataBinding="DataBinding event handler" OnDisposed="Disposed event handler" OnInit="Init event handler" OnLoad="Load event handler" OnPreRender="PreRender event handler" OnUnload="Unload event handler" PagedControlID="string" PageSize="integer" runat="server" SkinID="string" Visible="True|False" > <Fields> <asp:NextPreviousPagerField ButtonCssClass="string" ButtonType="Button|Image|Link" FirstPageImageUrl="string" FirstPageText="string" LastPageImageUrl="string" LastPageText="string" NextPageImageUrl="string" NextPageText="string" PreviousPageImageUrl="string" PreviousPageText="string" RenderDisabledButtonsAsLabels="True|False" RenderNonBreakingSpacesBetweenControls="True|False" ShowFirstPageButton="True|False" ShowLastPageButton="True|False" ShowNextPageButton="True|False" ShowPreviousPageButton="True|False" Visible="True|False" /> <asp:NumericPagerField ButtonCount="integer" ButtonType="Button|Image|Link" CurrentPageLabelCssClass="string" NextPageImageUrl="string" NextPageText="string" NextPreviousButtonCssClass="string" NumericButtonCssClass="string" PreviousPageImageUrl="string" PreviousPageText="string" RenderNonBreakingSpacesBetweenControls="True|False" Visible="True|False" /> <asp:TemplatePagerField OnPagerCommand="PagerCommand event handler" Visible="True|False" /> </Fields> </asp:DataPager>
Available since 3.5
Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.







