[Overview][Constants][Types][Classes][Procedures and functions][Index] Reference for unit 'ComCtrls' (#lcl)

TListItem.EditCaption

Selects the list item and displays its editor when possible.

Declaration

Source position: comctrls.pp line 1064

public function TListItem.EditCaption: Boolean;

Function result

True if the control is not ReadOnly and the editor is valid, otherwise False.

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.

Remark: EditCaption is not used in the current LCL implementation (2.2.0).

See also

TCustomListView.Selected

  

Contains the selected list item in the list view control.

TCustomListView.ReadOnly

  

Disables editing of list items on the control when set to True.

TCustomListView.IsEditing

  

Indicates if the editor is active in the list view control.


Version 3.2 Generated 2024-02-25 Home