DataNavigator Class

Displays a UI to navigate through records in a data source and perform data operations.

Assembly : DevExpress.XtraEditors.v25.2.dll

NuGet Package : DevExpress.Win.Navigation

Declaration

C#
VB.NET

csharp

[DXLicenseWinFormsEditors]
public class DataNavigator :
    NavigatorBase,
    IDataNavigatorOwner

<DXLicenseWinFormsEditors>
Public Class DataNavigator
    Inherits NavigatorBase
    Implements IDataNavigatorOwner

Remarks

The DataNavigator control navigates through records in a data source and performs data operations (for example, add, remove, edit, etc.). Use DataNavigator.DataSource and DataNavigator.DataMember properties to bind the DataNavigator control to a data source.

View Example: Bind Data Navigator to a Shared Data Source

Command Buttons

Use the DataNavigator.Buttons property to display/hide predefined command buttons or add custom buttons.

The following table lists predefined command buttons:

Button

Description

| | --- | --- | |

First

Moves the current position to the first record.

| |

Moves the current position back by the number of records specified by the DataNavigatorButtons.PageRecordCount property (default value: 10 ).

| |

Moves the current position to the previous record.

| |

Moves the current position to the next record.

| |

Moves the current position forward by the number of records specified by the DataNavigatorButtons.PageRecordCount property (default value: 10 ).

| |

Last

Moves the current position to the last record.

| |

Append

Adds a new record.

| |

Remove

Removes the current record.

| |

EndEdit

Posts user changes to the data source.

| |

CancelEdit

Discards user changes.

Handle the NavigatorBase.ButtonClick event to implement custom logic on button clicks.

Display Text

The Data Navigator can display the current position and total record count. Use NavigatorBase.TextLocation and NavigatorBase.TextStringFormat properties to control the position, visibility, and format of this information.

Example

The following code creates a new DataNavigator control, binds it to a data source, and specifies custom images for control buttons at runtime. Custom images are stored in an ImageCollection object.

C#
VB.NET

csharp

using DevExpress.XtraEditors;

private void CreateDataNavigator() {
    // Create a new DataNavigator control
    DataNavigator dataNavigator = new DataNavigator();
    Controls.Add(dataNavigator);
    dataNavigator.Height = 40;
    dataNavigator.Dock = DockStyle.Bottom;
    // Bind to a data source
    dataNavigator.DataSource = productsBindingSource;
    // Specify the ImageCollection that stores custom images for DataNavigator buttons
    dataNavigator.Buttons.ImageList = imageCollection1;
    for (int i = 0; i < dataNavigator.Buttons.ButtonCollection.Count; i++) {
        dataNavigator.Buttons.ButtonCollection[i].ImageIndex = i;
    }
    dataNavigator.ShowToolTips = true;
}

Imports DevExpress.XtraEditors

Private Sub CreateDataNavigator()
   ' Create a new DataNavigator control
   Dim DataNavigator As New DataNavigator()
   Controls.Add(DataNavigator)
   DataNavigator.Dock = DockStyle.Bottom
   dataNavigator.Height = 40
   ' Bind to a data source
   DataNavigator.DataSource = productsBindingSource
   ' Specify the ImageCollection that stores custom images for DataNavigator buttons
   DataNavigator.Buttons.ImageList = imageCollection1
   Dim i As Integer
   For i = 0 To DataNavigator.Buttons.ButtonCollection.Count - 1
      DataNavigator.Buttons.ButtonCollection(i).ImageIndex = i
   Next i
   DataNavigator.ShowToolTips = True
End Sub

Implements

IXtraResizableControl

Inheritance

Object MarshalByRefObject Component Control DevExpress.XtraEditors.XtraControl ControlBase BaseControl BaseStyleControl NavigatorBase DataNavigator