LabelEditEventArgs.CancelEdit Property

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

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

public bool CancelEdit { get; set; }

Property Value

Type: System.Boolean
true if the edit operation of the label for the ListViewItem should be canceled; otherwise false.

You can use this property to cancel changes made to the label of a 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.

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.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft