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

TcxCustomNavigatorButtons Class

Serves as the base class for classes that implement button collections used in navigator controls.

Declaration

TcxCustomNavigatorButtons = class(
    TcxNavigatorChildComponent
)

Remarks

The collection contains the following buttons:

  • Default buttons with predefined functionality allowing end-users to perform most common data operations;

  • Custom buttons allowing you to implement your own functionality.

Both default buttons and custom buttons can be accessed by their default indexes within the Buttons collection.

The table below shows default collection indexes, images, and hints associated with individual buttons.

Button Name

Image

Default Index

Default Hint

First

NBDI_FIRST

cxNavigatorHint_First

PriorPage

NBDI_PRIORPAGE

cxNavigatorHint_PriorPage

Prior

NBDI_PRIOR

cxNavigatorHint_Prior

Next

NBDI_NEXT

cxNavigatorHint_Next

NextPage

NBDI_NEXTPAGE

cxNavigatorHint_NextPage

Last

NBDI_LAST

cxNavigatorHint_Last

Insert

NBDI_INSERT

cxNavigatorHint_Insert

Append

NBDI_APPEND

cxNavigatorHint_Append

Delete

NBDI_DELETE

cxNavigatorHint_Delete

Edit

NBDI_EDIT

cxNavigatorHint_Edit

Post

NBDI_POST

cxNavigatorHint_Post

Cancel

NBDI_CANCEL

cxNavigatorHint_Cancel

Refresh

NBDI_REFRESH

cxNavigatorHint_Refresh

SaveBookmark

NBDI_SAVEBOOKMARK

cxNavigatorHint_SaveBookmark

GotoBookmark

NBDI_GOTOBOOKMARK

cxNavigatorHint_GotoBookmark

Filter

NBDI_FILTER

cxNavigatorHint_Filter

Any custom button

No default image.

You can associate an image with a button via the button’s ImageIndex property.

The default index is assigned automatically, starting from NavigatorButtonCount.

Empty string.

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

All the operations associated with the default buttons are implemented in TcxCustomNavigatorButtons descendants.

You can use TcxCustomNavigatorButtons as the base class for your custom button collection classes.

See Also