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

`type TDBNavigator = class(TDBCustomNavigator)`
`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 automatic adjustment of the size for the control, according to its content.
`property BidiMode: TBiDiMode;` |  | Indicates whether text controls use in bi-directional reading.
`property BeforeAction: TDBNavClickEvent;` |  | BeforeAction - code to be executed before an action is performed.
`property BevelInner: TPanelBevel;` |  | Determines the appearance of the Inner Bevel for the panel (whether raised, lowered, etc.).
`property BevelOuter: TPanelBevel;` |  | Determines the appearance of the Outer Bevel for the panel (whether raised, lowered, etc.).
`property BevelWidth: TBevelWidth;` |  | Width for a bevel on the panel in pixels.
`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 BorderWidth: TBorderWidth;` |  | Width of the Border around the control; default is zero.
`property Caption: TCaption;` |  | The text displayed for the control.
`property ChildSizing: TControlChildSizing;` |  | Provides a grid (table) layout for the children of this control.
`property ClientHeight: Integer;` |  | The height for the client area on the control.
`property ClientWidth: Integer;` |  | The width of the client area for the control.
`property Color: TColor;` |  | Contains the background color for the control.
`property Constraints: TSizeConstraints;` |  | Contains the minimum and maximum Width and Height for the control.
`property ConfirmDelete: Boolean;` |  | Indicates if the user is asked to confirm a record deletion.
`property DataSource: TDataSource;` |  | The Data Source to which the control must be linked in order to function.
`property Direction: TDBNavButtonDirection;` |  | Contains the orientation for buttons displayed on the control: horizontal or vertical.
`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 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 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 Options: TDBNavigatorOptions;` |  | Options enabled for the navigator.
`property ParentBidiMode: Boolean;` |  | Indicates whether the BiDiMode settings in the Parent control are used.
`property ParentColor: Boolean;` |  | Use the Color from the Parent control, when enabled.
`property ParentDoubleBuffered: Boolean;` |  | Value for the DoubleBuffered property in a Parent control.
`property ParentFont: Boolean;` |  | Indicates if the Font from the Parent control is used in the 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 ShowHint: Boolean;` |  | Enables Hint display for the control.
`property TabOrder: TTabOrder;` |  | Indicates the navigation order for the control when the user presses the Tab or Shift+Tab key.
`property TabStop: Boolean;` |  | Enables or disables navigation using the Tab key.
`property Visible: Boolean;` |  | Allows the control, and all of its children, to be displayed or hidden.
`property VisibleButtons: TDBNavButtonSet;` |  | The set of visible buttons (some of them can be suppressed if their function appears redundant).
`property Images: TCustomImageList;` |  | Contains the images available for display on the navigator buttons.
`property OnClick: TDBNavClickEvent;` |  | The action to be taken when a navigator button is clicked.
`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 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 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.
`end;`

## Inheritance

`TDBNavigator` |  | TDBNavigator - a data-aware Button-Bar to facilitate navigating between records of a dataset.
`TDBCustomNavigator` |  | TDBCustomNavigator is 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` |  | 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

TDBNavigator is a tool used to navigate local datasets in a response to a query sent to the database. It consists of a series of tool buttons used to perform navigation and maintenance for records in the linked dataset.

For example:

Navigation
  First, Prior, Next or Last
Maintenance
  Insert, Delete, Edit, Post, Cancel or Refresh

Use the VisibleButtons property to specify which of the Buttons can be displayed in the control.

If used in conjunction with a data-aware controls, it controls which record is 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 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 assigned to link to the dataset for the control.

## See also

How To Use Data-aware Controls |  | HowToUseDataAwareControls - Hints for accessing databases.
TDBCustomNavigator |  | TDBCustomNavigator is the base class for TDBNavigator, a tool for navigating through the records of a dataset.