LabelEditEventArgs Class

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Source:

LabelEditEventArgs.cs

Provides data for the BeforeLabelEdit and AfterLabelEdit events.

public ref class LabelEditEventArgs : EventArgs

public class LabelEditEventArgs : EventArgs

type LabelEditEventArgs = class
    inherit EventArgs

Public Class LabelEditEventArgs
Inherits EventArgs

Inheritance

Object

EventArgs

LabelEditEventArgs

Examples

The following code example demonstrates handling the ListView.BeforeLabelEdit event and using the Item and CancelEdit properties. To run the example, paste the following code in a form containing a ListView control named ListView1 and populated with at least 3 items. Ensure all events are associated with their event-handling methods.

void ListView1_BeforeLabelEdit( Object^ sender,
   System::Windows::Forms::LabelEditEventArgs^ e )
{
   // Allow all but the first two items of the list to 
   // be modified by the user.
   if ( e->Item < 2 )
   {
      e->CancelEdit = true;
   }
}

private void ListView1_BeforeLabelEdit(object sender, 
    System.Windows.Forms.LabelEditEventArgs e)
{
    // Allow all but the first two items of the list to 
    // be modified by the user.
    if (e.Item<2)
    {
        e.CancelEdit = true;
    }
}

Private Sub ListView1_BeforeLabelEdit(ByVal sender As Object, _
    ByVal e As System.Windows.Forms.LabelEditEventArgs) _
    Handles ListView1.BeforeLabelEdit

    ' Allow all but the first two items of the list to be modified by
    ' the user.
    If (e.Item < 2) Then
        e.CancelEdit = True
    End If
End Sub

Remarks

A LabelEditEventArgs specifies the index and caption of a ListViewItem and the caption after it has been edited by the user. This class also provides a CancelEdit property. You can use this property in a ListView.BeforeLabelEdit event handler to prevent the user from editing the label. You can also use it in an 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.

Note

Because the ListView.AfterLabelEdit event takes place before the label edit is committed, calling the ListView.Sort method in a handler for this event will sort the item using the original value.

Constructors

LabelEditEventArgs(Int32, String)	Initializes a new instance of the LabelEditEventArgs class with the specified index to the ListViewItem being edited and the new text for the label of the ListViewItem.
LabelEditEventArgs(Int32)	Initializes a new instance of the LabelEditEventArgs class with the specified index to the ListViewItem to edit.

Properties

CancelEdit	Gets or sets a value indicating whether changes made to the label of the ListViewItem should be canceled.
Item	Gets the zero-based index of the ListViewItem containing the label to edit.
Label	Gets the new text assigned to the label of the ListViewItem.

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)

See also

• ListView
• ListViewItem
• BeforeLabelEdit
• AfterLabelEdit