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

TDBNavigator

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

TDBNavigator - a data-aware Button-Bar to facilitate navigating between records of a dataset

Declaration

Source position: dbctrls.pp line 1319

type TDBNavigator = class(TDBCustomNavigator) end;

published

  property Align: TAlign;

  

Specifies the placement of the control inside its Parent.

  property Alignment: TAlignment;

  

Alignment - whether text is left or right justified, or centered

  property Anchors: TAnchors;

  

The set of anchor definitions for this control.

  property AutoSize: Boolean;

  

Allows to automatically adjust the size of the control, according to its content.

  property BidiMode: TBiDiMode;

  property BeforeAction: TDBNavClickEvent;

  

BeforeAction - code to be executed before an action is performed

  property BevelInner: TPanelBevel;

  

BevelInner - determines the nature of the Inner Bevel of the panel (whether raised, lowered etc)

  property BevelOuter: TPanelBevel;

  

BevelOuter - determines the nature of the Outer Bevel of the panel (whether raised, lowered etc)

  property BevelWidth: TBevelWidth;

  

BevelWidth - the Width of the panel's bevel in pixels

  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 BorderWidth: TBorderWidth;

  

Width of the Border around the control; default is zero.

  property Caption: TCaption;

  

The text describing the control to the user.

  property ChildSizing: TControlChildSizing;

  property ClientHeight: Integer;

  

The height of the client area of the control.

  property ClientWidth: Integer;

  

The width of the client area of the control.

  property Color: TColor;

  

The background color of the control.

  property ConfirmDelete: Boolean;

  

Should the user be asked for confirmation before a record is deleted? If True, a dialog appears asking for confirmation

  property DataSource: TDataSource;

  

The Data Source to which the control must be linked in order to function

  property Direction: TDBNavButtonDirection;

  

The direction in which the buttons appear: horizontal or vertical

  property DragCursor: TCursor;

  

The cursor shape shown while the control is dragged.

  property DragMode: TDragMode;

  

Allows the user to drag the control.

  property Enabled: Boolean;

  

Determines whether the control reacts on mouse or keyboard input.

  property Flat: Boolean;

  

Flat - if True, buttons have no 3-D effect

  property Font: TFont;

  

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

  property Hints: TStrings;

  

A list of hints to be shown if the mouse hovers over a button

  property OnClick: TDBNavClickEvent;

  

The action to be taken when a navigator button is clicked

  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 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 OnMouseDown: TMouseEvent;

  

Event handler for mouse button going down.

  property OnMouseEnter: TNotifyEvent;

  property OnMouseLeave: TNotifyEvent;

  property OnMouseMove: TMouseMoveEvent;

  

Event handler for mouse movement within the control.

  property OnMouseUp: TMouseEvent;

  

Event handler for mouse button going up.

  property OnMouseWheel: TMouseWheelEvent;

  property OnMouseWheelDown: TMouseWheelUpDownEvent;

  property OnMouseWheelUp: TMouseWheelUpDownEvent;

  property OnResize: TNotifyEvent;

  

Notification handler for a resize of the control.

  property OnStartDrag: TStartDragEvent;

  

Event handler for the start of a dragging operation.

  property Options: TDBNavigatorOptions;

  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 ParentFont: Boolean;

  

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

  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 ShowHint: Boolean;

  

Enables the Hint display.

  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 Visible: Boolean;

  

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

  property VisibleButtons: TDBNavButtonSet;

  

The set of visible buttons (some of them can be suppressed if their function appears redundant)

  property Images: TCustomImageList;

Inheritance

TDBNavigator

  

TDBNavigator - a data-aware Button-Bar to facilitate navigating between records of a dataset

|

TDBCustomNavigator

  

TDBCustomNavigator - the base class for TDBNavigator, a tool for navigating through the records of a dataset

|

TCustomPanel

  

The base class for a general container which can hold other objects. It has a customizable border and a central text.

|

TCustomControl

  

The base class for windowed controls which paint themselves.

|

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

TDBNavigator is an advanced tool for navigating through datasets held locally in response to a query sent to the database.

It consists of a series of toolbuttons to move to the First, Prior, Next or Last record; to Insert or Delete a record; to Edit a record (enter Edit mode), to Post the changes. to Cancel the changes, and to Refresh the display from the database.

The programmer may determine, at design time, which buttons are to be displayed or suppressed by adjusting the VisibleButtons property in the Object Inspector.

If used in conjunction with a DataAware control such as TDBGrid or TDBMemo it controls which records are displayed , the position of the record selection cursor, and the initiation of changes to the dataset and ultimately the database.

Most of the functionality of the toolbar is already built-in to the control, but if the programmer needs to specify actions to be associated with individual buttons, there is a procedure TDBCustomNavigator.BtnClick to which an argument can be sent with the Index value of the button clicked, and the procedure chooses which action to call dependent on the button index.

The DataSource property must be set to link to the appropriate set of data.

See also

HowToUseDataAwareControls

  

HowToUseDataAwareControls - Hints for accessing databases

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