TTMSFNCListBox Class
List box control with item selection, filtering, sorting, clipboard, drag-and-drop, and custom drawing support.
API unit family: TMSFNCListBox
Inherits from: TTMSFNCCustomListBox
Syntax
TTMSFNCListBox = class(TTMSFNCCustomListBox)
Properties
| Name | Description |
|---|---|
| BitmapContainer | Bitmap container used to resolve item images. (inherited from TTMSFNCCustomListBox) |
| DefaultItem | Default item settings used when new items are created. (inherited from TTMSFNCCustomListBox) |
| Fill | Fill used for the list box background. (inherited from TTMSFNCCustomListBox) |
| Filter | Collection of filter conditions applied to items. (inherited from TTMSFNCCustomListBox) |
| FilteredItems | Items currently visible after filtering. (inherited from TTMSFNCCustomListBox) |
| GlobalFont | Global font settings applied to list box text. (inherited from TTMSFNCCustomListBox) |
| Header | Header settings for the list box. (inherited from TTMSFNCCustomListBox) |
| Interaction | Interaction settings for selection, lookup, editing, and drag operations. (inherited from TTMSFNCCustomListBox) |
| ItemIndex | Zero-based index of the selected item, or -1 when no item is selected. (inherited from TTMSFNCCustomListBox) |
| Items | Collection of items displayed by the list box. (inherited from TTMSFNCCustomListBox) |
| ItemsAppearance | Appearance settings shared by list box items. (inherited from TTMSFNCCustomListBox) |
| SelectedItem | The currently selected item. (inherited from TTMSFNCCustomListBox) |
| SelectedItems | Selected item at the specified selected-item index. (inherited from TTMSFNCCustomListBox) |
| SortMode | Current item sorting mode. (inherited from TTMSFNCCustomListBox) |
| Stroke | Stroke used for the list box border. (inherited from TTMSFNCCustomListBox) |
| TreeView | Internal tree view used to render and manage list box items. (inherited from TTMSFNCCustomListBox) |
| Version | Version string for the list box control. (inherited from TTMSFNCCustomListBox) |
| VerticalScrollBarVisible | When True, the vertical scrollbar is visible when needed; when False, the vertical scrollbar is hidden. (inherited from TTMSFNCCustomListBox) |
Methods
| Name | Description |
|---|---|
| AddItem | Adds a new item to the list box. (inherited from TTMSFNCCustomListBox) |
| ApplyFilter | Applies the configured item filters. (inherited from TTMSFNCCustomListBox) |
| BeginUpdate | Starts a batched update operation. (inherited from TTMSFNCCustomListBox) |
| ClearSorting | Clears the active sorting state. (inherited from TTMSFNCCustomListBox) |
| CopyToClipboard | Copies the selected items to the clipboard. (inherited from TTMSFNCCustomListBox) |
| CutToClipboard | Cuts the selected items to the clipboard. (inherited from TTMSFNCCustomListBox) |
| DoEnter | Handles focus entry for the list box. (inherited from TTMSFNCCustomListBox) |
| EndUpdate | Ends a batched update operation and refreshes the list box. (inherited from TTMSFNCCustomListBox) |
| InitSample | Initializes the list box with sample content. (inherited from TTMSFNCCustomListBox) |
| IsItemSelectable | Indicates whether an item can be selected. (inherited from TTMSFNCCustomListBox) |
| LoadFromFile | Loads items from a file. (inherited from TTMSFNCCustomListBox) |
| LoadFromStream | Loads items from a stream. (inherited from TTMSFNCCustomListBox) |
| LoadFromStrings | Loads item text from a string list. (inherited from TTMSFNCCustomListBox) |
| LoadSettingsFromFile | Loads persisted list box settings from a file. (inherited from TTMSFNCCustomListBox) |
| LoadSettingsFromStream | Loads persisted list box settings from a stream. (inherited from TTMSFNCCustomListBox) |
| LookupItem | Finds an item by lookup text. (inherited from TTMSFNCCustomListBox) |
| PasteFromClipboard | Pastes list box items from the clipboard. (inherited from TTMSFNCCustomListBox) |
| RemoveFilter | Removes the active item filter. (inherited from TTMSFNCCustomListBox) |
| RemoveFilters | Removes all item filters. (inherited from TTMSFNCCustomListBox) |
| RemoveItem | Removes an item from the list box. (inherited from TTMSFNCCustomListBox) |
| SaveToFile | Saves items to a file. (inherited from TTMSFNCCustomListBox) |
| SaveToStream | Saves items to a stream. (inherited from TTMSFNCCustomListBox) |
| SaveToStrings | Saves item text to a string list. (inherited from TTMSFNCCustomListBox) |
| ScrollToItem | Scrolls the list box to the specified item index. (inherited from TTMSFNCCustomListBox) |
| SelectItem | Selects the item at the specified index. (inherited from TTMSFNCCustomListBox) |
| SelectItems | Selects multiple items by index. (inherited from TTMSFNCCustomListBox) |
| SelectedItemCount | Returns the number of selected items. (inherited from TTMSFNCCustomListBox) |
| Sort | Sorts the list box items. (inherited from TTMSFNCCustomListBox) |
| UnSelectAllItems | Clears the current item selection. (inherited from TTMSFNCCustomListBox) |
| XYToItem | Returns the item at the specified control-local coordinates. (inherited from TTMSFNCCustomListBox) |
| XYToItemIndex | Returns the item index at the specified control-local coordinates. (inherited from TTMSFNCCustomListBox) |
Events
| Name | Description |
|---|---|
| OnAfterCopyToClipboard | Occurs after selected items are copied to the clipboard. (inherited from TTMSFNCCustomListBox) |
| OnAfterCutToClipboard | Occurs after selected items are cut to the clipboard. (inherited from TTMSFNCCustomListBox) |
| OnAfterDrawItem | Occurs after an item is drawn. (inherited from TTMSFNCCustomListBox) |
| OnAfterDrawItemIcon | Occurs after an item icon is drawn. (inherited from TTMSFNCCustomListBox) |
| OnAfterDrawItemText | Occurs after item text is drawn. (inherited from TTMSFNCCustomListBox) |
| OnAfterDrawSortIndicator | Occurs after a sort indicator is drawn. (inherited from TTMSFNCCustomListBox) |
| OnAfterDropItem | Occurs after an item is dropped on another item. (inherited from TTMSFNCCustomListBox) |
| OnAfterPasteFromClipboard | Occurs after clipboard content is pasted into the list box. (inherited from TTMSFNCCustomListBox) |
| OnAfterReorderItem | Occurs after an item is reordered. (inherited from TTMSFNCCustomListBox) |
| OnBeforeCopyToClipboard | Occurs before selected items are copied to the clipboard. (inherited from TTMSFNCCustomListBox) |
| OnBeforeCutToClipboard | Occurs before selected items are cut to the clipboard. (inherited from TTMSFNCCustomListBox) |
| OnBeforeDrawItem | Occurs before an item is drawn. (inherited from TTMSFNCCustomListBox) |
| OnBeforeDrawItemIcon | Occurs before an item icon is drawn. (inherited from TTMSFNCCustomListBox) |
| OnBeforeDrawItemText | Occurs before item text is drawn. (inherited from TTMSFNCCustomListBox) |
| OnBeforeDrawSortIndicator | Occurs before a sort indicator is drawn. (inherited from TTMSFNCCustomListBox) |
| OnBeforeDropItem | Occurs before an item is dropped on another item. (inherited from TTMSFNCCustomListBox) |
| OnBeforePasteFromClipboard | Occurs before clipboard content is pasted into the list box. (inherited from TTMSFNCCustomListBox) |
| OnBeforeReorderItem | Occurs before an item is reordered. (inherited from TTMSFNCCustomListBox) |
| OnFilterSelect | Occurs when a filter condition is selected. (inherited from TTMSFNCCustomListBox) |
| OnItemAnchorClick | Occurs when an anchor in an item is clicked. (inherited from TTMSFNCCustomListBox) |
| OnItemClick | Occurs when an item is clicked. (inherited from TTMSFNCCustomListBox) |
| OnItemCompare | Occurs when two items need to be compared during sorting. (inherited from TTMSFNCCustomListBox) |
| OnItemDblClick | Occurs when an item is double-clicked. (inherited from TTMSFNCCustomListBox) |
| OnItemMouseEnter | Occurs when the pointer enters an item. (inherited from TTMSFNCCustomListBox) |
| OnItemMouseLeave | Occurs when the pointer leaves an item. (inherited from TTMSFNCCustomListBox) |
| OnItemSelected | Occurs when an item is selected. (inherited from TTMSFNCCustomListBox) |
| OnNeedFilterDropDownData | Occurs when the list box needs filter drop-down values. (inherited from TTMSFNCCustomListBox) |
| OnVScroll | Occurs when the vertical scroll position changes. (inherited from TTMSFNCCustomListBox) |