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

TCustomListView.DoOwnerDataFind

Implements incremental search in list items when OwnerData has been enabled.

Declaration

Source position: comctrls.pp line 1553

protected function TCustomListView.DoOwnerDataFind(

  AFind: TItemFind;

  const AFindString: string;

  const AFindPosition: TPoint;

  AFindData: Pointer;

  AStartIndex: Integer;

  ADirection: TSearchDirection;

  AWrap: Boolean

):Integer; virtual;

Arguments

AFind

  

Type of search, such as partial or exact string match or find nearest item.

AFindString

  

Value used to locate a list item in the owner data.

AFindPosition

  

TPoint instance with the initial position where the search is performed (used for find nearest item searches).

AFindData

  

Pointer to the data structure with the values used in the search.

AStartIndex

  

Ordinal position in the owner data where the search is started.

ADirection

  

Indicates the search direction.

AWrap

  

True if the search can continue to the beginning of the owner data if a match is not found.

Description

DoOwnerDataFind is an Integer function used to implement incremental search features in the list view control when OwnerData (or virtual mode) has been enabled. Incremental search is activated when normal data keys (not control or navigation keys) are pressed while the control is not editing a list item. DoOwnerDataFind is called when a LVN_ODFINDITEM message is received in the key handler for the list view control.

The arguments to the method specify the search parameters and criteria, and are passed to the OnDataFind event handler. The return value contains the ordinal position in the external virtual data where list item with the specified value was located, or -1 when a match is not found. An application must implement a handler routine in OnDataFind to perform the search using the specified values.

No actions are performed in the method, and the return value is -1, when OnDataFind has not been assigned.

Remark: DoOwnerDataFind is implemented for the Windows platform only in the current LCL version.

Version info

Implemented in version 2.2.2 for the Windows platform.

See also

TCustomListView.OnDataFind

  

Event handler signalled to locate list item data when OwnerData (virtual) mode is enabled.


Version 3.2 Generated 2024-02-25 Home