ListView::BeforeLabelEdit Event

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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 {
	void add(LabelEditEventHandler^ value);
	void remove(LabelEditEventHandler^ value);
}

The BeforeLabelEdit event occurs when the user starts 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 Handling and Raising 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 that contains a ListView control named ListView1 and populated with at least three items. Ensure the event handler in the example is associated with its event.

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

.NET Framework
Available since 1.1
Return to top
Show: