NavigatorButtonBase.ButtonType Property

Gets the button’s type.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v19.2.dll

Declaration

C#

[Browsable(false)]
public virtual NavigatorButtonType ButtonType { get; }

VB.NET

<Browsable(False)>
Public Overridable ReadOnly Property ButtonType As NavigatorButtonType

Property Value

Type	Description
NavigatorButtonType	The NavigatorButtonType.Custom value.

Available values:

Show 12 items

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.

Remarks

The ButtonType property is overridden in derived classes to return the type of a single button.

Related GitHub Examples

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

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#

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

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

XPO_how-to-track-changes-made-to-persistent-objects-and-write-them-into-a-separate-table-e2419/CS/Q149895/Form1.cs#L21

private void OnGridControlEmbeddedNavigatorButtonClick(object sender, NavigatorButtonClickEventArgs e) {
    if (e.Button.ButtonType == NavigatorButtonType.Remove) {
        ((XPBaseObject)((GridView)gridControl1.FocusedView).GetFocusedRow()).Delete();

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

private void cnOrderDetails_ButtonClick(object sender, NavigatorButtonClickEventArgs e) {
    switch(e.Button.ButtonType) {
        case NavigatorButtonType.Remove:

how-to-use-a-richeditcontrol-in-bound-mode-e3480/CS/Form1.cs#L31

private void dataNavigator1_ButtonClick(object sender, DevExpress.XtraEditors.NavigatorButtonClickEventArgs e) {
    if (e.Button.ButtonType == NavigatorButtonType.EndEdit)
        richEditControl1.Modified = false;

how-to-confirm-row-deletion-when-using-an-embedded-navigator-e2989/CS/WindowsApplication3/Main.cs#L65

{
    if (e.Button.ButtonType == NavigatorButtonType.Remove)
    {

VB.NET

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()

how-to-use-a-richeditcontrol-in-bound-mode-e3480/VB/Form1.vb#L34

Private Sub dataNavigator1_ButtonClick(ByVal sender As Object, ByVal e As DevExpress.XtraEditors.NavigatorButtonClickEventArgs) Handles dataNavigator1.ButtonClick
    If e.Button.ButtonType = NavigatorButtonType.EndEdit Then
        richEditControl1.Modified = False

how-to-confirm-row-deletion-when-using-an-embedded-navigator-e2989/VB/WindowsApplication3/Main.vb#L64

Private Sub OnEmbeddedNavigaotrButtonClick(ByVal sender As Object, ByVal e As NavigatorButtonClickEventArgs) Handles gridControl1.EmbeddedNavigator.ButtonClick
    If e.Button.ButtonType = NavigatorButtonType.Remove Then
        If MessageBox.Show("Do you want to delete the current row?", "Confirm deletion", MessageBoxButtons.YesNoCancel, MessageBoxIcon.Question) <> DialogResult.Yes Then

how-to-delete-grid-rows-via-a-navigators-custom-button-in-edit-mode-e329/VB/WindowsApplication1/Form1.vb#L50

Dim view As ColumnView = TryCast(gridControl.FocusedView, ColumnView)
If e.Button.ButtonType = NavigatorButtonType.Custom AndAlso view IsNot Nothing Then
    view.DeleteSelectedRows()