How to: Bind the Grid to ICollectionView

• Jul 26, 2018
• 3 minutes to read

The example shows how to bind the Grid Control to the ICollectionView.

Use buttons to select an item in the collection. A checkbox specifies whether the grid’s currently selected item is synchronized with the collection.

XAML

<Page
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
    xmlns:local="using:ICollectionView_binding"
    xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
    xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
    xmlns:Grid="using:DevExpress.UI.Xaml.Grid"
    x:Class="ICollectionView_binding.MainPage"
    mc:Ignorable="d">
    <Grid>
        <Grid:GridControl Name="grid" AutoGenerateColumns="True" ShowFixedTotalSummary="True" ItemsSource="{Binding Data}" Margin="0,0,0,40" IsSynchronizedWithCurrentItem="{Binding ElementName=checkBox, Path=IsChecked}" >
            <Grid:GridControl.TotalSummary>
                <Grid:GridSummaryItem x:Name="item" SummaryType="Count" Alignment="Right" />
            </Grid:GridControl.TotalSummary>
        </Grid:GridControl>
        <Button VerticalAlignment="Bottom" HorizontalAlignment="Left" Content="Previous" Click="Button_Left" />
        <Button VerticalAlignment="Bottom" HorizontalAlignment="Right" Content="Next" Click="Button_Right" />
        <CheckBox VerticalAlignment="Bottom" HorizontalAlignment="Center" Content="IsSynchronizedWithCurrentItem" Name="checkBox" />
    </Grid>
</Page>

C#

using System.Collections;
using System.Collections.Generic;
using System.Linq;
using Windows.UI.Xaml;
using Windows.UI.Xaml.Controls;
using Windows.UI.Xaml.Data;

namespace ICollectionView_binding
{
    public sealed partial class MainPage : Page
    {
        DataModel grid_data = new DataModel();
        public MainPage()
        {
            this.DataContext = grid_data;
            this.InitializeComponent();

        }

        public class DataModel {
            public ICollectionView Data { get; set; }
            public DataModel() {
                Data = new CollectionViewSource {
                    Source = CreateList()
                }.View;
            }
        }

        public static IList CreateList() {
            List<TestData> list = new List<TestData>();
            for (int i = 0; i < 100; i++) {
                list.Add(new TestData() {
                    Number1 = i,
                    Number2 = i * 10,
                    Text1 = "row " + i,
                    Text2 = "ROW " + i
                });
            }
            return list;
        }
        public class TestData {
            public int Number1 { get; set; }
            public int Number2 { get; set; }
            public string Text1 { get; set; }
            public string Text2 { get; set; }
        }

        private void Button_Left(object sender, RoutedEventArgs e) {
            if (grid_data.Data.CurrentPosition == 0)
                grid_data.Data.MoveCurrentToLast();
            else
                grid_data.Data.MoveCurrentToPrevious();
        }

        private void Button_Right(object sender, RoutedEventArgs e) {
            if (grid_data.Data.CurrentItem == grid_data.Data.Last())
                grid_data.Data.MoveCurrentToFirst();
            else
                grid_data.Data.MoveCurrentToNext();
        }
    }
}

VB.NET

Public NotInheritable Class MainPage
    Inherits Page
    Private grid_data As New DataModel()
    Public Sub New()
        Me.DataContext = grid_data
        Me.InitializeComponent()

    End Sub

    Public Class DataModel
        Private privateData As ICollectionView
        Public Property Data() As ICollectionView
            Get
                Return privateData
            End Get
            Set(ByVal value As ICollectionView)
                privateData = value
            End Set
        End Property
        Public Sub New()
            Data = New CollectionViewSource() With {.Source = CreateList()}.View
        End Sub
    End Class

    Public Shared Function CreateList() As IList
        Dim list As New List(Of TestData)()
        For i As Integer = 0 To 99
            list.Add(New TestData() With {.Number1 = i, .Number2 = i * 10, .Text1 = "row " & i, .Text2 = "ROW " & i})
        Next i
        Return list
    End Function
    Public Class TestData
        Private privateNumber1 As Integer
        Public Property Number1() As Integer
            Get
                Return privateNumber1
            End Get
            Set(ByVal value As Integer)
                privateNumber1 = value
            End Set
        End Property
        Private privateNumber2 As Integer
        Public Property Number2() As Integer
            Get
                Return privateNumber2
            End Get
            Set(ByVal value As Integer)
                privateNumber2 = value
            End Set
        End Property
        Private privateText1 As String
        Public Property Text1() As String
            Get
                Return privateText1
            End Get
            Set(ByVal value As String)
                privateText1 = value
            End Set
        End Property
        Private privateText2 As String
        Public Property Text2() As String
            Get
                Return privateText2
            End Get
            Set(ByVal value As String)
                privateText2 = value
            End Set
        End Property
    End Class

    Private Sub Button_Left(ByVal sender As Object, ByVal e As RoutedEventArgs)
        If grid_data.Data.CurrentPosition = 0 Then
            grid_data.Data.MoveCurrentToLast()
        Else
            grid_data.Data.MoveCurrentToPrevious()
        End If
    End Sub

    Private Sub Button_Right(ByVal sender As Object, ByVal e As RoutedEventArgs)
        If grid_data.Data.CurrentItem Is grid_data.Data.Last() Then
            grid_data.Data.MoveCurrentToFirst()
        Else
            grid_data.Data.MoveCurrentToNext()
        End If
    End Sub
End Class