TTMSFNCSearchList Class
Displays a searchable, filterable list with category, column, image, selection, clipboard, and custom drawing support.
API unit family: TMSFNCSearchList
Inherits from: TTMSFNCCustomSearchList
Syntax
TTMSFNCSearchList = class(TTMSFNCCustomSearchList)
Properties
| Name |
Description |
| Appearance |
Gets or sets the visual appearance settings for the search list. (inherited from TTMSFNCCustomSearchList) |
| Categories |
Gets or sets the category definitions used to group search-list items. (inherited from TTMSFNCCustomSearchList) |
| CategoryItemHeight |
Gets or sets the height of category header items. (inherited from TTMSFNCCustomSearchList) |
| Columns |
Gets or sets the column definitions used to display item data. (inherited from TTMSFNCCustomSearchList) |
| FilterCondition |
Gets or sets the matching mode used by filtering. (inherited from TTMSFNCCustomSearchList) |
| FilterUpdateOnSelect |
(undocumented) (inherited from TTMSFNCCustomSearchList) |
| FilteredItemCount |
Gets the number of items retained by the active filter. (inherited from TTMSFNCCustomSearchList) |
| Images |
Gets or sets the image list used by item image indexes. (inherited from TTMSFNCCustomSearchList) |
| ItemCount |
Gets the number of currently visible items. (inherited from TTMSFNCCustomSearchList) |
| ItemHeight |
Gets or sets the height of regular items. (inherited from TTMSFNCCustomSearchList) |
| ItemIndex |
Gets or sets the selected item index. (inherited from TTMSFNCCustomSearchList) |
| Items |
Gets or sets the item collection displayed by the search list. (inherited from TTMSFNCCustomSearchList) |
| TabStop |
Controls whether the search list can receive focus through tab navigation. True allows tab focus; False skips the control in the tab order. |
| TopRow |
Gets or sets the first visible row index. (inherited from TTMSFNCCustomSearchList) |
| TotalItemCount |
Gets the total number of items before filtering. (inherited from TTMSFNCCustomSearchList) |
| UIStyle |
Gets or sets the visual style used by the control in non-library builds. (inherited from TTMSFNCCustomSearchList) |
| Version |
Gets the component version string. (inherited from TTMSFNCCustomSearchList) |
| WheelIncrement |
Gets or sets the number of rows moved by one mouse-wheel action. (inherited from TTMSFNCCustomSearchList) |
Methods
| Name |
Description |
| BeginUpdate |
Begins a batched update of the search list. (inherited from TTMSFNCCustomSearchList) |
| CategoryName |
Returns the category caption for a category identifier. (inherited from TTMSFNCCustomSearchList) |
| ClearFilter |
Clears the active filter and shows all items. (inherited from TTMSFNCCustomSearchList) |
| CopyToClipboard |
Copies the selected text to the clipboard. (inherited from TTMSFNCCustomSearchList) |
| CutToClipboard |
Cuts the selected text to the clipboard. (inherited from TTMSFNCCustomSearchList) |
| DisplayToItemIndex |
Converts a displayed item index to its source item index. (inherited from TTMSFNCCustomSearchList) |
| EndUpdate |
Ends a batched update of the search list and refreshes pending changes. (inherited from TTMSFNCCustomSearchList) |
| ItemAtXY |
Returns the item index at the specified coordinates. (inherited from TTMSFNCCustomSearchList) |
| LoadSettingsFromFile |
Loads search-list settings from a file. (inherited from TTMSFNCCustomSearchList) |
| LoadSettingsFromStream |
Loads search-list settings from a stream. (inherited from TTMSFNCCustomSearchList) |
| PasteFromClipboard |
Pastes text from the clipboard. (inherited from TTMSFNCCustomSearchList) |
| SaveSettingsToFile |
Saves search-list settings to a file. (inherited from TTMSFNCCustomSearchList) |
| SaveSettingsToStream |
Saves search-list settings to a stream. (inherited from TTMSFNCCustomSearchList) |
| ScrollToItem |
Scrolls an item into view. (inherited from TTMSFNCCustomSearchList) |
| SelectFirstItem |
Selects the first visible item. (inherited from TTMSFNCCustomSearchList) |
| SelectLastItem |
Selects the last visible item. (inherited from TTMSFNCCustomSearchList) |
| SelectNextItem |
Selects the next item after a specified index. (inherited from TTMSFNCCustomSearchList) |
| SelectNextPageItem |
Selects the item one page after the current selection. (inherited from TTMSFNCCustomSearchList) |
| SelectPrevPageItem |
Selects the item one page before the current selection. (inherited from TTMSFNCCustomSearchList) |
| SelectPreviousItem |
Selects the previous item before a specified index. (inherited from TTMSFNCCustomSearchList) |
| SelectedItem |
Returns the selected search-list item. (inherited from TTMSFNCCustomSearchList) |
| UnSelect |
Clears the current item selection. (inherited from TTMSFNCCustomSearchList) |
| UpdateFilter |
Reapplies the active filter to the item collection. (inherited from TTMSFNCCustomSearchList) |
Events
| Name |
Description |
| OnDrawSearchItemColumn |
Occurs when a search-list item column is drawn. (inherited from TTMSFNCCustomSearchList) |
| OnFilterItem |
Occurs when an item is evaluated by the active filter. (inherited from TTMSFNCCustomSearchList) |
| OnGetSearchItemColumn |
Occurs when column data is requested for a search-list item. (inherited from TTMSFNCCustomSearchList) |
| OnItemChange |
Occurs when the selected item changes. (inherited from TTMSFNCCustomSearchList) |
| OnItemClick |
Occurs when an item is clicked. (inherited from TTMSFNCCustomSearchList) |
Used by