TListBox class

In unit StdCtrls

Control which displays a scrollable list of values.

Declaration

pascal

TListBox = class(TCustomListBox)

Inheritance

Description

TListBox is a TCustomListBox descendant which implements a scrollable list of values. The value are normally stored as strings in the Items property. It allows selection of one or more of the item values.

At design time, a click on the ellipsis character (...) next to the Items entry in the Object Inspector opens a string-list editor in which the individual text-strings for the list items can be entered or edited. The editor also allows the entries to be sorted alphabetically in normal or reverse order.

Use the Styles property to enable owner-drawn styles (with either fixed or variable height list items) or the "virtual mode" where the items displayed on the control are provided by event handlers. Use the OnMeasureItem and OnDrawItem event handlers to measure and render the owner-drawn list items. Use the Canvas property when needed to implement an owner-drawn style.

Properties

`Align`	published	Specifies the placement of the control on its Parent control.
`Anchors`	published	The set of anchor definitions for this control.
`BidiMode`	published	Indicates whether text controls use in bi-directional reading.
`BorderSpacing`	published	Determines the inner and outer border spacing for this control.
`BorderStyle`	published	Line style used for the border on the control.
`ClickOnSelChange`	published	Allows selection changes to generate a Click event.
`Color`	published	The background color for the control.
`Columns`	published	The number of visible columns displayed on the control.
`Constraints`	published	Contains the minimum and maximum Width and Height for the control.
`DoubleBuffered`	published	When enabled, it reduces flicker when the control is painted.
`DragCursor`	published	The cursor shape shown during a drag operation.
`DragKind`	published	Indicates the action performed for a drag operation: drag-and-drop or drag-and-dock.
`DragMode`	published	Determines how a drag operation is started for the control.
`ExtendedSelect`	published	True when a contiguous range of items can be selected using Shift+Click. The default value is True.
`Enabled`	published	Determines whether the control responds to mouse or keyboard input.
`Font`	published	The font to be used for text display in this control.
`IntegralHeight`	published	Not implemented: shrink the Height of the widget, so that it only shows fully visible rows.
`Items`	published	The list of items defined for the control.
`ItemHeight`	published	Get or set the height of a single item in the control.
`ItemIndex`	published	Ordinal position for the currently selected item, -1 if none.
`MultiSelect`	published	Allows selection of more than one item from the list.
`Options`	published	Contains options enabled for the list box control.
`ParentBidiMode`	published	Indicates whether the BiDiMode settings in the Parent control are used.
`ParentColor`	published	Use the Color from the Parent control, when enabled.
`ParentDoubleBuffered`	published	Value for the DoubleBuffered property in a Parent control.
`ParentShowHint`	published	If True, the value of ShowHint for the control will be the same as the one from the Parent. Default is True.
`ParentFont`	published	Indicates if the Font from the Parent control is used in the control.
`PopupMenu`	published	A context-sensitive menu that pops up when the right mouse button is clicked over this control.
`ScrollWidth`	published	The virtual width of the list box, in pixels.
`ShowHint`	published	Enables Hint display for the control.
`Sorted`	published	Determines whether the list entries are sorted in alphanumeric order.
`Style`	published	Controls the appearance of items on the list box control and indicates whether the control uses "virtual mode".
`TabOrder`	published	Indicates the navigation order for the control when the user presses the Tab or Shift+Tab key.
`TabStop`	published	Enables keyboard navigation using the Tab or Shift+Tab keys.
`TopIndex`	published	Index of the first visible (or top-most) item.
`Visible`	published	Allows the control, and all of its children, to be displayed or hidden.

Events

`OnChangeBounds`	published	Event handler signalled when the Bounds for the control have been changed.
`OnClick`	published	Notification handler for mouse clicks.
`OnContextPopup`	published	Invoked when a context-sensitive pop-up menu is requested.
`OnData`	published	Event handler signalled to get the ordinal position for a virtual list item with the specified string value. Not used in the current LCL version.
`OnDataObject`	published	Event handler signalled to get the TObject instance with the data for a "virtual" item on the list box control. Not used in the current LCL version.
`OnDataFind`	published	Event handler signalled to get the ordinal position for a virtual list item with the specified string value. Not used in the current LCL version.
`OnDblClick`	published	Event handler signalled when a mouse double click occurs in the control.
`OnDragDrop`	published	Event handler signalled when an object is dropped onto the control.
`OnDragOver`	published	Event handler signalled when a control is dragged over the control instance.
`OnDrawItem`	published	Handler for painting of a list item in owner-draw mode.
`OnEnter`	published	Event handler signalled when the control receives focus.
`OnEndDrag`	published	Event handler signalled for the end of a drag-drop operation.
`OnExit`	published	Event handler signalled when the control loses focus.
`OnKeyPress`	published	Event handler signalled for character data entered by the user.
`OnKeyDown`	published	Event handler signalled for key down keyboard events.
`OnKeyUp`	published	Event handler signalled when a key up event has occurred for the control.
`OnMeasureItem`	published	Handler invoked when the height for an item is needed.
`OnMouseDown`	published	Event handler signalled when a mouse down event is handled for the control.
`OnMouseEnter`	published	Event handler signalled when the mouse pointer has entered the control.
`OnMouseLeave`	published	Event handler signalled when the mouse pointer has left the control.
`OnMouseMove`	published	Event handler signalled when the mouse pointer is moved in the control.
`OnMouseUp`	published	Event handler signalled when a mouse up event is handled for the control.
`OnMouseWheel`	published	Event handler for mouse wheel turned.
`OnMouseWheelDown`	published	Event handler signalled for a downward movement of the mouse wheel.
`OnMouseWheelUp`	published	Event handler signalled for an upward movement of the mouse wheel.
`OnMouseWheelHorz`	published	Event handler signalled for a horizontal movement of the mouse wheel.
`OnMouseWheelLeft`	published	Event handler signalled for a leftward movement of the mouse wheel.
`OnMouseWheelRight`	published	Event handler signalled for a rightward movement of the mouse wheel.
`OnResize`	published	Notification handler for a resize of the control.
`OnSelectionChange`	published	Handler invoked when an item is selected in the control.
`OnShowHint`	published	Event handler signalled when a hint window is displayed for the control.
`OnStartDrag`	published	Event handler signalled for the start of a dragging operation.
`OnUTF8KeyPress`	published	Handler for a character entered by the user.