This documentation is archived and is not being maintained.

ListView.BeforeLabelEdit Event

Occurs when the user starts editing the label of an item.

Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in system.windows.forms.dll)

public event LabelEditEventHandler BeforeLabelEdit
/** @event */
public void add_BeforeLabelEdit (LabelEditEventHandler value)

/** @event */
public void remove_BeforeLabelEdit (LabelEditEventHandler value)

JScript supports the use of events, but not the declaration of new ones.

The BeforeLabelEdit event occurs when the user begins modifying the text for an item. If the event handler cancels this event, the user cannot edit the text. You can use this event to prevent the user from editing specific items in the ListView control. If the LabelEdit property of the ListView control is set to false, the BeforeLabelEdit event is not raised; all user attempts to edit item labels are automatically rejected.

For more information about handling events, see Consuming Events.

The following code example demonstrates handling the BeforeLabelEdit event and using the LabelEditEventArgs.Item and LabelEditEventArgs.CancelEdit properties. To run the example, paste the following code into a form containing a ListView control named ListView1 and populated with at least three items. Ensure the event handler in the example is associated with its event.

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

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.get_Item() < 2) {
        e.set_CancelEdit(true);
    }
} //listView1_BeforeLabelEdit

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

.NET Framework

Supported in: 2.0, 1.1, 1.0
Show: