DataPagerFieldItem.Pager Property

Definition

Gets the pager control that contains the pager field object.

public:
 property System::Web::UI::WebControls::DataPager ^ Pager { System::Web::UI::WebControls::DataPager ^ get(); };
public System.Web.UI.WebControls.DataPager Pager { get; }
member this.Pager : System.Web.UI.WebControls.DataPager
Public ReadOnly Property Pager As DataPager

Property Value

The pager control.

Examples

The following example shows how to access properties of the DataPager control by using the Pager property in a handler for the TemplatePagerField.PagerCommand event. This code example is part of a larger example provided for the DataPagerCommandEventArgs class.

protected void TemplatePagerField_OnPagerCommand(object sender, DataPagerCommandEventArgs e)
{     
    // Get the new page number 
    TextBox PageNumberTextBox = (TextBox)e.Item.FindControl("PageNumberTextBox");
    int newPageNumber = -1;
    try
    {
      newPageNumber = Convert.ToInt32(PageNumberTextBox.Text.Trim());
    }
    catch (FormatException)
    {
      Message.Text = "Invalid page number.";
      return;
    }
    catch (OverflowException)
    {
      Message.Text = "Invalid page number.";
      return;
    }

    int newIndex = (newPageNumber - 1) * e.Item.Pager.PageSize;
    //Verify if the new index is valid
    if (newIndex >= 0 && newIndex <= e.TotalRowCount)
    {
      //Set the new start index and maximum rows
      e.NewStartRowIndex = newIndex;
      e.NewMaximumRows = e.Item.Pager.MaximumRows;
    }
    else
      Message.Text = "Invalid page number.";
}
Protected Sub TemplatePagerField_OnPagerCommand(ByVal sender As Object, _
  ByVal e As DataPagerCommandEventArgs)
  
  ' Get the new page number 
  Dim PageNumberTextBox As TextBox = _
    CType(e.Item.FindControl("PageNumberTextBox"), TextBox)
  
  Dim newPageNumber As Integer = -1
  Try
    newPageNumber = Convert.ToInt32(PageNumberTextBox.Text.Trim())
  Catch fex As FormatException
    Message.Text = "Invalid page number."
    Return
  Catch oex As OverflowException
    Message.Text = "Invalid page number."
    Return
  End Try
      
  Dim newIndex As Integer = _
    (newPageNumber - 1) * e.Item.Pager.PageSize
  
  'Verify if the new index is valid
  If newIndex >= 0 AndAlso newIndex <= e.TotalRowCount Then
    'Set the new start index and maximum rows
    e.NewStartRowIndex = newIndex
    e.NewMaximumRows = e.Item.Pager.MaximumRows
  Else
    Message.Text = "Invalid page number."
  End If
  
End Sub

Remarks

Use the Pager property to retrieve the DataPager control. This property is typically used to access the properties of the control in an event handler for the TemplatePagerField.PagerCommand event.

Applies to

See also