DataControlBase.ItemsSource Property

Gets or sets the grid’s data source. This is a dependency property.

Namespace: DevExpress.Xpf.Grid

Assembly: DevExpress.Xpf.Grid.v19.1.Core.dll

Declaration

C#

[Bindable(true)]
public object ItemsSource { get; set; }

VB.NET

<Bindable(True)>
Public Property ItemsSource As Object

Property Value

Type	Description
Object	An object that represents the data source from which the grid retrieves its data.

Remarks

The grid cannot operate without a data source. It can be bound to data from a database, from an XML file or to any data created at runtime. The grid can be bound to any object that implements the IEnumerable interface or its descendant (e.g. IList, ICollection). To bind a grid, you should assign a data source to the ItemsSource property. Note that the grid cannot be bound at design-time - only at runtime.

To learn more, see Binding to Data Overview.

Note

The GridControl.DataSource property is obsolete.

Example

This example demonstrates how to read data from an XML file and display it using the DXGrid control. If required, the changes made can be saved back to an XML file by clicking the button displayed below the grid.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-display-data-from-an-xml-file-e1506.

Window1.xaml

<Window x:Class="DXGrid_BindingToXML.Window1"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation" 
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" 
        xmlns:dxg="http://schemas.devexpress.com/winfx/2008/xaml/grid"
        Title="Window1" 
        Height="292" 
        Width="533"
    >
    <Grid>
        <Grid.RowDefinitions>
            <RowDefinition />
            <RowDefinition Height="30" />
        </Grid.RowDefinitions>

        <dxg:GridControl 
            x:Name="grid" 
            VerticalAlignment="Top">
            <dxg:GridControl.Columns>
                <dxg:GridColumn FieldName="FirstName" />
                <dxg:GridColumn FieldName="LastName" />
                <dxg:GridColumn FieldName="Company" />
                <dxg:GridColumn FieldName="City" />
            </dxg:GridControl.Columns>
            <dxg:GridControl.View>
                <dxg:TableView AutoWidth="True" />
            </dxg:GridControl.View>
        </dxg:GridControl>
        <Button Margin="5" Grid.Row="1" Click="Button_Click" VerticalAlignment="Bottom" HorizontalAlignment="Left" Content="Post Data to an XML File"/>



    </Grid>
</Window>

Window1.xaml.vb

Imports System.Windows
Imports System.Data

Namespace DXGrid_BindingToXML

    Partial Public Class Window1
        Inherits Window

        Private Shared path As String = "..\..\Contacts.xml"
        Public Sub New()
            InitializeComponent()
            grid.ItemsSource = GetDataFromXML()
        End Sub
        Private Function GetDataFromXML() As DataTable
            Dim ds As New DataSet()
            ds.ReadXml(path)
            Return ds.Tables(0)
        End Function
        Private Sub PostDataToXML()
            CType(grid.ItemsSource, DataTable).DataSet.WriteXml(path)
        End Sub

        Private Sub Button_Click(ByVal sender As Object, ByVal e As RoutedEventArgs)
            PostDataToXML()
            MessageBox.Show("Changes have been successfully saved to an XML file.", "Info")
        End Sub
    End Class

End Namespace

Window1.xaml.cs

using System.Windows;
using System.Data;

namespace DXGrid_BindingToXML {

    public partial class Window1 : Window {
        static string path = @"..\..\Contacts.xml";
        public Window1() {
            InitializeComponent();
            grid.ItemsSource = GetDataFromXML();
        }
        private DataTable GetDataFromXML() {
            DataSet ds = new DataSet();
            ds.ReadXml(path);
            return ds.Tables[0];
        }
        private void PostDataToXML() {
            ((DataTable)grid.ItemsSource).DataSet.WriteXml(path);
        }

        private void Button_Click(object sender, RoutedEventArgs e) {
            PostDataToXML();
            MessageBox.Show("Changes have been successfully saved to an XML file.", "Info");
        }
    }

}

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ItemsSource 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-allow-columns-to-fit-their-content-after-changing-or-modifying-gridcontrols-itemsource-e2042/CS/MainWindow.xaml#L16

</Grid.RowDefinitions>
<dxg:GridControl AutoGenerateColumns="AddNew" ItemsSource="{Binding List}" Name="gridControl1" >
    <mvvm:Interaction.Behaviors>

how-to-emulate-binding-to-the-isexpanded-property-of-the-treelistnode-t127638/CS/DevExpress.Example04/MainWindow.xaml#L25

</Grid.ColumnDefinitions>
<dxg:GridControl ItemsSource="{Binding Parents}" Grid.ColumnSpan="2">
    <mvvm:Interaction.Behaviors>

wpf-data-grid-bind-selected-rows-to-viewmodel-property/CS/GridMVVMSelection/MainWindow.xaml#L19

</Grid.RowDefinitions>
<dxg:GridControl ItemsSource="{Binding Source}" AutoGenerateColumns="AddNew" SelectionMode="Row" SelectedItems="{Binding Selection}" >
    <dxg:GridControl.View>

how-to-create-checkable-grouping-in-gridcontrol-t127563/CS/DevExpress.Example03/MainWindow.xaml#L14

<dxg:GridControl AutoGenerateColumns="AddNew"
                 ItemsSource="{Binding Employees}" x:Name="dxGrid"
                 EnableSmartColumnsGeneration="True">

how-to-get-visible-items-in-viewmodel-when-working-with-treelistview-e4152/VB/FilteredData/MainWindow.xaml#L26

</StackPanel>
<my:MyGridControl Grid.Row="1" AutoPopulateColumns="True" x:Name="gridControl1" ItemsSource="{Binding DataSource}" >
    <my:MyGridControl.View>

VB.NET

how-to-allow-columns-to-fit-their-content-after-changing-or-modifying-gridcontrols-itemsource-e2042/VB/GridControlFitBehavior.vb#L31

If Grid.ItemsSource IsNot Nothing Then
    SubscribeItemChanged(Grid.ItemsSource)

how-to-create-checkable-grouping-in-gridcontrol-t127563/VB/DevExpress.Example03/CheckableGroupBehavior.vb#L107

Dim items = TryCast(Me.AssociatedObject.ItemsSource, IEnumerable(Of Object))
If items IsNot Nothing Then

how-to-group-gridcontrol-by-multiple-values-the-multi-value-grouping-demo-v162-and-lower-t513354/VB/DXApplication3/Tasks.vb#L441

If IsCategoryGrouping Then
    fGrid.ItemsSource = fTasks
Else

how-to-implement-the-columnsquickcustomization-feature-in-the-dxgrid-e3007/VB/B197981ColumnsQuickCustomization/MainWindow.xaml.vb#L29

    Next i
    gridControl.ItemsSource = list
End Sub

how-to-show-images-in-a-column-filter-drop-down-window-e3941/VB/Default MVVM/FilterPopupConverter.vb#L43

Dim grid As GridControl = TryCast(value, GridControl)
Dim source As ObservableCollection(Of TestDataViewModel) = TryCast(grid.ItemsSource, ObservableCollection(Of TestDataViewModel))
source = GetUniqueValues(source)