DataNavigator Class

The control that enables navigation through records in a data source and provides common record operations.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v18.1.dll

Declaration

C#

[ToolboxTabName("DX.18.1: Data & Analytics")]
[SmartTagAction(typeof(DataNavigatorButtonsActions), "CustomButtons", "Custom Buttons", SmartTagActionType.CloseAfterExecute)]
[ToolboxBitmap(typeof(ToolboxIconsRootNS), "DataNavigator")]
public class DataNavigator :
    NavigatorBase,
    IDataNavigatorOwner

VB.NET

<ToolboxTabName("DX.18.1: Data & Analytics")>
<SmartTagAction(GetType(DataNavigatorButtonsActions), "CustomButtons", "Custom Buttons", SmartTagActionType.CloseAfterExecute)>
<ToolboxBitmap(GetType(ToolboxIconsRootNS), "DataNavigator")>
Public Class DataNavigator
    Inherits NavigatorBase
    Implements IDataNavigatorOwner

Remarks

The DataNavigator control is used to navigate through records in a data source and perform operations against the data. It is derived from the NavigatorBase class, and so it inherits properties and methods common to all data navigation controls.

The data navigator displays built-in buttons that enable a user to scroll forward or backward through records one at a time, go to the first record, go to the last record, insert a new record, post data changes, cancel data changes and delete a record. You can also add custom buttons, when required. To access built-in and custom buttons, use the DataNavigator.Buttons property. To perform custom actions on button clicks, handle the NavigatorBase.ButtonClick event.

The DataNavigator control needs to be associated with a data source in order to receive and manipulate data. Use the DataNavigator.DataSource and DataNavigator.DataMember properties for binding.

The DataNavigator can display a text string that specifies the current record and the total record count in the associated data source. Use the NavigatorBase.TextLocation and NavigatorBase.TextStringFormat to customize the display of this text.

Related GitHub Examples

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

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#

how-to-add-text-captions-for-the-datanavigator-controls-buttons-e2085/CS/WindowsApplication1/Form1.cs#L39

private DataNavigator _SelectedNavigator;
public DataNavigator SelectedNavigator

XPO_how-xpo-supports-delayed-loading-of-objects-and-properties-e778/CS/Form1.cs#L18

{
    private DevExpress.XtraEditors.DataNavigator dataNavigator1;
    private DevExpress.XtraEditors.TextEdit textEdit1;

does-the-lookup-editor-support-guid-values-e720/CS/Form1.cs#L65

this.gridColumn1 = new DevExpress.XtraGrid.Columns.GridColumn();
this.dataNavigator1 = new DevExpress.XtraEditors.DataNavigator();
this.simpleButton1 = new DevExpress.XtraEditors.SimpleButton();

how-to-bind-a-grid-and-stand-alone-editors-to-the-same-data-and-synchronize-them-e678/CS/Form1.cs#L15

internal DevExpress.XtraEditors.PanelControl PanelControl1;
internal DevExpress.XtraEditors.DataNavigator DataNavigator1;
internal DevExpress.XtraEditors.TextEdit TextEdit1;

how-to-change-the-record-1-of-x-text-in-the-navigator-e709/CS/Form1.cs#L14

public class Form1 : System.Windows.Forms.Form {
    private DevExpress.XtraEditors.DataNavigator dataNavigator1;
    private DevExpress.XtraEditors.TextEdit textEdit1;

VB.NET

how-to-add-text-captions-for-the-datanavigator-controls-buttons-e2085/VB/WindowsApplication1/Form1.vb#L38

Private _SelectedNavigator As DataNavigator
Public Property SelectedNavigator() As DataNavigator

XPO_how-xpo-supports-delayed-loading-of-objects-and-properties-e778/VB/Form1.vb#L18

Inherits System.Windows.Forms.Form
Private dataNavigator1 As DevExpress.XtraEditors.DataNavigator
Private textEdit1 As DevExpress.XtraEditors.TextEdit

does-the-lookup-editor-support-guid-values-e720/VB/Form1.vb#L61

Me.gridColumn1 = New DevExpress.XtraGrid.Columns.GridColumn()
Me.dataNavigator1 = New DevExpress.XtraEditors.DataNavigator()
Me.simpleButton1 = New DevExpress.XtraEditors.SimpleButton()

how-to-bind-a-grid-and-stand-alone-editors-to-the-same-data-and-synchronize-them-e678/VB/Form1.vb#L16

Friend PanelControl1 As DevExpress.XtraEditors.PanelControl
Friend DataNavigator1 As DevExpress.XtraEditors.DataNavigator
Friend TextEdit1 As DevExpress.XtraEditors.TextEdit

how-to-change-the-record-1-of-x-text-in-the-navigator-e709/VB/Form1.vb#L16

Inherits System.Windows.Forms.Form
Private dataNavigator1 As DevExpress.XtraEditors.DataNavigator
Private textEdit1 As DevExpress.XtraEditors.TextEdit

Implements

IXtraResizableControl

Inheritance

Object

MarshalByRefObject

Component

Control

ControlBase

BaseControl

BaseStyleControl

NavigatorBase

DataNavigator