LabelEditEventArgs Class
Collapse the table of content
Expand the table of content

LabelEditEventArgs Class


Provides data for the ListView.BeforeLabelEdit and ListView.AfterLabelEdit events.

Namespace:   System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)


public class LabelEditEventArgs : EventArgs


Initializes a new instance of the LabelEditEventArgs class with the specified index to the ListViewItem to edit.

System_CAPS_pubmethodLabelEditEventArgs(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.


Gets or sets a value indicating whether changes made to the label of the ListViewItem should be canceled.


Gets the zero-based index of the ListViewItem containing the label to edit.


Gets the new text assigned to the label of the ListViewItem.


Determines whether the specified object is equal to the current object.(Inherited from Object.)


Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)


Serves as the default hash function. (Inherited from Object.)


Gets the Type of the current instance.(Inherited from Object.)


Creates a shallow copy of the current Object.(Inherited from Object.)


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.


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.

  	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;

.NET Framework
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.

Return to top
© 2015 Microsoft