NavigatorButtonType Enum

Contains values specifying the type of buttons displayed in the data navigator control.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v18.1.dll

Declaration

C#

public enum NavigatorButtonType

VB.NET

Public Enum NavigatorButtonType

Members

Name	Description
Custom	Reserved for future use.
First	Sets the current record to the first record in the data source.
PrevPage	When using the DataNavigator, changes the current record position in a data source by the DataNavigatorButtons.PageRecordCount property value backwards. In case of the ControlNavigator, changes the current record position in a data source by the count of visible onscreen records backwards.
Prev	Sets the current record to the previous record in the data source.
Next	Sets the current record to the next record in the data source.
NextPage	When using the DataNavigator, changes the current record position in a data source by the DataNavigatorButtons.PageRecordCount property value upwards. In case of the ControlNavigator, changes the current record position in a data source by the count of visible onscreen records upwards.
Last	Sets the current record to the last record in the data source.
Append	Inserts a new record after the last one.
Remove	Deletes the current record and makes the next record the current record.
Edit	Sets the dataset to the edit state.
EndEdit	Posts edited record value to the associated data source.
CancelEdit	Cancels edits to the current record.

Related API Members

The following properties accept/return NavigatorButtonType values:

• NavigatorButton.ButtonType
• NavigatorButtonBase.ButtonType

Remarks

Members of the NavigatorButtonType enumeration specify all available data navigator button types and can be accessed via the NavigatorButton.ButtonType property. The following table lists available types:

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the NavigatorButtonType enum.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

custom-gridcontrol-how-to-create-a-vertical-embedded-navigator-e4091/CS/ExtendedDataNavigator/Navigator/ExtendedDataNavigatorButtonsViewInfo.cs#L77

{
    case NavigatorButtonType.Custom:
        break;

unbound-navigator-with-custom-functionality-e839/CS/Form1.cs#L104

public bool IsActionEnabled(NavigatorButtonType type) {
    // your code is here

how-to-add-a-custom-button-to-the-grids-embedded-navigator-e727/CS/MyEmbeddedNavigator.cs#L44

public MyNavigatorCustomButtonHelper(NavigatorButtonsBase buttons) : base(buttons) {}
public override NavigatorButtonType ButtonType {
    get {

edit-detail-data-in-datalayoutcontrol-e510/CS/WindowsApplication204/Form1.cs#L93

{
    if (e.Button.ButtonType == DevExpress.XtraEditors.NavigatorButtonType.Custom)
    {

XPO_how-to-view-persistent-objects-in-the-xtragrid-and-edit-them-in-a-separate-window-e771/CS/FormEditOrder.cs#L37

switch(e.Button.ButtonType) {
    case NavigatorButtonType.Remove:
        e.Handled = true;

VB.NET

custom-gridcontrol-how-to-create-a-vertical-embedded-navigator-e4091/VB/ExtendedDataNavigator/Navigator/ExtendedDataNavigatorButtonsViewInfo.vb#L73

Select Case button.ButtonType
    Case NavigatorButtonType.Custom
    Case NavigatorButtonType.First

unbound-navigator-with-custom-functionality-e839/VB/Form1.vb#L113

Public Function IsActionEnabled(ByVal type As NavigatorButtonType) As Boolean Implements INavigatableControl.IsActionEnabled
    ' your code is here

how-to-add-a-custom-button-to-the-grids-embedded-navigator-e727/VB/MyEmbeddedNavigator.vb#L58

End Sub
Public Overrides ReadOnly Property ButtonType() As NavigatorButtonType
    Get

edit-detail-data-in-datalayoutcontrol-e510/VB/WindowsApplication204/Form1.vb#L89

Private Sub gridControl1_EmbeddedNavigator_ButtonClick(ByVal sender As Object, ByVal e As DevExpress.XtraEditors.NavigatorButtonClickEventArgs) Handles gridControl1.EmbeddedNavigator.ButtonClick
    If e.Button.ButtonType = DevExpress.XtraEditors.NavigatorButtonType.Custom Then
        ShowEditForm()

XPO_how-to-track-changes-made-to-persistent-objects-and-write-them-into-a-separate-table-e2419/VB/Q149895/Form1.vb#L23

Private Sub OnGridControlEmbeddedNavigatorButtonClick(ByVal sender As Object, ByVal e As NavigatorButtonClickEventArgs) Handles gridControl1.EmbeddedNavigator.ButtonClick
    If e.Button.ButtonType = NavigatorButtonType.Remove Then
        CType((CType(gridControl1.FocusedView, GridView)).GetFocusedRow(), XPBaseObject).Delete()