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

# TDBListBox

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

Implements a data-aware version of TListBox.

## Declaration

Source position: dbctrls.pp line 388

`type TDBListBox = class(TCustomDBListBox)`
`protected`
`procedure DataChange(); override;` |  | Implements the event handler signalled when data in the linked dataset has been changed.
`procedure DoSelectionChange(); override;` |  | Performs actions needed when the current selection in the listbox control is changed.
`procedure UpdateData(); override;` |  | Performs actions needed to update the linked dataset when the value for the control has changed.
`public`
`procedure EditingDone; override;` |  | EditingDone - what to do when you have finished editing.
`published`
`property Align: TAlign;` |  | Specifies the placement of the control on its Parent control.
`property Anchors: TAnchors;` |  | The set of anchor definitions for this control.
`property BiDiMode: TBiDiMode;` |  | Indicates whether text controls use in bi-directional reading.
`property BorderSpacing: TControlBorderSpacing;` |  | Determines the inner and outer border spacing for this control.
`property BorderStyle: TBorderStyle;` |  | Indicates the border style displayed around the control.
`property Color: TColor;` |  | The background color for the control.
`property Constraints: TSizeConstraints;` |  | Contains the minimum and maximum Width and Height for the control.
`property DataField: string;` |  | Name for the field in the linked dataset used in the control.
`property DataSource: TDataSource;` |  | Provides access to the linked dataset for the control.
`property DoubleBuffered: Boolean;` |  | When enabled, it reduces flicker when the control is painted.
`property DragCursor: TCursor;` |  | The cursor shape shown during a drag operation.
`property DragKind: TDragKind;` |  | Indicates the action performed for a drag operation: drag-and-drop or drag-and-dock.
`property DragMode: TDragMode;` |  | Determines how a drag operation is started for the control.
`property Enabled: Boolean;` |  | Determines whether the control responds to mouse or keyboard input.
`property ExtendedSelect: Boolean;` |  | True when a contiguous range of items can be selected using Shift+Click. The default value is True.
`property Font: TFont;` |  | The font to be used for text display in this control.
`property ItemHeight: Integer;` |  | The default height for an item displayed in the list.
`property Items: TStrings;` |  | The list of all items defined in the control.
`property MultiSelect: Boolean;` |  | Allows selection of more than one item from the list.
`property Options: TListBoxOptions;` |  | Contains options enabled for the list box control.
`property ParentBiDiMode: Boolean;` |  | Indicates whether the BiDiMode settings in the Parent control are used.
`property ParentDoubleBuffered: Boolean;` |  | Value for the DoubleBuffered property in a Parent control.
`property ParentShowHint: Boolean;` |  | If True, the value of ShowHint for 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 ReadOnly: Boolean;` |  | Indicates if the linked dataset for the control cannot be modified.
`property ShowHint: Boolean;` |  | Enables Hint display for the control.
`property Sorted: Boolean;` |  | Determines whether the list entries are sorted in alphanumeric order.
`property Style: TListBoxStyle;` |  | Appearance of the list box (standard, owner-draw fixed, or owner-draw variable).
`property TabOrder: TTabOrder;` |  | Indicates the navigation order for the control when the user presses the Tab or Shift+Tab key.
`property TabStop: Boolean;` |  | Allows the user to navigate to / from the control by pressing the Tab or Shift+Tab keys.
`property TopIndex: Integer;` |  | Index of the first visible (or top-most) item.
`property Visible: Boolean;` |  | Indicates if the control is visible on the parent.
`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 signalled when a mouse double click occurs in the control.
`property OnDragDrop: TDragDropEvent;` |  | Event handler signalled when an object is dropped onto the control.
`property OnDragOver: TDragOverEvent;` |  | Event handler signalled when a control is dragged over the control instance.
`property OnDrawItem: TDrawItemEvent;` |  | Event handler signalled to draw an Item on the data-aware list box.
`property OnEndDrag: TEndDragEvent;` |  | Event handler signalled for the end of a drag-drop operation.
`property OnEnter: TNotifyEvent;` |  | Event handler signalled when the control receives focus.
`property OnExit: TNotifyEvent;` |  | Event handler signalled when the control loses focus.
`property OnKeyPress: TKeyPressEvent;` |  | Event handler signalled when a key is pressed while the control has focus.
`property OnKeyDown: TKeyEvent;` |  | Event handler signalled when a key is down while the control has focus.
`property OnKeyUp: TKeyEvent;` |  | Event handler signalled when a key is up (not pressed) while the control has focus.
`property OnMouseDown: TMouseEvent;` |  | Event handler signalled when a mouse down event is handled for the control.
`property OnMouseEnter: TNotifyEvent;` |  | Event handler signalled when the mouse pointer has entered the control.
`property OnMouseLeave: TNotifyEvent;` |  | Event handler signalled when the mouse pointer has left the control.
`property OnMouseMove: TMouseMoveEvent;` |  | Event handler signalled when the mouse pointer is moved in the control.
`property OnMouseUp: TMouseEvent;` |  | Event handler signalled when a mouse up event is handled for the control.
`property OnMouseWheel: TMouseWheelEvent;` |  | Event handler for mouse wheel turned.
`property OnMouseWheelDown: TMouseWheelUpDownEvent;` |  | Event handler signalled for a downward movement of the mouse wheel.
`property OnMouseWheelUp: TMouseWheelUpDownEvent;` |  | Event handler signalled for an upward movement of the mouse wheel.
`property OnResize: TNotifyEvent;` |  | Notification handler for a resize of the control.
`property OnStartDrag: TStartDragEvent;` |  | Event handler signalled for the start of a dragging operation.
`property OnUTF8KeyPress: TUTF8KeyPressEvent;` |  | Handler for a character entered by the user.
`end;`

## Inheritance

`TDBListBox` |  | Implements a data-aware version of TListBox.
`TCustomDBListBox` |  | Specifies a data-aware listbox control.
`TCustomListBox` |  | The base class for TListBox.
`TWinControl` |  | Implements a windowed control which can contain other child controls.
`TControl` |  | The base class for visible controls.
`TLCLComponent` |  | The base class for LCL components which have an associated widget.
`TComponent`
?
`TObject`

## Description

TDBListBox implements a data-aware version of TListBox. The control allows selection and storage of a value from a scrolling list of choices to the current record in a linked dataset.

TDBListBox extends the TCustomDBListBox ancestor class to implement abstract/virtual methods, and to set the visibility for properties in the control.

Use the Items property to define the list of choices displayed in the listbox control.

The DataSource property provides access to the linked dataset where the selected value is stored. Field contains the field definition for the column in the dataset where the selected value is stored. Use the DataField property to specify the name for the Field.

## See also

TCustomDBListBox |  | Specifies a data-aware listbox control.
How To Use Data-aware Controls |  | HowToUseDataAwareControls - Hints for accessing databases.