LabelEditEventArgs.CancelEdit Property
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Gets or sets a value indicating whether changes made to the label of the ListViewItem should be canceled.
public:
property bool CancelEdit { bool get(); void set(bool value); };public bool CancelEdit { get; set; }member this.CancelEdit : bool with get, setPublic Property CancelEdit As BooleanProperty Value
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.
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.Item<2)
{
e.CancelEdit = true;
}
}
Private Sub ListView1_BeforeLabelEdit(ByVal sender As Object, _
ByVal e As System.Windows.Forms.LabelEditEventArgs) _
Handles ListView1.BeforeLabelEdit
' Allow all but the first two items of the list to be modified by
' the user.
If (e.Item < 2) Then
e.CancelEdit = True
End If
End Sub
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.
