LabelEditEventArgs Class
Provides data for the ListView::BeforeLabelEdit and ListView::AfterLabelEdit events.
Assembly: System.Windows.Forms (in System.Windows.Forms.dll)
| Name | Description | |
|---|---|---|
![]() | LabelEditEventArgs(Int32) | Initializes a new instance of the LabelEditEventArgs class with the specified index to the ListViewItem to edit. |
![]() | 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. |
| Name | Description | |
|---|---|---|
![]() | 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. |
| Name | Description | |
|---|---|---|
![]() | Equals(Object^) | Determines whether the specified object is equal to the current object.(Inherited from Object.) |
![]() | Finalize() | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.) |
![]() | GetHashCode() | Serves as the default hash function. (Inherited from Object.) |
![]() | GetType() | |
![]() | MemberwiseClone() | |
![]() | ToString() | Returns a string that represents the current object.(Inherited from Object.) |
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. |
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.
Available since 1.1
Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.



