Table of Contents

TTMSFNCCustomSearchList Class

API unit family: TMSFNCSearchList Inherits from: TTMSFNCRECustomScrollControl Implements: ITMSFNCPersistence, ITMSStyle

Syntax

TTMSFNCCustomSearchList = class(TTMSFNCRECustomScrollControl, ITMSFNCPersistence, ITMSStyle)

Properties

Name Description
Appearance Gets or sets the visual appearance settings for the search list.
CategoryItemHeight Gets or sets the height of category header items.
FilterCondition Gets or sets the matching mode used by filtering.
FilterUpdateOnSelect (undocumented)
FilteredItemCount Gets the number of items retained by the active filter.
ItemCount Gets the number of currently visible items.
ItemHeight Gets or sets the height of regular items.
ItemIndex Gets or sets the selected item index.
TopRow Gets or sets the first visible row index.
TotalItemCount Gets the total number of items before filtering.
WheelIncrement Gets or sets the number of rows moved by one mouse-wheel action.

Methods

Name Description
BeginUpdate Begins a batched update of the search list.
CategoryName Returns the category caption for a category identifier.
ClearFilter Clears the active filter and shows all items.
CopyToClipboard Copies the selected text to the clipboard.
CutToClipboard Cuts the selected text to the clipboard.
DisplayToItemIndex Converts a displayed item index to its source item index.
EndUpdate Ends a batched update of the search list and refreshes pending changes.
ItemAtXY Returns the item index at the specified coordinates.
LoadSettingsFromFile Loads search-list settings from a file.
LoadSettingsFromStream Loads search-list settings from a stream.
PasteFromClipboard Pastes text from the clipboard.
SaveSettingsToFile Saves search-list settings to a file.
SaveSettingsToStream Saves search-list settings to a stream.
ScrollToItem Scrolls an item into view.
SelectFirstItem Selects the first visible item.
SelectLastItem Selects the last visible item.
SelectNextItem Selects the next item after a specified index.
SelectNextPageItem Selects the item one page after the current selection.
SelectPrevPageItem Selects the item one page before the current selection.
SelectPreviousItem Selects the previous item before a specified index.
SelectedItem Returns the selected search-list item.
UnSelect Clears the current item selection.
UpdateFilter Reapplies the active filter to the item collection.