DataPagerCommandEventArgs.Item Property

Reference

Definition

Namespace:: System.Web.UI.WebControls

Assembly:: System.Web.Extensions.dll

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.

Gets the DataPagerFieldItem object that contains the DataPagerField object and the DataPagerField object's container DataPager object.

public:
 property System::Web::UI::WebControls::DataPagerFieldItem ^ Item { System::Web::UI::WebControls::DataPagerFieldItem ^ get(); };

public System.Web.UI.WebControls.DataPagerFieldItem Item { get; }

member this.Item : System.Web.UI.WebControls.DataPagerFieldItem

Public ReadOnly Property Item As DataPagerFieldItem

Property Value

DataPagerFieldItem

The DataPagerFieldItem object that contains the DataPagerField object and the DataPagerField object's container DataPager object.

Examples

The following example shows how to use the Item property to retrieve a TextBox control that is contained in the TemplatePagerField object. 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

The DataPagerField object, which is contained in the DataPagerFieldItem object returned by this property, contains the button that was clicked. Alternatively, you can use the PagerField property to retrieve the DataPagerField object.

Applies to

Jaa