LabelEditEventArgs.CancelEdit Property

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Source:

LabelEditEventArgs.cs

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

C#

public bool CancelEdit { get; set; }

Property Value

Boolean

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

Examples

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.

C#

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;
    }
}

Remarks

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.

Applies to