TListItem.EditCaption function

Declaration

function EditCaption: Boolean

Function result

Description

EditCaption is a Boolean function used to select the list item on its list view control, and display its Editor control. The return value is True if the list item is the Selected item for the control and the editor was successfully displayed.

EditCaption clears any existing selections in the list view control in Owner, and assigns the class instance to the Selected property. No additional action are performed in the method when the list view control is ReadOnly, or an Editor has not been assigned for the control. The return value is set to False.

EditCaption calls the private ShowEditor method in the list view control to display and set focus to the editor. The editor control may not become visible if the OnEditing event handler in the list view control indicates the list item cannot be edited.

See also

• Selected
• ReadOnly
• IsEditing