TcxNavigatorControlButtons Class

The collection of buttons used in non-db navigator controls.

Declaration

TcxNavigatorControlButtons = class(
    TcxCustomNavigatorButtons
)

Remarks

In contrast to db-oriented buttons, TcxNavigatorControlButtons works directly with a control and this needs to implement the IcxNavigator interface. Procedures of this interface provide all the necessary default actions.

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 record.
PriorPage	NBDI_PRIORPAGE	cxNavigatorHint_PriorPage	Moves the cursor to the previous page.
Prior	NBDI_PRIOR	cxNavigatorHint_Prior	Moves the cursor to the previous record.
Next	NBDI_NEXT	cxNavigatorHint_Next	Moves the cursor to the next record.
NextPage	NBDI_NEXTPAGE	cxNavigatorHint_NextPage	Moves the cursor to the next page.
Last	NBDI_LAST	cxNavigatorHint_Last	Moves the cursor to the last record.
Insert	NBDI_INSERT	cxNavigatorHint_Insert	Inserts a new record.
Append	NBDI_APPEND	cxNavigatorHint_Append	Appends a new record.
Delete	NBDI_DELETE	cxNavigatorHint_Delete	Deletes the current record.
Edit	NBDI_EDIT	cxNavigatorHint_Edit	Sets the dataset to the edit state.
Post	NBDI_POST	cxNavigatorHint_Post	Writes the modified record.
Cancel	NBDI_CANCEL	cxNavigatorHint_Cancel	Cancels modifications to the active record.
Refresh	NBDI_REFRESH	cxNavigatorHint_Refresh	Updates the data view in the appropriate control.
SaveBookmark	NBDI_SAVEBOOKMARK	cxNavigatorHint_SaveBookmark	Saves a certain bookmark.
GotoBookmark	NBDI_GOTOBOOKMARK	cxNavigatorHint_GotoBookmark	Moves the cursor to the previously saved bookmark.
Filter	NBDI_FILTER	cxNavigatorHint_Filter	Invokes the Filter Builder dialog.
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:

• Handle a button collection’s OnButtonClick event;

• Inherit from TcxNavigatorControlButtons and override the DoButtonClick method.

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.

The TcxGridViewNavigatorButtons and TcxExtEditingControlNavigatorButtons classes inherit from TcxNavigatorControlButtons to contain button settings within Grid View navigators and editing controls with option sets.

Inheritance

TObject

TPersistent

TInterfacedPersistent

TcxInterfacedPersistent

TcxNavigatorChildComponent

TcxCustomNavigatorButtons

TcxNavigatorControlButtons