TcxCustomListView.FindCaption(Integer,string,Boolean,Boolean,Boolean) Method

Returns the item by the specified caption.

Declaration

function FindCaption(StartIndex: Integer; Value: string; Partial: Boolean; Inclusive: Boolean; Wrap: Boolean): TListItem;

Parameters

Name	Type
StartIndex	Integer
Value	string
Partial	Boolean
Inclusive	Boolean
Wrap	Boolean

Returns

Type
TListItem

Remarks

The FindCaption method searched the Items of the list view control for an element with the specified caption. The parameters passed the FindCaption method specify the search options:

Parameter	Meaning
StartIndex	The index of the item, from which to begin search.
Value	The string to search for (the search criteria)
Partial	If True, the Caption matches if it starts with the substring Value. If False, the Caption must match Value exactly.
Inclusive	If True, the item, specified by the StartIndex parameter, is included into the search.
Wrap	If True, the search continues at the top of the list if a match has not been found before reaching the bottom.

The FindCaption method returns the first located item. If no item is found, the FindCaption returns nil.