Skip to main content
A newer version of this page is available. .

TcxDBNavigatorButtons Class

This class represents the collection of buttons used in database navigator controls.

Declaration

TcxDBNavigatorButtons = class(
    TcxCustomNavigatorButtons
)

Remarks

In contrast to non-db buttons, the TcxDBNavigatorButtons class works with the dataset. This class provides the default action functionality for processing dataset records.

The following table displays default indexes and hints for buttons contained in the collection, and describes functionality provided by them.

Button Name

Default Index

Default Hint

Description

First

NBDI_FIRST

cxNavigatorHint_First

Moves the cursor to the first dataset record.

PriorPage

NBDI_PRIORPAGE

cxNavigatorHint_PriorPage

Moves the cursor to the previous dataset page.

Prior

NBDI_PRIOR

cxNavigatorHint_Prior

Moves the cursor to the previous dataset record.

Next

NBDI_NEXT

cxNavigatorHint_Next

Moves the cursor to the next dataset record.

NextPage

NBDI_NEXTPAGE

cxNavigatorHint_NextPage

Moves the cursor to the next dataset page.

Last

NBDI_LAST

cxNavigatorHint_Last

Moves the cursor to the last dataset record.

Insert

NBDI_INSERT

cxNavigatorHint_Insert

Inserts a new record into the connected dataset.

Append

NBDI_APPEND

cxNavigatorHint_Append

Appends a new record into the connected dataset.

Delete

NBDI_DELETE

cxNavigatorHint_Delete

Deletes the current record from the connected dataset.

Edit

NBDI_EDIT

cxNavigatorHint_Edit

Sets the connected dataset into edit state.

Post

NBDI_POST

cxNavigatorHint_Post

Saves the modified record to the connected dataset.

Cancel

NBDI_CANCEL

cxNavigatorHint_Cancel

Cancels all the unsaved modifications to the current record of the connected dataset.

Refresh

NBDI_REFRESH

cxNavigatorHint_Refresh

Fetches data from the dataset to update the data view in the appropriate control.

SaveBookmark

NBDI_SAVEBOOKMARK

cxNavigatorHint_SaveBookmark

Saves a bookmark for the connected dataset.

GotoBookmark

NBDI_GOTOBOOKMARK

cxNavigatorHint_GotoBookmark

Moves the cursor to the previously saved bookmark in the connected dataset.

Filter

NBDI_FILTER

cxNavigatorHint_Filter

Invokes the Filter Dialog for the managed dataset.

Any custom button

The default index is assigned automatically, starting from NavigatorButtonCount.

Empty string.

You can specify a hint text via a button’s Hint property.

No predefined action.

As with default buttons, you can handle a button collection’s OnButtonClick event to perform any actions associated with custom buttons.

You can modify the button behavior as required using any of the following methods:

To dynamically change the accessibility of buttons, override the GetButtonEnabled method or switch a button’s Enabled property.

For more information on how to customize button settings, refer to the TcxNavigatorButton and TcxNavigatorCustomButton class descriptions.

See Also