[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 386

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 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;

  

Indicates if borders are displayed around the control.

  property Color: TColor;

  

The background color of the control.

  property Constraints: TSizeConstraints;

  

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;

  

Allows to reduce flicker in the painting of the 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 Enabled: Boolean;

  

Determines whether the control reacts on mouse or keyboard input.

  property ExtendedSelect: Boolean;

  

True when a contiguous range of items can be selected by a Shift+Click. Default 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 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;

  

Event handler signalled to draw an Item on the data-aware list box.

  property OnEndDrag: TEndDragEvent;

  

Notification handler for the end of a dragging operation.

  property OnEnter: TNotifyEvent;

  

Handler for control receiving the focus.

  property OnExit: TNotifyEvent;

  

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

  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 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;

  

Event handler for downward movement of mouse wheel.

  property OnMouseWheelUp: TMouseWheelUpDownEvent;

  

Event handler for upward movement of the mouse wheel.

  property OnResize: TNotifyEvent;

  

Notification handler for a resize of the control.

  property OnStartDrag: TStartDragEvent;

  

Event handler for the start of a dragging operation.

  property OnUTF8KeyPress: TUTF8KeyPressEvent;

  

Handler for a character entered by the user.

  property Options: TListBoxOptions;

  

Contains options enabled for the list box control.

  property ParentBiDiMode: Boolean;

  

Allows to use the BiDiMode settings in the Parent control. Default is true.

  property ParentDoubleBuffered: Boolean;

  

Value from 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 the Hint display.

  property Sorted: Boolean;

  

Determines whether the list entries are sorted in alphanumeric order.

  property Style: TListBoxStyle;

  

Appearance of the list box (normal, owner-draw fixed, or owner-draw variable).

  property TabOrder: TTabOrder;

  

Determines the sequence of control navigation 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 (or top-most) item.

  property Visible: Boolean;

  

Indicates if the control is visible on the parent.

end;

Inheritance

TDBListBox

  

Implements a data-aware version of TListBox.

|

TCustomDBListBox

  

Specifies a data-aware listbox control.

|

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 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.

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