FormViewPageEventArgs.xml

<Type Name="FormViewPageEventArgs" FullName="System.Web.UI.WebControls.FormViewPageEventArgs">
  <TypeSignature Language="C#" Value="public class FormViewPageEventArgs : System.ComponentModel.CancelEventArgs" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit FormViewPageEventArgs extends System.ComponentModel.CancelEventArgs" />
  <TypeSignature Language="DocId" Value="T:System.Web.UI.WebControls.FormViewPageEventArgs" />
  <TypeSignature Language="VB.NET" Value="Public Class FormViewPageEventArgs&#xA;Inherits CancelEventArgs" />
  <TypeSignature Language="F#" Value="type FormViewPageEventArgs = class&#xA;    inherit CancelEventArgs" />
  <TypeSignature Language="C++ CLI" Value="public ref class FormViewPageEventArgs : System::ComponentModel::CancelEventArgs" />
  <AssemblyInfo>
    <AssemblyName>System.Web</AssemblyName>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
    <AssemblyVersion>4.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.ComponentModel.CancelEventArgs</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>Provides data for the <see cref="E:System.Web.UI.WebControls.FormView.PageIndexChanging" /> event.</summary>
    <remarks>
      <format type="text/markdown"><![CDATA[

## Remarks
 The <xref:System.Web.UI.WebControls.FormView> control raises the <xref: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 <xref: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.

|CommandArgument value|Description|
|---------------------------|-----------------|
|"Next"|Navigates to the next page.|
|"Prev"|Navigates to the previous page.|
|"First"|Navigates to the first page.|
|"Last"|Navigates to the last page.|
|An integer value|Navigates to the specified page.|

 This allows you to provide an event-handling method that performs a custom routine, such as canceling the paging operation, whenever this event occurs.

> [!NOTE]
>  Pager buttons are usually located in the pager row of a <xref:System.Web.UI.WebControls.FormView> control.

 A <xref: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 <xref:System.Web.UI.WebControls.FormViewPageEventArgs.NewPageIndex%2A> property. To cancel the paging operation, set the <xref:System.ComponentModel.CancelEventArgs.Cancel%2A?displayProperty=nameWithType> property of the <xref:System.Web.UI.WebControls.FormViewPageEventArgs> object to `true`.

 For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/).

 For a list of initial property values for an instance of the <xref:System.Web.UI.WebControls.FormViewPageEventArgs> class, see the <xref:System.Web.UI.WebControls.FormViewPageEventArgs.%23ctor%2A> constructor.



## Examples
 The following example demonstrates how to use the <xref:System.Web.UI.WebControls.FormViewPageEventArgs> object passed to the event-handling method for the <xref:System.Web.UI.WebControls.FormView.PageIndexChanging> event to cancel a paging operation when the user attempts to navigate to another page while the <xref:System.Web.UI.WebControls.FormView> control is in edit mode.

> [!IMPORTANT]
>  The control in this example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://docs.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)).

 :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/FormViewPageEventArgs/CS/formviewmodeeventargscs.aspx" id="Snippet1":::
 :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/FormViewPageEventArgs/VB/formviewmodeeventargsvb.aspx" id="Snippet1":::

 ]]></format>
    </remarks>
    <altmember cref="T:System.Web.UI.WebControls.FormView" />
    <altmember cref="T:System.Web.UI.WebControls.FormViewPageEventHandler" />
    <altmember cref="T:System.ComponentModel.CancelEventArgs" />
    <altmember cref="E:System.Web.UI.WebControls.FormView.PageIndexChanging" />
    <altmember cref="P:System.ComponentModel.CancelEventArgs.Cancel" />
    <altmember cref="P:System.Web.UI.WebControls.FormViewPageEventArgs.NewPageIndex" />
    <altmember cref="M:System.Web.UI.WebControls.FormView.OnPageIndexChanging(System.Web.UI.WebControls.FormViewPageEventArgs)" />
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public FormViewPageEventArgs (int newPageIndex);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(int32 newPageIndex) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.Web.UI.WebControls.FormViewPageEventArgs.#ctor(System.Int32)" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (newPageIndex As Integer)" />
      <MemberSignature Language="F#" Value="new System.Web.UI.WebControls.FormViewPageEventArgs : int -&gt; System.Web.UI.WebControls.FormViewPageEventArgs" Usage="new System.Web.UI.WebControls.FormViewPageEventArgs newPageIndex" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; FormViewPageEventArgs(int newPageIndex);" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Web</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute FrameworkAlternate="netframework-4.0">
          <AttributeName Language="C#">[System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
          <AttributeName Language="F#">[&lt;System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <Parameters>
        <Parameter Name="newPageIndex" Type="System.Int32" />
      </Parameters>
      <Docs>
        <param name="newPageIndex">The index of the new page to display.</param>
        <summary>Initializes a new instance of the <see cref="T:System.Web.UI.WebControls.FormViewPageEventArgs" /> class.</summary>
        <remarks>
          <format type="text/markdown"><![CDATA[

## Remarks
 Use this constructor to initialize a new instance of the <xref:System.Web.UI.WebControls.FormViewPageEventArgs> class.

 The following table shows the initial property value for an instance of <xref:System.Web.UI.WebControls.FormViewPageEventArgs>.

|Property|Initial value|
|--------------|-------------------|
|<xref:System.Web.UI.WebControls.FormViewPageEventArgs.NewPageIndex%2A>|The value of the `newPageIndex` parameter.|

> [!NOTE]
>  This constructor is used primarily by control developers when raising events.

 ]]></format>
        </remarks>
        <altmember cref="T:System.Web.UI.WebControls.FormView" />
        <altmember cref="T:System.Web.UI.WebControls.FormViewPageEventHandler" />
        <altmember cref="E:System.Web.UI.WebControls.FormView.PageIndexChanging" />
        <altmember cref="P:System.Web.UI.WebControls.FormViewPageEventArgs.NewPageIndex" />
        <altmember cref="M:System.Web.UI.WebControls.FormView.OnPageIndexChanging(System.Web.UI.WebControls.FormViewPageEventArgs)" />
      </Docs>
    </Member>
    <Member MemberName="NewPageIndex">
      <MemberSignature Language="C#" Value="public int NewPageIndex { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance int32 NewPageIndex" />
      <MemberSignature Language="DocId" Value="P:System.Web.UI.WebControls.FormViewPageEventArgs.NewPageIndex" />
      <MemberSignature Language="VB.NET" Value="Public Property NewPageIndex As Integer" />
      <MemberSignature Language="F#" Value="member this.NewPageIndex : int with get, set" Usage="System.Web.UI.WebControls.FormViewPageEventArgs.NewPageIndex" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property int NewPageIndex { int get(); void set(int value); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Web</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute FrameworkAlternate="netframework-4.0">
          <AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
          <AttributeName Language="F#">[&lt;get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")&gt;]</AttributeName>
        </Attribute>
        <Attribute FrameworkAlternate="netframework-4.0">
          <AttributeName Language="C#">[set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
          <AttributeName Language="F#">[&lt;set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets or sets the index of the new page to display in the <see cref="T:System.Web.UI.WebControls.FormView" /> control.</summary>
        <value>The index of the new page to display in the <see cref="T:System.Web.UI.WebControls.FormView" /> control.</value>
        <remarks>
          <format type="text/markdown"><![CDATA[

## Remarks
 Because the <xref:System.Web.UI.WebControls.FormView.PageIndexChanging> event occurs before the <xref:System.Web.UI.WebControls.FormView> control performs the paging operation, the <xref:System.Web.UI.WebControls.FormView.PageIndex%2A> 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 <xref:System.Web.UI.WebControls.FormViewPageEventArgs.NewPageIndex%2A> 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.



## Examples
 The following example demonstrates how to use the <xref:System.Web.UI.WebControls.FormViewPageEventArgs.NewPageIndex%2A> property to determine the index of the page selected by the user.

 :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/FormViewPageEventArgs/CS/formviewmodeeventargscs.aspx" id="Snippet1":::
 :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/FormViewPageEventArgs/VB/formviewmodeeventargsvb.aspx" id="Snippet1":::

 ]]></format>
        </remarks>
        <altmember cref="T:System.Web.UI.WebControls.FormView" />
        <altmember cref="T:System.Web.UI.WebControls.FormViewPageEventHandler" />
        <altmember cref="E:System.Web.UI.WebControls.FormView.PageIndexChanging" />
        <altmember cref="P:System.Web.UI.WebControls.FormView.PageIndex" />
      </Docs>
    </Member>
  </Members>
</Type>