linux-packaging-mono/mcs/class/System.Web/Documentation/en/System.Web.UI.WebControls/FormViewPageEventArgs.xml

<?xml version="1.0" encoding="utf-8"?>
<Type Name="FormViewPageEventArgs" FullName="System.Web.UI.WebControls.FormViewPageEventArgs">
  <TypeSignature Language="C#" Value="public class FormViewPageEventArgs : System.ComponentModel.CancelEventArgs" />
  <AssemblyInfo>
    <AssemblyName>System.Web</AssemblyName>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.ComponentModel.CancelEventArgs</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <since version=".NET 2.0" />
    <remarks>
      <attribution license="cc4" from="Microsoft" modified="false" />
      <para>The <see cref="T:System.Web.UI.WebControls.FormView" /> control raises the <see cref="E:System.Web.UI.WebControls.FormView.PageIndexChanging" /> event when a pager button (a button with its CommandName property set to "Page") within the control is clicked, but before the <see cref="T:System.Web.UI.WebControls.FormView" /> control handles the paging operation. You can also set the CommandArgument property of a pager button to specify the type of paging operation to perform. The following table lists the supported operations.</para>
      <list type="table">
        <listheader>
          <item>
            <term>
              <para>CommandArgument value</para>
            </term>
            <description>
              <para>Description</para>
            </description>
          </item>
        </listheader>
        <item>
          <term>
            <para>"Next"</para>
          </term>
          <description>
            <para>Navigates to the next page.</para>
          </description>
        </item>
        <item>
          <term>
            <para>"Prev"</para>
          </term>
          <description>
            <para>Navigates to the previous page.</para>
          </description>
        </item>
        <item>
          <term>
            <para>"First"</para>
          </term>
          <description>
            <para>Navigates to the first page.</para>
          </description>
        </item>
        <item>
          <term>
            <para>"Last"</para>
          </term>
          <description>
            <para>Navigates to the last page.</para>
          </description>
        </item>
        <item>
          <term>
            <para>An integer value</para>
          </term>
          <description>
            <para>Navigates to the specified page.</para>
          </description>
        </item>
      </list>
      <para>This allows you to provide an event-handling method that performs a custom routine, such as canceling the paging operation, whenever this event occurs.</para>
      <block subset="none" type="note">
        <para>Pager buttons are usually located in the pager row of a <see cref="T:System.Web.UI.WebControls.FormView" /> control.</para>
      </block>
      <para>A <see cref="T:System.Web.UI.WebControls.FormViewPageEventArgs" /> object is passed to the event-handling method, which allows you to determine the index of the page selected by the user and to indicate whether the paging operation should be canceled. To determine the index of the page selected by the user, use the <see cref="P:System.Web.UI.WebControls.FormViewPageEventArgs.NewPageIndex" /> property. To cancel the paging operation, set the <see cref="P:System.ComponentModel.CancelEventArgs.Cancel" /> property of the <see cref="T:System.Web.UI.WebControls.FormViewPageEventArgs" /> object to true.</para>
      <para>For more information about handling events, see <format type="text/html"><a href="01e4f1bc-e55e-413f-98c7-6588493e5f67">Consuming Events</a></format>.</para>
      <para>For a list of initial property values for an instance of the <see cref="T:System.Web.UI.WebControls.FormViewPageEventArgs" /> class, see the <see cref="M:System.Web.UI.WebControls.FormViewPageEventArgs.#ctor(System.Int32)" /> constructor.</para>
    </remarks>
    <summary>
      <attribution license="cc4" from="Microsoft" modified="false" />
      <para>Provides data for the <see cref="E:System.Web.UI.WebControls.FormView.PageIndexChanging" /> event.</para>
    </summary>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public FormViewPageEventArgs (int pageIndex);" />
      <MemberType>Constructor</MemberType>
      <Parameters>
        <Parameter Name="pageIndex" Type="System.Int32" />
      </Parameters>
      <Docs>
        <param name="pageIndex">To be added.</param>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Use this constructor to initialize a new instance of the <see cref="T:System.Web.UI.WebControls.FormViewPageEventArgs" /> class.</para>
          <para>The following table shows the initial property value for an instance of <see cref="T:System.Web.UI.WebControls.FormViewPageEventArgs" />.</para>
          <list type="table">
            <listheader>
              <item>
                <term>
                  <para>Property </para>
                </term>
                <description>
                  <para>Initial value </para>
                </description>
              </item>
            </listheader>
            <item>
              <term>
                <para>
                  <see cref="P:System.Web.UI.WebControls.FormViewPageEventArgs.NewPageIndex" />
                </para>
              </term>
              <description>
                <para>The value of the <paramref name="newPageIndex" /> parameter. </para>
              </description>
            </item>
          </list>
          <block subset="none" type="note">
            <para>This constructor is used primarily by control developers when raising events.</para>
          </block>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Initializes a new instance of the <see cref="T:System.Web.UI.WebControls.FormViewPageEventArgs" /> class.</para>
        </summary>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="NewPageIndex">
      <MemberSignature Language="C#" Value="public int NewPageIndex { set; get; }" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Docs>
        <value>To be added.</value>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Because the <see cref="E:System.Web.UI.WebControls.FormView.PageIndexChanging" /> event occurs before the <see cref="T:System.Web.UI.WebControls.FormView" /> control performs the paging operation, the <see cref="P:System.Web.UI.WebControls.FormView.PageIndex" /> property of the control contains the index of the previously displayed page and cannot be used to determine the index of the page selected by the user. Use the <see cref="P:System.Web.UI.WebControls.FormViewPageEventArgs.NewPageIndex" /> property to determine the page index. You can also use this property to programmatically override the page index selected by the user by setting it to another value.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets or sets the index of the new page to display in the <see cref="T:System.Web.UI.WebControls.FormView" /> control.</para>
        </summary>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
  </Members>
</Type>