[Overview][Constants][Types][Classes][Procedures and functions][Index] Reference for unit 'StdCtrls' (#lcl)

TListBox

[Properties (by Name)] [Methods (by Name)] [Events (by Name)]

A scrollable list of strings.

Declaration

Source position: stdctrls.pp line 645

type TListBox = class(TCustomListBox) end;

published

  property Align: TAlign;

  

Specifies the placement of the control inside its Parent.

  property Anchors: TAnchors;

  

The set of anchor definitions for this control.

  property BidiMode: TBiDiMode;

  

Customization (of text controls) in bidirectional reading environments.

  property BorderSpacing: TControlBorderSpacing;

  

Determines the inner and outer border spacing for this control.

  property BorderStyle: TBorderStyle;

  

Allows to show a border (line) around the control,

  property ClickOnSelChange: Boolean;

  

Allows selection changes to generate a Click event.

  property Color: TColor;

  

The background color of the control.

  property Columns: Integer;

  

The number of visible vertical columns.

  property Constraints: TSizeConstraints;

  

The minimal and maximal Width and Height of this control.

  property DragCursor: TCursor;

  

The cursor shape shown while the control is dragged.

  property DragKind: TDragKind;

  

The operation when the control is dragged - Drag or Dock.

  property DragMode: TDragMode;

  

Allows the user to drag the control.

  property ExtendedSelect: Boolean;

  

True when a contiguous range of items can be selected by a SHIFT-click. Default True.

  property Enabled: Boolean;

  

Determines whether the control reacts on mouse or keyboard input.

  property Font: TFont;

  

The font to be used for text display in this control.

  property IntegralHeight: Boolean;

  

Not implemented: shrink the Height of the widget, so that it only shows fully visible rows.

  property Items: TStrings;

  

The list of all items in the control.

  property ItemHeight: Integer;

  

The default height of all items.

  property ItemIndex: Integer;

  property MultiSelect: Boolean;

  

Allows to select more than one Item from the list, using CTRL-click.

  property OnChangeBounds: TNotifyEvent;

  

Event handler for a change of the Bounds of the control.

  property OnClick: TNotifyEvent;

  

Notification handler for mouse clicks.

  property OnContextPopup: TContextPopupEvent;

  

Invoked when a context-sensitive pop-up menu is requested.

  property OnDblClick: TNotifyEvent;

  

Event Handler for double mouse clicks.

  property OnDragDrop: TDragDropEvent;

  

This handler determines the action on an drop onto this control, in a drag-drop operation.

  property OnDragOver: TDragOverEvent;

  

Event handler for a control being dragged over this control.

  property OnDrawItem: TDrawItemEvent;

  

Handler for special painting of an item (in owner-draw mode).

  property OnEnter: TNotifyEvent;

  

Handler for control receiving the focus.

  property OnEndDrag: TEndDragEvent;

  

Notification handler for the end of a dragging operation.

  property OnExit: TNotifyEvent;

  

Handler for control loosing the focus. This is a good place for checking the finished user input.

  property OnKeyPress: TKeyPressEvent;

  

Handler for a character entered by the user.

  property OnKeyDown: TKeyEvent;

  

Handler for keyboard key pressed.

  property OnKeyUp: TKeyEvent;

  

Handler for keyboard key released.

  property OnMeasureItem: TMeasureItemEvent;

  

Handler invoked when the height of an item is required.

  property OnMouseDown: TMouseEvent;

  

Event handler for mouse button going down.

  property OnMouseEnter: TNotifyEvent;

  

Event handler for mouse entering the area of the control.

  property OnMouseLeave: TNotifyEvent;

  

Event handler for mouse leaving the area of the control.

  property OnMouseMove: TMouseMoveEvent;

  

Event handler for mouse movement within the control.

  property OnMouseUp: TMouseEvent;

  

Event handler for mouse button going up.

  property OnMouseWheel: TMouseWheelEvent;

  

Event handler for mouse wheel turned.

  property OnMouseWheelDown: TMouseWheelUpDownEvent;

  

Notification handler for downward movement of mouse wheel.

  property OnMouseWheelUp: TMouseWheelUpDownEvent;

  

Notification handler for upward movement of mouse wheel.

  property OnResize: TNotifyEvent;

  

Notification handler for a resize of the control.

  property OnSelectionChange: TSelectionChangeEvent;

  

Handler invoked when an item is selected.

  property OnShowHint: TControlShowHintEvent;

  

Event Handler when a hint shall be shown.

  property OnStartDrag: TStartDragEvent;

  property OnUTF8KeyPress: TUTF8KeyPressEvent;

  

Handler for a character entered by the user.

  property Options: TListBoxOptions;

  property ParentBidiMode: Boolean;

  property ParentColor: Boolean;

  

If true, the Color of the control will be the same as the one from the Parent. Default is true.

  property ParentShowHint: Boolean;

  property ParentFont: Boolean;

  

If true, the Font of the control will be the same as the one from the Parent. Default is true.

  property PopupMenu: TPopupMenu;

  

A context-sensitive menu that pops up when the right mouse button is clicked over this control

  property ScrollWidth: Integer;

  property ShowHint: Boolean;

  

Enables the Hint display.

  property Sorted: Boolean;

  

Determines whether the list entries are sorted.

  property Style: TListBoxStyle;

  

Appearance of the ListBox - normal, owner-draw fixed, or owner-draw variable.

  property TabOrder: TTabOrder;

  

Determines the sequence of controls, reachable when the user presses the Tab key.

  property TabStop: Boolean;

  

Allows the user to navigate to this control, by pressing the Tab key.

  property TopIndex: Integer;

  

Index of the first visible (topmost) item.

  property Visible: Boolean;

  

Allows to show or hide the control, and all of its children.

Inheritance

TListBox

  

A scrollable list of strings.

|

TCustomListBox

  

The base class for TListBox.

|

TWinControl

  

The base class for controls which can contain other (child) controls.

|

TControl

  

The base class for visible controls.

|

TLCLComponent

  

The base class for LCL components associated with widgets.

|

TComponent

?

TObject

Description

The strings are stored in the Items list.

At design time a click on the ellipsis (...) next to the Items entry in the Object Inspector opens an 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.

See also

TComboBox

  

A combination of an edit box and a (drop-down) list allowing one of several options to be chosen.

HowToUseStdCtrls

  

How to use StdCtrls, ComCtrls or ExtCtrls

The latest version of this document can be found at lazarus-ccr.sourceforge.net.