DataNavigator.DataSource Property

Gets or sets a data source for the DataNavigator control.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v19.2.dll

Declaration

C#

[DXCategory("Data")]
[DefaultValue(null)]
public object DataSource { get; set; }

VB.NET

<DXCategory("Data")>
<DefaultValue(Nothing)>
Public Property DataSource As Object

Property Value

Type	Default	Description
Object	*null*	A data source object whose data is managed by the data navigator.

Remarks

The DataNavigator control is used to navigate through the records in a data source and perform operations on the data. Thus, it needs to be associated with a data source in order to receive and manipulate data.

The DataSource property represents the object used as a data source. Generally, the data source object is represented by the DataSet component. The data source can contain a multiple set of data (several tables, for instance). Use the DataNavigator.DataMember property to specify the appropriate table whose contents are to be navigated and manipulated by the data navigator.

Example

The following code shows how to create a new DataNavigator control, bind it to a data source and specify custom images for the control’s buttons at runtime. The custom images are stored in an ImageCollection object.

C#

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 the DataNavigator's buttons
    dataNavigator.Buttons.ImageList = imageCollection1;
    for (int i = 0; i < dataNavigator.Buttons.ButtonCollection.Count; i++) {
        dataNavigator.Buttons.ButtonCollection[i].ImageIndex = i;
    }
    dataNavigator.ShowToolTips = true;
}

VB.NET

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 the DataNavigator's 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

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the DataSource 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#

how-to-place-datanavigator-on-xtrabars-toolbars-e3158/CS/WindowsFormsApplication3/Form1.cs#L28

RepositoryItemInplaceDataNavigator repo = barEditItem1.Edit as RepositoryItemInplaceDataNavigator;
repo.EditNavigator.DataSource = bs;

how-to-export-each-record-into-a-new-pdf-file-during-the-mailmerge-operation-e4308/CS/MailMergeEachRecordSeparatePDF/Form1.cs#L19

var datasource = DataHelper.GenerateEmployeeList();
dataNavigator1.DataSource = datasource;
richEditControl1.Options.MailMerge.DataSource = datasource;

how-to-use-images-when-implementing-the-mail-merge-functionality-e4164/CS/Form1.cs#L22

    dataNavigator1.DataSource = NorthwindDataProvider.Categories;
}

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

    dataGridView1.DataSource = CreateTable(20);
    dataNavigator1.DataSource = dataGridView1.DataSource;
}

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

DataNavigator1.DataSource = DataSet1;
DataNavigator1.DataMember = "Table1";

VB.NET

how-to-place-datanavigator-on-xtrabars-toolbars-e3158/VB/WindowsFormsApplication3/Form1.vb#L27

Dim repo As RepositoryItemInplaceDataNavigator = TryCast(barEditItem1.Edit, RepositoryItemInplaceDataNavigator)
repo.EditNavigator.DataSource = bs

how-to-export-each-record-into-a-new-pdf-file-during-the-mailmerge-operation-e4308/VB/MailMergeEachRecordSeparatePDF/Form1.vb#L21

Dim datasource = DataHelper.GenerateEmployeeList()
dataNavigator1.DataSource = datasource
richEditControl1.Options.MailMerge.DataSource = datasource

how-to-use-images-when-implementing-the-mail-merge-functionality-e4164/VB/Form1.vb#L24

    dataNavigator1.DataSource = NorthwindDataProvider.Categories
End Sub

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

    dataGridView1.DataSource = CreateTable(20)
    dataNavigator1.DataSource = dataGridView1.DataSource
End Sub

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

DataNavigator1.DataSource = DataSet1
DataNavigator1.DataMember = "Table1"