DataPager.PagedControlID Property
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
public:
virtual property System::String ^ PagedControlID { System::String ^ get(); void set(System::String ^ value); };[System.Web.UI.Themeable(false)]
public virtual string PagedControlID { get; set; }[<System.Web.UI.Themeable(false)>]
member this.PagedControlID : string with get, setPublic Overridable Property PagedControlID As StringProperty Value
The ID of the control that contains the data that will be paged by the DataPager control. The default is an empty string, which indicates that this property is not set.
- Attributes
Examples
The following example shows how to use the PagedControlID property to dynamically associate a ListView control with a DataPager control. This code example is part of a larger example provided for the DataPager constructor.
protected void Page_Load(object sender, EventArgs e)
{
// Create a new DataPager object.
DataPager CountryDataPager = new DataPager();
// Set the DataPager object's properties.
CountryDataPager.PagedControlID = CountryListView.ID;
CountryDataPager.PageSize = 15;
CountryDataPager.Fields.Add(new NumericPagerField());
// Add the DataPager object to the Controls collection
// of the form.
form1.Controls.Add(CountryDataPager);
CountryListView.DataBind();
}
Protected Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs)
' Create a new DataPager object.
Dim CountryDataPager As New DataPager()
' Set the DataPager object's properties.
CountryDataPager.PagedControlID = CountryListView.ID
CountryDataPager.PageSize = 15
CountryDataPager.Fields.Add(New NumericPagerField())
' Add the DataPager object to the Controls collection
' of the form.
form1.Controls.Add(CountryDataPager)
CountryListView.DataBind()
End Sub
The following example shows how to declaratively set the PagedControlID property in a DataPager control in order to page the data of a ListView control.
<%@ Page language="C#" %>
<!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" >
<head id="Head1" runat="server">
<title>DataPager PagedControlID Example</title>
</head>
<body>
<form id="form1" runat="server">
<h3>DataPager PagedControlID Example</h3>
<asp:DataPager ID="DepartmentsPager" runat="server"
PagedControlID="DepartmentsListView">
<Fields>
<asp:NumericPagerField />
</Fields>
</asp:DataPager>
<asp:ListView ID="DepartmentsListView"
DataSourceID="DepartmentsDataSource"
runat="server">
<LayoutTemplate>
<table cellpadding="2" width="500px">
<tr>
<th>Department Name</th>
<th>Group</th>
</tr>
<tr runat="server" id="itemPlaceholder"></tr>
</table>
</LayoutTemplate>
<ItemTemplate>
<tr runat="server">
<td>
<asp:Label ID="NameLabel" runat="server" Text='<%# Eval("Name") %>' />
</td>
<td>
<asp:Label ID="GroupNameLabel" runat="server" Text='<%# Eval("GroupName") %>' />
</td>
</tr>
</ItemTemplate>
</asp:ListView>
<!-- This example uses Microsoft SQL Server and connects -->
<!-- to the AdventureWorks sample database. Use an ASP.NET -->
<!-- expression to retrieve the connection string value -->
<!-- from the Web.config file. -->
<asp:SqlDataSource ID="DepartmentsDataSource" runat="server"
ConnectionString="<%$ ConnectionStrings:AdventureWorks_DataConnectionString %>"
SelectCommand="SELECT Name, GroupName FROM HumanResources.Department" >
</asp:SqlDataSource>
</form>
</body>
</html>
<%@ Page language="VB" %>
<!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" >
<head id="Head1" runat="server">
<title>DataPager PagedControlID Example</title>
</head>
<body>
<form id="form1" runat="server">
<h3>DataPager PagedControlID Example</h3>
<asp:DataPager ID="DepartmentsPager" runat="server"
PagedControlID="DepartmentsListView">
<Fields>
<asp:NumericPagerField />
</Fields>
</asp:DataPager>
<asp:ListView ID="DepartmentsListView"
DataSourceID="DepartmentsDataSource"
runat="server">
<LayoutTemplate>
<table cellpadding="2" width="500px">
<tr>
<th>Department Name</th>
<th>Group</th>
</tr>
<tr runat="server" id="itemPlaceholder"></tr>
</table>
</LayoutTemplate>
<ItemTemplate>
<tr runat="server">
<td>
<asp:Label ID="NameLabel" runat="server" Text='<%# Eval("Name") %>' />
</td>
<td>
<asp:Label ID="GroupNameLabel" runat="server" Text='<%# Eval("GroupName") %>' />
</td>
</tr>
</ItemTemplate>
</asp:ListView>
<!-- This example uses Microsoft SQL Server and connects -->
<!-- to the AdventureWorks sample database. Use an ASP.NET -->
<!-- expression to retrieve the connection string value -->
<!-- from the Web.config file. -->
<asp:SqlDataSource ID="DepartmentsDataSource" runat="server"
ConnectionString="<%$ ConnectionStrings:AdventureWorks_DataConnectionString %>"
SelectCommand="SELECT Name, GroupName FROM HumanResources.Department" >
</asp:SqlDataSource>
</form>
</body>
</html>
Remarks
Use the PagedControlID property to specify the ID of the control that contains the data that will be paged by the DataPager control. The specified control must implement the IPageableItemContainer interface and must use the same naming container as the DataPager control. An example of a control that you can specify is the ListView control.
If this property is an empty string or null, the DataPager control checks whether its container control implements the IPageableItemContainer interface. For example, in the ListView control, the PagedControlID property does not have to be set if you put the DataPager control inside the ListView.LayoutTemplate template. This is because the DataPager control can automatically find the ListView control by examining the control tree.
The value of this property is stored in view state.
