System.Web.UI.WebControls.FormView.AllowPaging Property

Gets or sets a value indicating whether the paging feature is enabled.

Syntax

[System.ComponentModel.DefaultValue(false)]
public virtual bool AllowPaging { set; get; }

Value

Documentation for this section has not yet been entered.

Remarks

The System.Web.UI.WebControls.FormView 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 ICollection interface or a data source that supports paging capability.

To enable the paging feature, set the FormView.AllowPaging property to true. You can determine the total number of items in the underlying data source by using the FormView.PageCount property. To determine the index of the currently displayed item, use the FormView.PageIndex property.

When paging is enabled, an additional row called the pager row is automatically displayed in the System.Web.UI.WebControls.FormView 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.

PagerButton.NextPrevious

A set of pagination controls consisting of previous and next buttons.

PagerButton.NextPreviousFirstLast

A set of pagination controls consisting of previous, next, first, and last buttons.

PagerButton.Numeric

A set of pagination controls consisting of numbered link buttons to access pages directly. This is the default mode.

PagerButton.NumericFirstLast

A set of pagination controls consisting of numbered and first and last link buttons.

Note:

The System.Web.UI.WebControls.FormView 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 FormView.PagerSettings property. To control the appearance of the pager row (including its background color and font color), use the FormView.PagerStyle property. The System.Web.UI.WebControls.FormView control also allows you to define a custom template for the pager row. For more information on creating a custom pager row template, see FormView.PagerTemplate.

The System.Web.UI.WebControls.FormView control provides several events that you can use to perform a custom action when paging occurs. The following table lists the available events.

FormView.PageIndexChanged

Occurs when one of the pager buttons is clicked, but after the System.Web.UI.WebControls.FormView 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.

FormView.PageIndexChanging

Occurs when one of the pager buttons is clicked, but before the System.Web.UI.WebControls.FormView 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 FormView.PageIndex property programmatically.

Requirements

Namespace: System.Web.UI.WebControls
Assembly: System.Web (in System.Web.dll)
Assembly Versions: 2.0.0.0
Since: .NET 2.0