Export (0) Print
Expand All

LabelEditEventArgs Class

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

System.Object
  System.EventArgs
    System.Windows.Forms.LabelEditEventArgs

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

public class LabelEditEventArgs : EventArgs

The LabelEditEventArgs type exposes the following members.

  NameDescription
Public methodLabelEditEventArgs(Int32)Initializes a new instance of the LabelEditEventArgs class with the specified index to the ListViewItem to edit.
Public methodLabelEditEventArgs(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.
Top

  NameDescription
Public propertyCancelEditGets or sets a value indicating whether changes made to the label of the ListViewItem should be canceled.
Public propertyItemGets the zero-based index of the ListViewItem containing the label to edit.
Public propertyLabelGets the new text assigned to the label of the ListViewItem.
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

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.

NoteNote

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;
		}
	}
The following code example demonstrates handling the ListView.BeforeLabelEdit event
and using the EditLabelEventArgs.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.

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft