LabelEditEventArgs Class

 
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.

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

Namespace:   System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

System::Object
  System::EventArgs
    System.Windows.Forms::LabelEditEventArgs

public ref class LabelEditEventArgs : EventArgs

NameDescription
System_CAPS_pubmethodLabelEditEventArgs(Int32)

Initializes a new instance of the LabelEditEventArgs class with the specified index to the ListViewItem to edit.

System_CAPS_pubmethodLabelEditEventArgs(Int32, String^)

Initializes a new instance of the LabelEditEventArgs class with the specified index to the ListViewItem being edited and the new text for the label of the ListViewItem.

NameDescription
System_CAPS_pubpropertyCancelEdit

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

System_CAPS_pubpropertyItem

Gets the zero-based index of the ListViewItem containing the label to edit.

System_CAPS_pubpropertyLabel

Gets the new text assigned to the label of the ListViewItem.

NameDescription
System_CAPS_pubmethodEquals(Object^)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

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.

System_CAPS_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.

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

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: