TDBNavigator class

In unit DBCtrls

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

Declaration

pascal

TDBNavigator = class(TDBCustomNavigator)

Inheritance

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.

Properties

`Align`	published	Specifies the placement of the control inside its Parent.
`Alignment`	published	Alignment - whether text is left or right justified, or centered.
`Anchors`	published	The set of anchor definitions for this control.
`AutoSize`	published	Allows automatic adjustment of the size for the control, according to its content.
`BidiMode`	published	Indicates whether text controls use in bi-directional reading.
`BeforeAction`	published	BeforeAction - code to be executed before an action is performed.
`BevelInner`	published	Determines the appearance of the Inner Bevel for the panel (whether raised, lowered, etc.).
`BevelOuter`	published	Determines the appearance of the Outer Bevel for the panel (whether raised, lowered, etc.).
`BevelWidth`	published	Width for a bevel on the panel in pixels.
`BorderSpacing`	published	Determines the inner and outer border spacing for this control.
`BorderStyle`	published	Indicates the border style displayed around the control.
`BorderWidth`	published	Width of the Border around the control; default is zero.
`Caption`	published	The text displayed for the control.
`ChildSizing`	published	Provides a grid (table) layout for the children of this control.
`ClientHeight`	published	The height for the client area on the control.
`ClientWidth`	published	The width of the client area for the control.
`Color`	published	Contains the background color for the control.
`Constraints`	published	Contains the minimum and maximum Width and Height for the control.
`ConfirmDelete`	published	Indicates if the user is asked to confirm a record deletion.
`DataSource`	published	The Data Source to which the control must be linked in order to function.
`Direction`	published	Contains the orientation for buttons displayed on the control: horizontal or vertical.
`DoubleBuffered`	published	When enabled, it reduces flicker when the control is painted.
`DragCursor`	published	The cursor shape shown during a drag operation.
`DragMode`	published	Determines how a drag operation is started for the control.
`Enabled`	published	Determines whether the control responds to mouse or keyboard input.
`Flat`	published	Flat - if True, buttons have no 3-D effect.
`Font`	published	The font to be used for text display in this control.
`Hints`	published	A list of hints to be shown if the mouse hovers over a button.
`Options`	published	Options enabled for the navigator.
`ParentBidiMode`	published	Indicates whether the BiDiMode settings in the Parent control are used.
`ParentColor`	published	Use the Color from the Parent control, when enabled.
`ParentDoubleBuffered`	published	Value for the DoubleBuffered property in a Parent control.
`ParentFont`	published	Indicates if the Font from the Parent control is used in the control.
`ParentShowHint`	published	If True, the value of ShowHint for the control will be the same as the one from the Parent. Default is True.
`PopupMenu`	published	A context-sensitive menu that pops up when the right mouse button is clicked over this control.
`ShowHint`	published	Enables Hint display for the control.
`TabOrder`	published	Indicates the navigation order for the control when the user presses the Tab or Shift+Tab key.
`TabStop`	published	Enables or disables navigation using the Tab key.
`Visible`	published	Allows the control, and all of its children, to be displayed or hidden.
`VisibleButtons`	published	The set of visible buttons (some of them can be suppressed if their function appears redundant).
`Images`	published	Contains the images available for display on the navigator buttons.

Events

`OnClick`	published	The action to be taken when a navigator button is clicked.
`OnContextPopup`	published	Invoked when a context-sensitive pop-up menu is requested.
`OnDblClick`	published	Event handler signalled when a mouse double click occurs in the control.
`OnDragDrop`	published	Event handler signalled when an object is dropped onto the control.
`OnDragOver`	published	Event handler signalled when a control is dragged over the control instance.
`OnEndDrag`	published	Event handler signalled for the end of a drag-drop operation.
`OnEnter`	published	Event handler signalled when the control receives focus.
`OnExit`	published	Event handler signalled when the control loses focus.
`OnMouseDown`	published	Event handler signalled when a mouse down event is handled for the control.
`OnMouseEnter`	published	Event handler signalled when the mouse pointer has entered the control.
`OnMouseLeave`	published	Event handler signalled when the mouse pointer has left the control.
`OnMouseMove`	published	Event handler signalled when the mouse pointer is moved in the control.
`OnMouseUp`	published	Event handler signalled when a mouse up event is handled for the control.
`OnMouseWheel`	published	Event handler for mouse wheel turned.
`OnMouseWheelDown`	published	Event handler signalled for a downward movement of the mouse wheel.
`OnMouseWheelUp`	published	Event handler signalled for an upward movement of the mouse wheel.
`OnResize`	published	Notification handler for a resize of the control.
`OnStartDrag`	published	Event handler signalled for the start of a dragging operation.