TCustomListView.GetNextSelected function

Declaration

function GetNextSelected(LVIndex: Integer; var AItem: TListItem)
: Boolean

Arguments

Function result

Returns True if another item is selected in multi-select or owner data (virtual) modes.

Description

GetNextSelected is a Boolean function used to indicate whether a list item following the specified position in the list view can become the selected item in the method. It indicates that the Selected property can be updated with the detected list item based on the settings for the list view control.

The return value is False if neither OwnerData nor MultiSelect are enabled for the list view control.

The return value is True if the variable parameter in AItem was successfully updated with a TListItem instance in the method. This can be one of the Items in the current multi-selection list, the next owner data list item for the control, or Nil when the multi-selection list is empty or OwnerData is not enabled.

GetNextSelected visits each of the Items for the control following the position specified in LVIndex. It checks whether the Selected property for the list item is enabled, and when found, updates AItem with the TListItem instance found in the method. If a subsequent list item is not found that is selected, AItem is set to Nil.

GetNextSelected is used in the widgetset implementation of the GetNextItem method.

Added in LCL version 4.4.

See also

• GetNextItem
• Items
• MultiSelect
• OwnerData
• Selected
• SelCount
• Selected
• TListItems