System.Web.UI.WebControls Namespace DetailsView Class
.NET Framework version 2.0
Sets or retrieves a value specifying whether paging is enabled.
| Inline |
<asp:detailsview allowpaging = true | false ... > |
| Script |
DetailsView.AllowPaging [ = true | false ] |
This property accepts or returns only a boolean value: true if paging is enabled; otherwise, false. Default value is false.
The DetailsView control has built-in paging capabilities, which allow a user to navigate to a different record in the data source. The paging feature can be used with any data source object that supports the System.Collections.ICollection interface or a data source that supports paging capability.
To enable the paging feature, set the AllowPaging property to true. You can determine the total number of items in the underlying data source by using the PageCount property. To determine the index of the currently displayed item, use the PageIndex property.
When paging is enabled, an additional row called the pager row is automatically displayed in the DetailsView control. The pager row contains the page navigation controls and can be displayed at the top, bottom, or both the top and bottom of the control. The pager row has four built-in pager display modes. The following table describes the four modes.
| Mode |
Description |
| NextPrevious |
A set of pagination controls consisting of previous and next buttons. |
| NextPreviousFirstLast |
A set of pagination controls consisting of previous, next, first, and last buttons. |
| Numeric |
A set of pagination controls consisting of numbered link buttons to access pages directly. This is the default mode. |
| NumericFirstLast |
A set of pagination controls consisting of numbered and first and last link buttons. |
NOTE: The DetailsView control automatically hides the pager row when the data source contains fewer than two records.
You can control the settings of the pager row ( such as the pager display mode, the number of page links to display at a time, and the pager control's text label ) by using the PagerSettings property. To control the appearance of the pager row (including its background color and font color), use the PagerStyle property. The DetailsView control also allows you to define a custom template for the pager row. For more information on creating a custom pager row template, see PagerTemplate.
The DetailsView control provides several events that you can use to perform a custom action when paging occurs. The following table lists the available events.
| Event |
Description |
| PageIndexChanged |
Occurs when one of the pager buttons is clicked, but after the DetailsView control handles the paging operation. This event is commonly used when you need to perform a task after the user navigates to a different record in the control. |
| PageIndexChanging |
Occurs when one of the pager buttons is clicked, but before the DetailsView control handles the paging operation. This event is often used to cancel the paging operation. |
NOTE: These events are not raised when you change the PageIndex property programmatically.
The following example demonstrates how to set the AllowPaging property at design time to enable paging in a DetailsView.
<asp:detailsview id = "CustomersDetailsView" runat = "server"
datasourceid = "customers"
allowpaging
width=80% cellpadding=5
font-size = "8pt">
DetailsView Members PageIndex PageCount PageSize
