This documentation is archived and is not being maintained.

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.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0
Show: