GridView::PagerTemplate Property

 

Gets or sets the custom content for the pager row in a GridView control.

Namespace:   System.Web.UI.WebControls
Assembly:  System.Web (in System.Web.dll)

public:
[BrowsableAttribute(false)]
[PersistenceModeAttribute(PersistenceMode::InnerProperty)]
[TemplateContainerAttribute((GridViewRow^::typeid))]
property ITemplate^ PagerTemplate {
	virtual ITemplate^ get();
	virtual void set(ITemplate^ value);
}

Property Value

Type: System.Web.UI::ITemplate^

A System.Web.UI::ITemplate that contains the custom content for the pager row. The default value is null, which indicates that this property is not set.

A pager row is displayed in a GridView control when the paging feature is enabled (when the AllowPaging property is set to true). The pager row contains the controls that allow the user to navigate to the different pages in the control. Instead of using the built-in pager row user interface (UI), you can define your own UI by using the PagerTemplate property.

System_CAPS_noteNote

When the PagerTemplate property is set, it overrides the built-in pager row UI.

To specify a custom template for the pager row, first place <PagerTemplate> tags between the opening and closing tags of the GridView control. You can then list the contents of the template between the opening and closing <PagerTemplate> tags. To control the appearance of the pager row, use the PagerStyle property.

Typically, button controls are added to the pager template to perform the paging operations. The GridView control performs a paging operation when a button control with its CommandName property set to "Page" is clicked. The button's CommandArgument property determines the type of paging operation to perform. The following table lists the command argument values supported by the GridView control.

CommandArgument value

Description

"Next"

Navigates to the next page.

"Prev"

Navigates to the previous page.

"First"

Navigates to the first page.

"Last"

Navigates to the last page.

Integer value

Navigates to the specified page number.

The following example demonstrates how to create a custom pager template that allows the user to navigate through a GridView control using a DropDownList control.

No code example is currently available or this language may not be supported.

.NET Framework
Available since 2.0
Return to top
Show: