Table of Contents

TTMSFNCCustomListBox Class

Base list box control with item selection, filtering, sorting, clipboard, drag-and-drop, and custom drawing support.

API unit family: TMSFNCListBox Inherits from: TTMSFNCCustomControl Implements: ITMSFNCStylesManager, ITMSFNCBitmapContainer, ITMSFNCControlPickerFull, ITMSFNCAppearanceGlobalFont

Syntax

TTMSFNCCustomListBox = class(TTMSFNCCustomControl, ITMSFNCStylesManager, ITMSFNCBitmapContainer, ITMSFNCControlPickerFull, ITMSFNCAppearanceGlobalFont)

Properties

Name Description
Filter Collection of filter conditions applied to items.
FilteredItems Items currently visible after filtering.
SelectedItem The currently selected item.
SelectedItems Selected item at the specified selected-item index.
SortMode Current item sorting mode.
TreeView Internal tree view used to render and manage list box items.

Methods

Name Description
AddItem Adds a new item to the list box.
ApplyFilter Applies the configured item filters.
BeginUpdate Starts a batched update operation.
ClearSorting Clears the active sorting state.
CopyToClipboard Copies the selected items to the clipboard.
CutToClipboard Cuts the selected items to the clipboard.
DoEnter Handles focus entry for the list box.
EndUpdate Ends a batched update operation and refreshes the list box.
InitSample Initializes the list box with sample content.
IsItemSelectable Indicates whether an item can be selected.
LoadFromFile Loads items from a file.
LoadFromStream Loads items from a stream.
LoadFromStrings Loads item text from a string list.
LoadSettingsFromFile Loads persisted list box settings from a file.
LoadSettingsFromStream Loads persisted list box settings from a stream.
LookupItem Finds an item by lookup text.
PasteFromClipboard Pastes list box items from the clipboard.
RemoveFilter Removes the active item filter.
RemoveFilters Removes all item filters.
RemoveItem Removes an item from the list box.
SaveToFile Saves items to a file.
SaveToStream Saves items to a stream.
SaveToStrings Saves item text to a string list.
ScrollToItem Scrolls the list box to the specified item index.
SelectItem Selects the item at the specified index.
SelectItems Selects multiple items by index.
SelectedItemCount Returns the number of selected items.
Sort Sorts the list box items.
UnSelectAllItems Clears the current item selection.
XYToItem Returns the item at the specified control-local coordinates.
XYToItemIndex Returns the item index at the specified control-local coordinates.