Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

LabelEditEventArgs Class

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

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

public class LabelEditEventArgs : EventArgs
public class LabelEditEventArgs extends EventArgs
public class LabelEditEventArgs extends EventArgs

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

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

System.Object
   System.EventArgs
    System.Windows.Forms.LabelEditEventArgs
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

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
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.