ListView_CancelLabelEdit Method

Description

This method will cancel the label editing of an item, so the user may not rename the text content of that item. This is useful when you wish to ensure that some items may be edited while others may not.

Parameters

MyControlReference: Reference to the control in the form of MyProject_MyForm_MyControl.
ProjectFile: String identifying the project as it was passed in LoadProject.
DialogName: String identifying the dialog by name.
ControlName: String identifying the control by name.

Return Values

Returns the following according to the situation:

T when successful.
Nil if the control is not found or does not support this function.

AutoLISP Syntax

The recommended convention is passing the control identifier directly:

Copy Code
(Odcl_ListView_CancelLabelEdit MyControlReference [as Reference])

An alternative convention is to identify the control by providing the project file, the dialog name and the control name:

Copy Code
(Odcl_ListView_CancelLabelEdit ProjectFile [as String] DialogName [as String] ControlName [as String])

Remarks

This method is not available for the BlockList control.

Applies For

ListView.

Example

Copy Code
; Cancel label editing if any is occurring (Odcl_ListView_CancelLabelEdit MyProject_MyForm_MyControl)