linux-packaging-mono/mcs/class/Managed.Windows.Forms/Documentation/en/System.Windows.Forms/LabelEditEventArgs.xml

<?xml version="1.0" encoding="utf-8"?>
<Type Name="LabelEditEventArgs" FullName="System.Windows.Forms.LabelEditEventArgs">
  <TypeSignature Language="C#" Value="public class LabelEditEventArgs : EventArgs" />
  <AssemblyInfo>
    <AssemblyName>System.Windows.Forms</AssemblyName>
    <AssemblyVersion>1.0.5000.0</AssemblyVersion>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.EventArgs</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <remarks>
      <attribution license="cc4" from="Microsoft" modified="false" />
      <para>A <see cref="T:System.Windows.Forms.LabelEditEventArgs" /> specifies the index and caption of a <see cref="T:System.Windows.Forms.ListViewItem" /> and the caption after it has been edited by the user. This class also provides a <see cref="P:System.Windows.Forms.LabelEditEventArgs.CancelEdit" /> property. You can use this property in a <see cref="E:System.Windows.Forms.ListView.BeforeLabelEdit" /> event handler to prevent the user from editing the label. You can also use it in an <see cref="E:System.Windows.Forms.ListView.AfterLabelEdit" /> event handler to revert the change, returning the label it to its original value. This is useful when you want to validate user input before committing the change. </para>
      <block subset="none" type="note">
        <para>Because the <see cref="E:System.Windows.Forms.ListView.AfterLabelEdit" /> event takes place before the label edit is committed, calling the <see cref="M:System.Windows.Forms.ListView.Sort" /> method in a handler for this event will sort the item using the original value.</para>
      </block>
    </remarks>
    <summary>
      <attribution license="cc4" from="Microsoft" modified="false" />
      <para>Provides data for the <see cref="E:System.Windows.Forms.ListView.BeforeLabelEdit" /> and <see cref="E:System.Windows.Forms.ListView.AfterLabelEdit" /> events.</para>
    </summary>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public LabelEditEventArgs (int item);" />
      <MemberType>Constructor</MemberType>
      <Parameters>
        <Parameter Name="item" Type="System.Int32" />
      </Parameters>
      <Docs>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>You can use this constructor when raising the <see cref="E:System.Windows.Forms.ListView.BeforeLabelEdit" /> or <see cref="E:System.Windows.Forms.ListView.AfterLabelEdit" /> event at run time to specify a specific list item in the <see cref="T:System.Windows.Forms.ListView" /> to edit.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Initializes a new instance of the <see cref="T:System.Windows.Forms.LabelEditEventArgs" /> class with the specified index to the <see cref="T:System.Windows.Forms.ListViewItem" /> to edit.</para>
        </summary>
        <param name="item">
          <attribution license="cc4" from="Microsoft" modified="false" />The zero-based index of the <see cref="T:System.Windows.Forms.ListViewItem" />, containing the label to edit. </param>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public LabelEditEventArgs (int item, string label);" />
      <MemberType>Constructor</MemberType>
      <Parameters>
        <Parameter Name="item" Type="System.Int32" />
        <Parameter Name="label" Type="System.String" />
      </Parameters>
      <Docs>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>You can use this constructor when raising the <see cref="E:System.Windows.Forms.ListView.BeforeLabelEdit" /> or <see cref="E:System.Windows.Forms.ListView.AfterLabelEdit" /> event at run time to specify a list item in the <see cref="T:System.Windows.Forms.ListView" /> to edit. The constructor also enables you to specify the new text associated with the label of the <see cref="T:System.Windows.Forms.ListViewItem" />.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Initializes a new instance of the <see cref="T:System.Windows.Forms.LabelEditEventArgs" /> class with the specified index to the <see cref="T:System.Windows.Forms.ListViewItem" /> being edited and the new text for the label of the <see cref="T:System.Windows.Forms.ListViewItem" />.</para>
        </summary>
        <param name="item">
          <attribution license="cc4" from="Microsoft" modified="false" />The zero-based index of the <see cref="T:System.Windows.Forms.ListViewItem" />, containing the label to edit. </param>
        <param name="label">
          <attribution license="cc4" from="Microsoft" modified="false" />The new text assigned to the label of the <see cref="T:System.Windows.Forms.ListViewItem" />. </param>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="CancelEdit">
      <MemberSignature Language="C#" Value="public bool CancelEdit { set; get; }" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <value>To be added.</value>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>You can use this property to cancel changes made to the label of a <see cref="T:System.Windows.Forms.ListViewItem" /> and revert it to its original text. Use this property to prevent an item's caption from being changed to a value that does not meet your application's requirements.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets or sets a value indicating whether changes made to the label of the <see cref="T:System.Windows.Forms.ListViewItem" /> should be canceled.</para>
        </summary>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="Item">
      <MemberSignature Language="C#" Value="public int Item { get; }" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Docs>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets the zero-based index of the <see cref="T:System.Windows.Forms.ListViewItem" /> containing the label to edit.</para>
        </summary>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="Label">
      <MemberSignature Language="C#" Value="public string Label { get; }" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets the new text assigned to the label of the <see cref="T:System.Windows.Forms.ListViewItem" />.</para>
        </summary>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
  </Members>
</Type>