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

<?xml version="1.0" encoding="utf-8"?>
<Type Name="FormViewModeEventArgs" FullName="System.Web.UI.WebControls.FormViewModeEventArgs">
  <TypeSignature Language="C#" Value="public class FormViewModeEventArgs : 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="E:System.Web.UI.WebControls.FormView.ModeChanging" /> event is raised when a <see cref="T:System.Web.UI.WebControls.FormView" /> control attempts to switch between edit, insert, and read-only mode, but before the mode actually changes. This allows you to provide an event-handling method that performs a custom routine, such as configuring the <see cref="T:System.Web.UI.WebControls.FormView" /> control for a specific mode or canceling the mode change, whenever this event occurs.</para>
      <para>A <see cref="T:System.Web.UI.WebControls.FormViewInsertEventArgs" /> object is passed to the event-handling method, which allows you to determine the mode to which the <see cref="T:System.Web.UI.WebControls.FormView" /> control is changing, to determine whether the <see cref="E:System.Web.UI.WebControls.FormView.ModeChanging" /> event was raised as a result of the user canceling an edit or insert operation, or to indicate that the mode change should be canceled. To determine the new mode, use the <see cref="P:System.Web.UI.WebControls.FormViewModeEventArgs.NewMode" /> property. You can also use the <see cref="P:System.Web.UI.WebControls.FormViewModeEventArgs.NewMode" /> property to programmatically specify an alternate mode to which to change by setting it to one of the <see cref="T:System.Web.UI.WebControls.FormViewMode" /> enumeration values. Use the <see cref="P:System.Web.UI.WebControls.FormViewModeEventArgs.CancelingEdit" /> property to determine whether this event was raised as the result of the user canceling an edit or insert operation. To cancel the mode change, set the <see cref="P:System.ComponentModel.CancelEventArgs.Cancel" /> property 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.FormViewModeEventArgs" /> class, see the <see cref="M:System.Web.UI.WebControls.FormViewModeEventArgs.#ctor(System.Web.UI.WebControls.FormViewMode,System.Boolean)" /> constructor.</para>
    </remarks>
    <summary>
      <attribution license="cc4" from="Microsoft" modified="false" />
      <para>Provides data for the <see cref="E:System.Web.UI.WebControls.FormView.ModeChanging" /> event.</para>
    </summary>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public FormViewModeEventArgs (System.Web.UI.WebControls.FormViewMode mode, bool cancelingEdit);" />
      <MemberType>Constructor</MemberType>
      <Parameters>
        <Parameter Name="mode" Type="System.Web.UI.WebControls.FormViewMode" />
        <Parameter Name="cancelingEdit" Type="System.Boolean" />
      </Parameters>
      <Docs>
        <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.FormViewModeEventArgs" /> class.</para>
          <para>The following table shows initial property values for an instance of the <see cref="T:System.Web.UI.WebControls.FormViewModeEventArgs" /> class.</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.FormViewModeEventArgs.CancelingEdit" />
                </para>
              </term>
              <description>
                <para>The value of the <paramref name="cancelingEdit" /> parameter.</para>
              </description>
            </item>
            <item>
              <term>
                <para>
                  <see cref="P:System.Web.UI.WebControls.FormViewModeEventArgs.NewMode" />
                </para>
              </term>
              <description>
                <para>The value of the <paramref name="mode" /> 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.FormViewModeEventArgs" /> class.</para>
        </summary>
        <param name="mode">
          <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Web.UI.WebControls.FormViewMode" /> enumeration values.</param>
        <param name="cancelingEdit">
          <attribution license="cc4" from="Microsoft" modified="false" />true to indicate the <see cref="E:System.Web.UI.WebControls.FormView.ModeChanging" /> event was raised as a result of the user canceling an edit operation; otherwise, false.</param>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="CancelingEdit">
      <MemberSignature Language="C#" Value="public bool CancelingEdit { get; }" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <value>To be added.</value>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The <see cref="E:System.Web.UI.WebControls.FormView.ModeChanging" /> event is raised when a <see cref="T:System.Web.UI.WebControls.FormView" /> control attempts to switch between edit, insert, and read-only mode, but before the mode actually changes. Use the <see cref="P:System.Web.UI.WebControls.FormViewModeEventArgs.CancelingEdit" /> property to determine whether the <see cref="E:System.Web.UI.WebControls.FormView.ModeChanging" /> event was raised as a result of the user canceling an edit or insert operation. For example, you might want to reset the <see cref="T:System.Web.UI.WebControls.FormView" /> control whenever the user cancels an edit operation.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets a value indicating whether the <see cref="E:System.Web.UI.WebControls.FormView.ModeChanging" /> event was raised as a result of the user canceling an edit operation.</para>
        </summary>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="NewMode">
      <MemberSignature Language="C#" Value="public System.Web.UI.WebControls.FormViewMode NewMode { set; get; }" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Web.UI.WebControls.FormViewMode</ReturnType>
      </ReturnValue>
      <Docs>
        <value>To be added.</value>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Use the <see cref="P:System.Web.UI.WebControls.FormViewModeEventArgs.NewMode" /> property to determine the mode to which the <see cref="T:System.Web.UI.WebControls.FormView" /> control is changing. For example, you might want to configure the <see cref="T:System.Web.UI.WebControls.FormView" /> control based on the mode to which it changes. You can also use this property to specify the mode to which the <see cref="T:System.Web.UI.WebControls.FormView" /> control changes by setting it to one of the <see cref="T:System.Web.UI.WebControls.FormViewMode" /> enumeration values.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets or sets the mode to which the <see cref="T:System.Web.UI.WebControls.FormView" /> control is changing.</para>
        </summary>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
  </Members>
</Type>