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 1227

`type TDBNavigator = class(TDBCustomNavigator)`
`published`
`property Align;`		Used to align the control to the top, bottom, left or right of its client.
`property Alignment;`		`Alignment` - whether text is left or right justified, or centered
`property Anchors;`		The set of anchor definitions for this control
`property AutoSize;`		Whether auto-size is to be used
`property BeforeAction;`		`BeforeAction` - code to be executed before an action is performed
`property BevelInner;`		`BevelInner` - determines the nature of the Inner Bevel of the panel (whether raised, lowered etc)
`property BevelOuter;`		`BevelOuter` - determines the nature of the Outer Bevel of the panel (whether raised, lowered etc)
`property BevelWidth;`		`BevelWidth` - the Width of the panel's bevel in pixels
`property BorderSpacing;`		Determines the border spacing for this control
`property BorderStyle;`		`BorderStyle` - none, or single
`property BorderWidth;`		Property to determine width of the window's border
`property Caption;`		`Caption` - the text-string appearing on the Control, usually used to identify its function
`property ChildSizing;`
`property ClientHeight;`		`ClientHeight` - determines the height of the client within which the control exists
`property ClientWidth;`		`ClientWidth` - determines the width of the client within which the control exists
`property Color;`		Determine the colour for the current control
`property ConfirmDelete;`		Should the user be asked for confirmation before a record is deleted? If True, a dialog appears asking for confirmation
`property DataSource;`		The Data Source to which the control must be linked in order to function
`property Direction;`		The direction in which the buttons appear: horizontal or vertical
`property DragCursor;`		`DragCursor` - the style of cursor to be used during the Drag process
`property DragMode;`		`DragMode` - whether manual or automatic
`property Enabled;`		Whether the control is `Enabled` (read/write). If not, it usually appears 'greyed-out'
`property Flat;`		`Flat` - if True, buttons have no 3-D effect
`property Font;`		The font to be used for text in this control (read/write).
`property Hints;`		A list of hints to be shown if the mouse hovers over a button
`property OnClick;`		The action to be taken when a navigator button is clicked
`property OnDblClick;`		Event Handle for mouse double-click
`property OnDragDrop;`		Event handler for the drop of a control onto this control.
`property OnDragOver;`		Event handler for the case when a control is dragged over another control
`property OnEndDrag;`		Event handler for the end of a dragging process
`property OnEnter;`		`OnEnter` - event handler for when the mouse enters the control, and the control receives focus
`property OnExit;`		`OnExit` - event handler for when the mouse leaves the control and it loses focus
`property OnMouseDown;`		Event handler for when a mouse button is pressed down
`property OnMouseMove;`		Event handler for mouse movement within the current control
`property OnMouseUp;`		Event handler for when the mouse button is released, ie "up"
`property OnResize;`		Event Handler for resize of control
`property OnStartDrag;`		Event handler for start of dragging operation
`property ParentColor;`		`ParentColor` - should the control have the same colour as the parent? Default is true
`property ParentFont;`		`ParentFont` - should the control use the same font as the parent? Default is true
`property ParentShowHint;`		`ParentShowHint` - does the control adopt the same hinting behaviour as its parent? Default is true
`property PopupMenu;`		`PopupMenu` - a context-sensitive menu that pops up when the right mouse button is clicked over this control
`property ShowHint;`		Flag to determine: Is hint to be displayed for this control?
`property TabOrder;`		The place this control occupies in the list of tabs
`property TabStop;`		Is the control in the sequence of controls accessed by successive presses of the Tab key?
`property Visible;`		`Visible` - can the control be seen?
`property VisibleButtons;`		The set of visible buttons (some of them can be suppressed if their function appears redundant)
`end;`

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`		`TCustomPanel`: The base type for `TPanel`
\|
`TCustomControl`		`TCustomControl` - a base class for many window controls
\|
`TWinControl`
\|
`TControl`
\|
`TLCLComponent`		`TLCLComponent` - base class for LCL components
\|
`TComponent,IUnknown,IInterfaceComponentReference`
\|
`TPersistent`
\|
`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.

TDBNavigator

Declaration

Inheritance

Description

See also