DataPagerCommandEventArgs.NewMaximumRows Property

Definition

Gets or sets the maximum number of records to display on each page of data.

public:
 property int NewMaximumRows { int get(); void set(int value); };
public int NewMaximumRows { get; set; }
member this.NewMaximumRows : int with get, set
Public Property NewMaximumRows As Integer

Property Value

The maximum number of records to display on each page of data. The default is -1, which indicates that this property is not set.

Examples

The following example shows how to use the NewMaximumRows property to set the maximum number of records to display on each page of data. 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

When you set a value for the NewStartRowIndex property, you must also set the NewMaximumRows property. If you do not want to change the current value, you can set the NewMaximumRows property to the value of the MaximumRows property of the DataPager control. You can access the DataPager control through the Item property.

Applies to

See also