Xceed DataGrid for WPF

Extending the ContainsFilterCriterion

Marc [Xceed] — Thu, 25 Aug 2011 19:01:03 GMT

If you have a Column that is bound to a Business Object, and then you wish to display a property of that Object and want to filter the data on another property of that object, you might want to create your own custom object criterion. I have created a sample class that you can use in case you wish to filter on a string property of that object. We will extend the ContainsFilterCriterion since we are supplying the FilterCriterion with a string and looking for instances of that string in other string values.

We will then override the IsMatch(object value) method where we can choose which property of that object we wish to filter on. In this sample, we wish to search for instance of searchedValue in the ChildProperty property of the object of type Child.

-------
public class CustomObjectCriterion : ContainsFilterCriterion
    {
        public CustomObjectCriterion()
            : base()
        {
        }

        public CustomObjectCriterion(object value)
            : base(value)
        {
        }

        public override bool IsMatch(object value)
        {
            if (value == null)
                return false;

            if (this.Value == null)
                return true;

            string searchedValue = this.Value.ToString().ToLower();

            if (searchedValue.Length == 0)
                return true;

            string strValue = value.ToString().ToLower();

            return (value as Child).ChildProperty.Contains(searchedValue);
        }
    }

-------

Visual Basic.NET

-------

Public Class CustomObjectCriterion
    Inherits ContainsFilterCriterion
    Public Sub New()
        MyBase.New()
    End Sub

    Public Sub New(value As Object)
        MyBase.New(value)
    End Sub

    Public Overrides Function IsMatch(value As Object) As Boolean
        If value Is Nothing Then
            Return False
        End If

        If Me.Value Is Nothing Then
            Return True
        End If

        Dim searchedValue As String = Me.Value.ToString().ToLower()

        If searchedValue.Length = 0 Then
            Return True
        End If

        Dim strValue As String = value.ToString().ToLower()

        Return TryCast(value, Child).ChildProperty.Contains(searchedValue)
    End Function
End Class

-------

Emulate ASync call on QueryItemCount

Marc [Xceed] — Thu, 25 Aug 2011 18:49:47 GMT

In order to emulate an asynchronous call on the QueryItemCount event, you can do the following. When the Count is first called, we return 0 and also launch a count calculation on another thread. When that thread complete we "Refresh" the collection view that will then ask the count again and we then return the calculated value. On the following query count, the same thing will repeat again.

C#
---------------
void cv_QueryItemCount( object sender, QueryItemCountEventArgs e )
{
if( ( m_outOfSyncCount != -1 ) && ( m_outOfSyncCountInProgress ) )
{
m_outOfSyncCountInProgress = false;
e.Count = m_outOfSyncCount;
return;
}

if( !m_outOfSyncCountInProgress )
{
m_outOfSyncCountInProgress = true;
m_outOfSyncCount = -1;

// Launch count calculation on another thread that will at the end set
// m_outOfSyncCount and also call a m_cv.Refresh() on the UI thread.
}

e.Count = 0;
}

private DataGridVirtualizingCollectionView m_cv;
private bool m_outOfSyncCountInProgress;
private int m_outOfSyncCount;
---------------

Visual Basic.NET

---------------

Private Sub cv_QueryItemCount(sender As Object, e As QueryItemCountEventArgs)
    If (m_outOfSyncCount <> -1) AndAlso (m_outOfSyncCountInProgress) Then
        m_outOfSyncCountInProgress = False
        e.Count = m_outOfSyncCount
        Return
    End If

    If Not m_outOfSyncCountInProgress Then
        m_outOfSyncCountInProgress = True

            ' Launch count calculation on another thread that will at the end set
            ' m_outOfSyncCount and also call a m_cv.Refresh() on the UI thread.
        m_outOfSyncCount = -1
    End If

    e.Count = 0
End Sub

Private m_cv As DataGridVirtualizingCollectionView
Private m_outOfSyncCountInProgress As Boolean
Private m_outOfSyncCount As Integer

---------------

*Please NOTE: the code sample was written in C# originally and was translated to Visual Basic .NET using a Converter.

Using an ObservableCollection with the DataGridVirtualizingCollectionViewSource

Marc [Xceed] — Thu, 25 Aug 2011 18:43:24 GMT

I have prepared a sample that shows you how to hook up your ObservableCollection to your DataGridVirtualizingCollectionViewSource. This is as basic as it gets, but the main difference between the BindingList<T> and an ObservableCollection is that you will need to use the Skip() and Take() methods to get the range of values and copy them to the Object array. Please see the following:

---------
public partial class MainWindow : Window
{

ObservableCollection<DataObject> data = new
ObservableCollection<DataObject>();

public MainWindow()
{
InitializeComponent();
data.Add(new DataObject() { Name = "A", Value = 2 });
data.Add(new DataObject() { Name = "R", Value = 1 });
data.Add(new DataObject() { Name = "Q", Value = 5 });
data.Add(new DataObject() { Name = "S", Value = 2 });
data.Add(new DataObject() { Name = "M", Value = 2 });
}

private void DataGridVirtualizingCollectionViewSource_QueryItemCount(object sender, Xceed.Wpf.DataGrid.QueryItemCountEventArgs e)
{
e.Count = data.Count;
}

private void DataGridVirtualizingCollectionViewSource_QueryItems(object sender, Xceed.Wpf.DataGrid.QueryItemsEventArgs e)
{
ObservableCollection<DataObject> tempData = new ObservableCollection<DataObject>(data);

DataObject[] dataArray = tempData.Skip(e.AsyncQueryInfo.StartIndex).Take(e.AsyncQueryInfo.RequestedItemCount).ToArray();

e.AsyncQueryInfo.EndQuery(dataArray);
}

private ObservableCollection<DataObject> GetData(DataGridVirtualizingCollectionView dgvcv)
{
return new ObservableCollection<DataObject>(data);
}
}
---------

Visual Basic.NET

---------

Public Partial Class MainWindow
    Inherits Window

    Private data As New ObservableCollection(Of DataObject)()

    Public Sub New()
        InitializeComponent()
        data.Add(New DataObject() With { _
            Key .Name = "A", _
            Key .Value = 2 _
        })
        data.Add(New DataObject() With { _
            Key .Name = "R", _
            Key .Value = 1 _
        })
        data.Add(New DataObject() With { _
            Key .Name = "Q", _
            Key .Value = 5 _
        })
        data.Add(New DataObject() With { _
            Key .Name = "S", _
            Key .Value = 2 _
        })
        data.Add(New DataObject() With { _
            Key .Name = "M", _
            Key .Value = 2 _
        })
    End Sub

    Private Sub DataGridVirtualizingCollectionViewSource_QueryItemCount(sender As Object, e As Xceed.Wpf.DataGrid.QueryItemCountEventArgs)
        e.Count = data.Count
    End Sub

    Private Sub DataGridVirtualizingCollectionViewSource_QueryItems(sender As Object, e As Xceed.Wpf.DataGrid.QueryItemsEventArgs)
        Dim tempData As New ObservableCollection(Of DataObject)(data)

        Dim dataArray As DataObject() = tempData.Skip(e.AsyncQueryInfo.StartIndex).Take(e.AsyncQueryInfo.RequestedItemCount).ToArray()

        e.AsyncQueryInfo.EndQuery(dataArray)
    End Sub

    Private Function GetData(dgvcv As DataGridVirtualizingCollectionView) As ObservableCollection(Of DataObject)
        Return New ObservableCollection(Of DataObject)(data)
    End Function
End Class

---------

Fatal Execution Engine Error

Xceed admin — Thu, 25 Feb 2010 12:48:44 GMT

In some cases attempting to edit the XAML files in the Blueprint Edition causes Visual Studio 2008 to crash with the following event log:

.NET Runtime version 2.0.50727.3053 - Fatal Execution Engine Error (7A035E00) (80131506)

The following hotfix should resolve the issue, which is related to the WPF designer:

https://connect.microsoft.com/VisualStudio/Downloads/DownloadDetails.aspx?DownloadID=16827&wa=wsignin1.0

Retrieving a DataRow from a data item

Xceed admin — Mon, 04 Jan 2010 14:22:06 GMT

The following example demonstrates how to retrieve a DataRow (container) for a data item using the GetContainerFromItem method. It is important to remember that data rows are virtualized; therefore, references to them or their cells should never be kept.

C#

public Window1()
{
InitializeComponent();
DataGridControl grid = new DataGridControl();

DataGridCollectionView view = new DataGridCollectionView( App.Orders.DefaultView );
grid.ItemsSource = view;
// Subscribe to the PropertyChanged event to know when the CurrentItem property changes.
grid.PropertyChanged +=
        new System.ComponentModel.PropertyChangedEventHandler( grid_PropertyChanged );

this.Content = grid;
}

void grid_PropertyChanged( object sender, System.ComponentModel.PropertyChangedEventArgs e )
{
if( e.PropertyName == "CurrentItem" )
{
    // Retrieve the data-row container for the current item. Can be null if the data item
    // is not in the viewport.
    DataGridControl grid = sender as DataGridControl;

    Xceed.Wpf.DataGrid.DataRow row = grid.GetContainerFromItem( grid.CurrentItem ) as Xceed.Wpf.DataGrid.DataRow;
    // Change the background of the data row to pink. Data rows are recycled once they
    // exit the viewport; therefore, any modifications made to a data row will
    // be discarded once it is no longer in the viewport.
    row.Background = Brushes.Pink;
}
}

VB.NET

Public Sub New()
InitializeComponent()

Dim grid As New DataGridControl()
Dim view As New DataGridCollectionView( App.Orders.DefaultView )

grid.ItemsSource = view

' Subscribe to the PropertyChanged event to know when the CurrentItem property changes.
AddHandler grid.PropertyChanged, AddressOf grid_PropertyChanged

Me.Content = grid
End Sub

Private Sub grid_PropertyChanged( ByVal sender As Object, _
                                 ByVal e As System.ComponentModel.PropertyChangedEventArgs )
If e.PropertyName = "CurrentItem" Then
    ' Retrieve the data-row container for the current item. Can be Nothing if the data item
    ' is not in the viewport.
    Dim grid As DataGridControl = CType( sender, DataGridControl )

    Dim row As Xceed.Wpf.DataGrid.DataRow = TryCast( grid.GetContainerFromItem( grid.CurrentItem ), Xceed.Wpf.DataGrid.DataRow )
    ' Change the background of the data row to pink. Data rows are recycled once they
    ' exit the viewport; therefore, any modifications made to a data row will
    ' be discarded once it is no longer in the viewport.
    row.Background = Brushes.Pink
End If
End Sub

Insufficient memory to continue the execution of the program (Zombie exception).

Xceed admin — Mon, 19 Oct 2009 15:10:52 GMT

This is a known issue that was introduced in the .NET Framework when 3.5 SP1 was released. Microsoft has provided a hotfix, which can be downloaded here: http://support.microsoft.com/kb/967634

Warning of dependency on System.Data.Entity assembly when building against Client Profile

Xceed admin — Tue, 11 Aug 2009 16:13:51 GMT

When compiling the grid against the Client Profile, the following warning may occur:

The referenced assembly "Xceed.Wpf.DataGrid, Version=3.2.9329.11090, Culture=neutral, PublicKeyToken=ba83ff368b7563c6, processorArchitecture=MSIL" has a dependency on "System.Data.Entity, Version=3.5.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" which is not listed as part of the "Client" TargetFrameworkSubset. If this dependent reference is required, you may get compilation errors.

This is a known warning that will have no impact on your code and will not cause any issues when distributing your application to a machine where only the Client Profile is installed.

Why are bindings failing in the print PageHeaders/Footers?

Xceed admin — Thu, 30 Jul 2009 14:11:43 GMT

Because of a limitation with the way that the printing works, the PageControl hosting the PageHeaders, PageFooters, and printed grid host do not have automatic access to ancestors.

The PageControl is not hosted in the same container (e.g., Window or Page) that is hosting the DataGridControl. It is in a separate VisualTree at the Application scope; therefore, FindAncestor bindings will not work since the PageControl can only access properties and resources set directly on the Application level (i.e., in the app class or App.xaml).

A workaround that we implemented was to set the PageControl's DataContext to your DataGridControl's DataContext, which means that, if your DataGridControl's DataContext is the instance of the Window hosting it, then the PageControl will be able to access the Window's properties through a relative-source binding. For example:

Binding RelativeSource={RelativeSource AncestorType={x:Type xcdg:PrintVirtualizingStackPanel}}, Path=DataContext....

The FindAncestor binding or ElementName binding still won't work since setting the DataContext does not change the fact that the PageControl is being hosted at the scope of your application and does not have access to the visual tree of your DataGridControl.

Statistical functions not being updated when bound to an ObservableCollection

Xceed admin — Thu, 05 Mar 2009 18:42:03 GMT

An ObservableCollection provides notifications when its collection of items changes (i.e., items are added or removed) and not when the values of these items is changed. Even if the items contained in the ObservableCollection implement INotifyPropertyChanged, an ObservableCollection does not "listen" to these events. A BindingList will provide notifications when new items are added or existing items are removed (INotifyCollectionChanged) and will also provide notifications when existing items are modified as long as the item type implements INotifyPropertyChanged.

If the grid is bound to an ObservableCollection and modifications are made directly to the items in the underlying collection (not through the grid), the changes will not be reflected in the grid. As a result, statistical functions will not be updated. Using a BindingList resolves this issue.

In both cases, if the grid is bound through a DataGridCollectionView or DataGridCollectionViewSource and modifications are made through the grid, changes will be reflected immediately, regardless of the underlying data source type.

How to do row-level validation.

Xceed admin — Tue, 10 Feb 2009 15:31:00 GMT

To implement row-level validation you could handle the EditEnding event on the DataRow class. Since the sender of this event is a DataRow object, you will have access to the entire row to provide the desired validation. For example:

In code-behind:

private void EditEndingHandler( object sender, RoutedEventArgs e )
{
   Xceed.Wpf.DataGrid.DataRow row = sender as Xceed.Wpf.DataGrid.DataRow;

   if( row != null )
   {
      // do your validation here
   }
}

Does Xceed DataGrid for WPF support QTP automation?

Xceed admin — Thu, 05 Feb 2009 17:58:23 GMT

Yes. As of version 3.1, the Professional Edition of Xceed DataGrid for WPF support UI automation.

How can I disable UI virtualization?

Xceed admin — Thu, 05 Feb 2009 14:55:53 GMT

UI virtualization can be disabled by creating an implicit style that targets TableViewScrollViewer and that sets the CanContentScroll property to false.

In this case, it is also recommended to activate immediate scrolling by setting the grid's ItemScrollingBehavior property to Immediate.

<xcdg:DataGridControl ItemScrollingBehavior="Immediate"/>

Note that to disable UI virtualization in card view, the style should target CardViewScrollViewer rather than TableViewScrollViewer.

Grid double-click event

Xceed admin — Tue, 03 Feb 2009 14:30:38 GMT

You could create an implicit style on the DataRow to catch the PreviewMouseDoubleClick with an event setter :

<Style TargetType="{x:Type xcdg:DataRow}" >
<EventSetter Event="PreviewMouseDoubleClick" Handler="DataRow_PreviewMouseDoubleClick" />
</Style>

private void DataRow_PreviewMouseDoubleClick( object sender, MouseButtonEventArgs e )
{
// Your code here
}

First row highlighted in version 3.1

Xceed admin — Tue, 27 Jan 2009 15:31:35 GMT

In version 3.1, the current item is synchronized with the current item in the collection view, which is why the first item is now highlighted by default. The fact that it was not highlighted in version 3.0 was considered a bug. What you can do if you do not want the selection color is to create an implicit style that targets DataRow and that has a setter that sets the SelectionBackground color to null or transparent.

How can I be notified when the selected items change?

Xceed admin — Wed, 22 Oct 2008 20:22:49 GMT

The SelectedItem and SelectedIndex properties are dependency properties for which value-changed handlers can be created in order to be notified when their value changes. For example:

DependencyPropertyDescriptor selectedItemDescriptor = DependencyPropertyDescriptor.FromProperty( DataGridControl.SelectedItemProperty, typeof( DataGridControl ) );

selectedItemDescriptor.AddValueChanged( this.EmployeesGrid, this.SelectedItemChanged );

The SelectedItems property is also a dependency property; however, using a value-changed handler will not function in this case since the values of the collection are modified and not the collection itself. Although the SelectedItems property is exposed as an IList it is actually an ObservableCollection; therefore, in order to be notified when its content (i.e., the items that are selected) changes, it can be cast as an INotifyCollectionChanged and subscribe to its CollectionChanged event. For example:

( ( INotifyCollectionChanged )this.EmployeesGrid.SelectedItems ).CollectionChanged += new NotifyCollectionChangedEventHandler( Window1_CollectionChanged );

Auto-complete ComboBox cell editor

Xceed admin — Fri, 10 Oct 2008 13:41:43 GMT

This sample demonstrates how to create an auto-complete ComboBox cell editor that is bound to the DistinctValues of the corresponding cell's DataGridContext. This sample requires that automatic filtering, which is available only in the Professional Edition of Xceed DataGrid for WPF, be enabled.

How to retrieve the DataRows in their sorted order

Xceed admin — Thu, 09 Oct 2008 17:26:03 GMT

A list of all the DataRows contained within the grid can be retrieved using the grid's collection of DataRows; however, the list returned will contain the DataRows in the order that they are found in the data source. If you want to retrieve the DataRows in the order that they are sorted in the grid, then you will need to use the grid's GetSortedDataRows method.

The GetSortedDataRows method also allows you to retrieve the DataRows recursively depending on the value of its recursive parameter. If the grid does not contain any groups, then setting the recursive parameter to true or false will have the same result: all the DataRows will be retrieved. If the grid contains groups, then setting the recursive parameter to false will result in no DataRows being returned since the DataRows are contained within the groups. Setting the recursive parameter to true (in the case where the grid contains groups) will result in all the DataRows being returned.

It is also possible to retrieve the DataRows of a specific group using the group's GetSortedDataRows method.

The following example demonstrates how to retrieve a list of all the DataRows in the grid in the order that they are sorted. Because we are setting the recursive parameter of the GetSortedDataRows method to true, all DataRows, event those contained within groups, will be retrieved.

VB.NET

Dim rows As Xceed.Grid.Collections.ReadOnlyDataRowList = GridControl1.GetSortedDataRows( True )
Dim row As Xceed.Grid.DataRow

For Each row in rows
ListBox1.Items.Add( "Row #" + row.Index.ToString() + " : sort position " + _
                      rows.IndexOf( row ).ToString() )
Next row

C#

Xceed.Grid.Collections.ReadOnlyDataRowList rows = gridControl1.GetSortedDataRows( true );

foreach( Xceed.Grid.DataRow row in rows )
{
listBox1.Items.Add( "Row #" + row.Index.ToString() + " : sort position " +
                      rows.IndexOf( row ).ToString() );
}

How to iterate through the grid's rows

Xceed admin — Thu, 09 Oct 2008 17:25:43 GMT

There is no direct way you can iterate through all the rows in the grid in a sequential manner. In order to iterate through all of the grid's rows, you will need to go through each collection of rows.

Collection	Description
GridControl.FixedHeaderRows	A list of all the fixed header rows of the grid. The fixed header rows are the rows found in the non-scrollable header section of the grid. This section will not scroll with the grid body.
GridControl.HeaderRows	A list of all the non-fixed header rows of the grid. The header rows are the rows found in the header section of the grid, before the data rows and groups, and that scroll with the grid body.
Group.HeaderRows	A list of all the header rows of the group. The header rows are the rows found in the header section of the group, before the data rows.
Group.GetSortedDatarows	A collection of sorted data rows.
Group.FooterRows	A list of all the footer rows of the group. The footer rows are the rows found in the footer section of the group, after the data rows.
GridControl.DataRows	A list of all the data rows in the grid.
GridControl.FooterRows	A list of all the non-fixed footer rows of the grid. The footer rows are the rows found in the footer section of the grid, after the data rows and groups, and that scroll with the grid body.
GridControl.FixedFooterRows	A list of all the fixed footer rows of the grid. The fixed footer rows are the rows found in the non-scrollable footer section of the grid. This section will not scroll with the grid body.
GridControl.GetSortedDataRows	A list of all the data rows in the grid, in their sorted order.

The GetSortedDataRows methods of either the grid or a group will return a collection containing the DataRows in the order that they are sorted. If a group contains child groups, it will not have any immediate child DataRows.

The following example demonstrates how to iterate through all the rows found in the grid and display information about each in a listbox.

VB.NET

Dim row As Row

For Each row In GridControl1.FixedHeaderRows
   ListBox1.Items.Add( "FixedHeaderRows : " + row.GetType().ToString() )
Next row

For Each row In GridControl1.HeaderRows
   ListBox1.Items.Add( "HeaderRows : " + row.GetType().ToString() )
Next row

If GridControl1.Groups.Count > 0 Then
   Dim group As Group

   For Each group In GridControl1.Groups
      Me.ListDataRows( group )
   Next group
Else ' There are no groups so we will simply list the DataRows
   For Each row In GridControl1.DataRows
      ListBox1.Items.Add( "DataRows : " + row.GetType().ToString() )
   Next row
End If

For Each row In GridControl1.FooterRows
   ListBox1.Items.Ad

How to commit modifications to a DataRow

Xceed admin — Thu, 09 Oct 2008 17:16:41 GMT

In order for the modifications to be committed (to the DataRow not the datasource) the DataRow's EndEdit method must be called. This method is automatically called when you click on another row. If you want the modifications to be made when you click on a button for example, you can manually call EndEdit. If the value entered is valid, it will be committed, if it was not, the EndEdit method will throw. You can handle the DataRowTemplate's ValidationError to prevent the DataRow from leaving edit mode in this case, otherwise the value will not be committed and the row will exit edit mode. If you do not want the changes to be committed in the case where the user presses the button but EndEdit has not been called, then use the CancelEdit method instead.

Deleting selected items

Xceed admin — Thu, 09 Oct 2008 13:54:24 GMT

The following example demonstrates how to delete the selected items from the underlying data view when the delete key is pressed via the PreviewKeyDown event.

VB.NET

Private Sub DeleteSelectedRows(ByVal sender As Object, ByVal e As KeyEventArgs)
Dim grid As DataGridControl = TryCast( sender, DataGridControl )

If Not grid Is Nothing Then
    If e.Key = Key.Delete Then
      If grid.SelectedItems.Count > 0 Then
        ' we keep a copy of the selected items because once the first item is deleted,
        ' the selected items are reset to 0.
        Dim items As ArrayList = New ArrayList( grid.SelectedItems )
        Dim dataView As DataView = TryCast( ( CType( grid.ItemsSource, _
                       DataGridCollectionView ) ).SourceCollection, DataView )
        For i As Integer = items.Count - 1 To 0 Step -1
          dataView.Table.Rows.Remove( CType( items( i ), System.Data.DataRow ) )
        Next i
        grid.CurrentItem = grid.Items( 0 )
      End If
    End If
End If
End Sub

C#

private void DeleteSelectedRows( object sender, KeyEventArgs e )
{
DataGridControl grid = sender as DataGridControl;

if( grid != null )
{
   if( e.Key == Key.Delete )
   {
     if( grid.SelectedItems.Count > 0 )
     {
       // we keep a copy of the selected items because once the first item is deleted,
       // the selected items are reset to 0 and the source may be automatically modified to
       // reflect the new items.
       ArrayList items = new ArrayList( grid.SelectedItems );
       DataView dataView = ( ( DataGridCollectionView )grid.ItemsSource ).SourceCollection as DataView;
       for( int i = items.Count - 1; i >= 0; i-- )
       {
         dataView.Table.Rows.Remove( ( System.Data.DataRow )items[ i ] );
       }
       grid.CurrentItem = grid.Items[ 0 ];
     }
   }
}
}

Retrieving a parent group

Xceed admin — Thu, 09 Oct 2008 13:54:08 GMT

The following example demonstrates how to retrieve the parent group of the current item using the GetParentGroupFromItem method so that it can be collapsed. The implementation for the CollapseCurrentGroup method is provided below.

The following provides the implementation for the CollapseCurrentGroup method.

VB.NET

Private Sub CollapseCurrentGroup( ByVal sender As Object, ByVal e As RoutedEventArgs )
Dim context As DataGridContext = Me.OrdersGrid.CurrentContext
Dim group As CollectionViewGroup = context.GetParentGroupFromItem( context.CurrentItem )

context.CollapseGroup( group )
End Sub

C#

private void CollapseCurrentGroup( object sender, RoutedEventArgs e )
{
DataGridContext context = this.OrdersGrid.CurrentContext;
CollectionViewGroup group = context.GetParentGroupFromItem( context.CurrentItem );
context.CollapseGroup( group );
}

Subscribing to the events of an element

Xceed admin — Thu, 09 Oct 2008 13:53:17 GMT

The following example demonstrates how to subscribe the MouseEnter and MouseLeave events of each DataRow using EventTriggers in an implicit style. The MouseEnter and MouseLeave event handlers are provided below.

The following code provides the implementation of the MouseEnter and MouseLeave event handlers, which change the background color of a DataRow when the mouse enters and resets it when the mouse leaves.

VB.NET

Private Sub DataRowMouseEnter(ByVal sender As Object, ByVal e As MouseEventArgs)
Dim row As Xceed.Wpf.DataGrid.DataRow = TryCast(sender, Xceed.Wpf.DataGrid.DataRow)

If Not row Is Nothing Then
    row.Background = Brushes.Pink
End If
End Sub

Private Sub DataRowMouseLeave(ByVal sender As Object, ByVal e As MouseEventArgs)
Dim row As Xceed.Wpf.DataGrid.DataRow = TryCast(sender, Xceed.Wpf.DataGrid.DataRow)

If Not row Is Nothing Then
    row.Background = DataGridControl.GetParentDataGridControl( row ).Background
End If
End Sub

C#

private void DataRowMouseEnter( object sender, MouseEventArgs e )
{
Xceed.Wpf.DataGrid.DataRow row = sender as Xceed.Wpf.DataGrid.DataRow;

if( row != null )
{
    row.Background = Brushes.Pink;
}
}

private void DataRowMouseLeave( object sender, MouseEventArgs e )
{
Xceed.Wpf.DataGrid.DataRow row = sender as Xceed.Wpf.DataGrid.DataRow;

if( row != null )
{
    row.Background = DataGridControl.GetParentDataGridControl( row ).Background;
}
}

Handling collection-changed events

Xceed admin — Thu, 09 Oct 2008 13:42:07 GMT

The following example demonstrates how to subscribe to the CollectionChanged event of the DataGridCollectionView.SortDescriptions collection's INotifyCollectionChanged interface implementation to be notified when sorting applied to a grid's columns changes.

VB.NET

Protected Overrides Sub OnInitialized(ByVal e As EventArgs)
MyBase.OnInitialized(e)

Dim view As DataGridCollectionView = TryCast(Me.OrdersGrid.ItemsSource, DataGridCollectionView)
AddHandler (CType(view.SortDescriptions, INotifyCollectionChanged)).CollectionChanged, AddressOf SortCollectionChanged
End Sub

Private Sub SortCollectionChanged(ByVal sender As Object, ByVal e As NotifyCollectionChangedEventArgs)
Debug.WriteLine("Sort changed")
End Sub

C#

protected override void OnInitialized( EventArgs e )
{
base.OnInitialized( e );

DataGridCollectionView view = this.OrdersGrid.ItemsSource as DataGridCollectionView;
( ( INotifyCollectionChanged )view.SortDescriptions ).CollectionChanged += new NotifyCollectionChangedEventHandler( this.SortCollectionChanged );
}

private void SortCollectionChanged( object sender, NotifyCollectionChangedEventArgs e )
{
Debug.WriteLine( "Sort changed" );
}

Creating a value-changed handler

Xceed admin — Thu, 09 Oct 2008 13:39:08 GMT

The following example demonstrates how to create a DependencyPropertyDescriptor for the ItemsSource property that will provide a value-changed handler so that we can be notified when the value of the ItemsSource property is changed.

The value of the ItemsSource property is changed to the Employees table when the button located above the grid is clicked.

The DependencyPropertyDescriptor for the ItemsSource property is defined in the OnInitialized override and will call the OnDataGridItemsSourceChanged method when the ItemsSource property has been changed. The ChangeDataSource method will be called by the button to change the ItemsSource property.

VB.NET

Protected Overrides Sub OnInitialized( ByVal e As EventArgs )
MyBase.OnInitialized( e )

Dim gridItemsSourceDescriptor As DependencyPropertyDescriptor = DependencyPropertyDescriptor.FromProperty( DataGridControl.ItemsSourceProperty, GetType( DataGridControl ) )
gridItemsSourceDescriptor.AddValueChanged( Me.OrdersGrid, New EventHandler( AddressOf OnDataGridItemsSourceChanged ) )
End Sub

Protected Sub OnDataGridItemsSourceChanged( ByVal sender As Object, ByVal args As EventArgs )
' Before assigning the ItemsSource, UpdateLayout must be called to ensure that the
' DataGridControl's template is created and sized correctly in the page or window.
Me.OrdersGrid.UpdateLayout()

Dim column As Column
For Each column In Me.OrdersGrid.Columns
    Dim width As Double = column.GetFittedWidth()
    If width > -1 Then
      column.Width = width
    End IF
Next column
End Sub

Private Sub ChangeDataSource( ByVal sender As object, ByVal e As RoutedEventArgs )
Me.OrdersGrid.Columns.Clear()
Me.OrdersGrid.ItemsSource = Nothing
Me.OrdersGrid.ItemsSource = New DataGridCollectionView( App.Employees.DefaultView )
End Sub

C#

protected override void OnInitialized( EventArgs e )
{
base.OnInitialized( e );
  DependencyPropertyDescriptor gridItemsSourceDescriptor = DependencyPropertyDescriptor.FromProperty( DataGridControl.ItemsSourceProperty, typeof( DataGridControl ) );
  gridItemsSourceDescriptor.AddValueChanged( this.OrdersGrid, OnDataGridItemsSourceChanged );
}

protected void OnDataGridItemsSourceChanged( object sender, EventArgs args )
{
// Before assigning the ItemsSource, UpdateLayout must be called to ensure that the
// DataGridControl's template is created and sized correctly in the page or window.
this.OrdersGrid.UpdateLayout();

foreach( Column column in this.OrdersGrid.Columns )
{
    double width = column.GetFittedWidth();
    if( width > -1 )
    {
      column.Width = width;
    }
}
}

private void ChangeDataSource( object sender, RoutedEventArgs e )

Providing a cell-content template

Xceed admin — Thu, 09 Oct 2008 13:36:01 GMT

The following example demonstrates how to provide a new CellContentTemplate, using property element syntax, for a boolean column that displays a check mark when the cell's value is true, and an "x" when it is false.

Formatting a cell's content

Xceed admin — Thu, 09 Oct 2008 13:35:46 GMT

The following example demonstrates how to format a cell's content to display a numeric value as a currency value. Although it might be tempting to apply the converter to a column's DisplayMemberBindingInfo, this is not the recommended location as not only will the cells' content be formatted but the data type of the cells' content will be changed to the converter's.

Providing a data-row template

Xceed admin — Thu, 09 Oct 2008 13:34:28 GMT

The following example demonstrates how to provide, through a style, a new ControlTemplate for DataRow objects. The columns that are contained in the grid will be limited to those specified in the ItemProperties of the DataGridCollectionViewSource.

<Grid>
<Grid.Resources>
   <xcdg:DataGridCollectionViewSource x:Key="cvs_employees"
                                      Source="{Binding Source={x:Static Application.Current}, Path=Employees}"
                                      AutoCreateItemProperties="False">

     <xcdg:DataGridCollectionViewSource.ItemProperties>
       <xcdg:DataGridItemProperty Name="LastName"/>
       <xcdg:DataGridItemProperty Name="FirstName"/>
       <xcdg:DataGridItemProperty Name="Photo"/>
       <xcdg:DataGridItemProperty Name="Title"/>
       <xcdg:DataGridItemProperty Name="Notes"/>
       <xcdg:DataGridItemProperty Name="EmployeeID"/>
       <xcdg:DataGridItemProperty Name="TitleOfCourtesy"/>
       <xcdg:DataGridItemProperty Name="HireDate"/>
       <xcdg:DataGridItemProperty Name="Extension"/>
     </xcdg:DataGridCollectionViewSource.ItemProperties>
   </xcdg:DataGridCollectionViewSource>

   <ControlTemplate x:Key="titleLessCell"
                    TargetType="xcdg:DataCell">
     <ContentPresenter Content="{xcdg:CellContentBinding}"
                       ContentTemplate="{TemplateBinding ContentTemplate}"
                       ContentTemplateSelector="{TemplateBinding ContentTemplateSelector}"/>
   </ControlTemplate>

   <Style x:Key="customCardViewDataRow"
          TargetType="{x:Type xcdg:DataRow}">
     <Setter Property="Background"
             Value="Transparent"/>
     <Setter Property="Template">
       <Setter.Value>
         <ControlTemplate TargetType="{x:Type xcdg:DataRow}">
           <Border x:Name="PART_RowFocusRoot"
                   Background="{TemplateBinding Background}"
                   BorderBrush="{TemplateBinding BorderBrush}"
                   BorderThickness="{TemplateBinding BorderThickness}"
                   Padding="{TemplateBinding Padding}">
             <Grid>
               <StackPanel>
                 <DockPanel>
                   
                   <Grid DockPanel.Dock="Left"
                         Margin="3,4,2,2"
                         MaxWidth="85"
                         MaxHeight="85">
                     <xcdg:DataCell FieldName="Photo"
                                     Template="{StaticResource titleLessCell}"/>
                   </Grid>
                   <StackPanel Margin="8,0,0,0">
                     <StackPanel Orientation="Horizontal">
                       <xcdg:DataCell FieldName="TitleOfCourtesy"
                                      FontSize="16"
                                      Template="{StaticResource titleLessCell}"/>
                       <TextBlock Text=" "/>
                       <xcdg:DataCell FieldName="FirstName"
                                      FontSize="16"
                                      Template="{StaticResource titleLessCell}"/>
                       <TextBlock Text=" "/>
                       <xcdg:DataCell FieldName="LastName"
                                      FontSize="16"
                                      Template="{StaticResource titleLessCell}"/>
                     </StackPanel>
                      <xcdg:DataCell Field

Providing an insertion-row template

Xceed admin — Thu, 09 Oct 2008 13:34:15 GMT

The following example demonstrates how to provide, through a style, a new InsertionRow template. In order to preserve the fixed-column splitter in the insertion row, we need to use a FixedCellPanel as the "PART_CellsHost" template part.

Providing a data-cell template

Xceed admin — Thu, 09 Oct 2008 13:31:57 GMT

The following example demonstrates how to provide, through a style, a new ControlTemplate for the DataCells that will display the cells as buttons.

Providing a group-header control template

Xceed admin — Thu, 09 Oct 2008 13:27:54 GMT

The following example demonstrates how to provide, through a style, a new GroupHeaderControl template.

Applying a card background brush

Xceed admin — Thu, 09 Oct 2008 13:15:22 GMT

The following example demonstrates how to apply one of the custom background brushes (provided by Xceed) cards (i.e., data rows) by creating an implicit style that targets DataRow and that sets the background property.

    <xcdg:DataGridControl x:Name="ProductsGrid"
                          ItemsSource="{Binding Source={StaticResource cvs_products}}">

       <xcdg:DataGridControl.Columns>
          <xcdg:Column FieldName="ProductName"
                       IsMainColumn="True"/>
       </xcdg:DataGridControl.Columns>

       <xcdg:DataGridControl.View>
          <xcdg:CardflowView3D CardHeightToViewportRatio="0.5">
             <xcdg:CardflowView3D.Theme>
                <xcdg:ChameleonTheme/>
             </xcdg:CardflowView3D.Theme>
          </xcdg:CardflowView3D>
       </xcdg:DataGridControl.View>
    </xcdg:DataGridControl>
</Grid>

Centering column titles

Xceed admin — Thu, 09 Oct 2008 13:15:05 GMT

The following example demonstrates how to center the column titles that are displayed as the content of the corresponding column-manager cells by creating an implicit style that targets the ColumnManagerCell data type and that sets the HorizontalContentAlignment and VerticalContentAlignment properties to Center.

Changing the no-group content

Xceed admin — Thu, 09 Oct 2008 13:13:56 GMT

The following example demonstrates how to provide an implicit style targeting the HierarchicalGroupByControl class that changes the value of the NoGroupContent property to display "Hello World" rather than "Drag a column header hear to group by that column.".

Providing a detail configuration item-container style

Xceed admin — Thu, 09 Oct 2008 13:12:24 GMT

The following example demonstrates how to provide an item-container style for the Employee_Orders data relation.

Hiding the row-selector pane

Xceed admin — Thu, 09 Oct 2008 13:12:07 GMT

Styling row selectors

Xceed admin — Thu, 09 Oct 2008 13:11:49 GMT

The following example demonstrates how to display a row's visual index in its corresponding row selector by creating a style targeting the RowSelector type that displays the value of its ItemIndex property as its content. The style is then assigned to the RowSelector.RowSelectorStyle attached property, which is set by the implicit DataRow style.

Forcing items in the fixed headers to occupy all the available width

Xceed admin — Thu, 09 Oct 2008 13:10:58 GMT

The following example demonstrates how to force the GroupByControl and ColumnManagerRow contained in a grid's fixed header section to occupy all the available width.

By default, items in the fixed header and footer sections will only span across the width occupied by the columns.

Changing the background color of a data row

Xceed admin — Thu, 09 Oct 2008 13:09:08 GMT

The following example demonstrates how to changed the background color of a DataRow according to the value of one of its cells using DataTriggers.

Styling a fixed-column splitter

Xceed admin — Thu, 09 Oct 2008 13:08:22 GMT

The following example demonstrates how to change the style of the data rows' fixed-column splitter.

Alternating data-row styles

Xceed admin — Thu, 09 Oct 2008 13:07:26 GMT

The following example demonstrates how to alternate the appearance of data row styles using the IndexToOddConverter.

<xcdg:DataGridControl x:Name="OrdersGrid"
ItemsSource="{Binding Source={StaticResource cvs_orders}}">
</xcdg:DataGridControl>
</Grid>

Styling data cells

Xceed admin — Thu, 09 Oct 2008 13:06:33 GMT

The following example demonstrates how to change the foreground and background of the current cell.

Preventing scrollbars from being displayed

Xceed admin — Thu, 09 Oct 2008 13:03:36 GMT

The following example demonstrates how to prevent scroll bars from being displayed by providing an implicit style for the TableViewScrollViewer that sets the HorizontalScollBarVisibility and VerticalScrollBarVisibility properties to Hidden.

Displaying a scroll tip

Xceed admin — Thu, 09 Oct 2008 13:02:37 GMT

The following example demonstrates how to display a scroll tip whose content and location have been modified.

The "flagConverter" resource represents a converter that is used to return the appropriate BitmapImage according to the value of the ShipCountry cell.

Displaying tooltips

Xceed admin — Thu, 09 Oct 2008 13:02:24 GMT

The following example demonstrates how to display the entire content of a cell in a tool tip.

Providing a simple cell editor

Xceed admin — Thu, 09 Oct 2008 13:01:00 GMT

The following examples demonstrates how to change the edit template of the cell editor for the ShipVia column to a Slider control.

Providing a complex cell editor

Xceed admin — Thu, 09 Oct 2008 13:00:48 GMT

The following example demonstrates how to change the edit template of the cell editor for the Freight column to a custom calculator control. The C# code for the Calculate method called in the buttons' Click event simply calculates the new equation and is not provided. To shorten the code, some of the Button and KeyActivationGesture declarations have been removed.

Providing a default cell editor

Xceed admin — Thu, 09 Oct 2008 13:00:35 GMT

The following example demonstrates how to provide a default cell editor for columns that have an Int32 data type.

Changing a title-region position

Xceed admin — Thu, 09 Oct 2008 12:35:49 GMT

The following example demonstrates how to change the position of the title-surface configuration's title region.

Giving the root element of the Viewbox an arbitrary width
                                     will correct this undesirable behavior. This size of 125 was
                                     determined by trial and error using our data source and it may
                                     be appropriate to change it according to the data. -->
                                <Grid Width="125">
                                   
                                   <Grid.ColumnDefinitions>
                                      <ColumnDefinition Width="*"/>
                                      <ColumnDefinition Width="Auto"/>
                                      <ColumnDefinition Width="*"/>
                                   </Grid.ColumnDefinitions>

Setting a multi-surface theme

Xceed admin — Thu, 09 Oct 2008 12:35:17 GMT

The following example demonstrates how to set a multi-surface theme using property element syntax.

Defining region configurations

Xceed admin — Thu, 09 Oct 2008 12:34:50 GMT

The following example demonstrates how to define default and explicit region configurations.

<Grid xmlns:xcdg="http://schemas.xceed.com/wpf/xaml/datagrid">
<Grid.Resources>
     <xcdg:DataGridCollectionViewSource x:Key="cvs_employees"
                                     Source="{Binding Source={x:Static Application.Current}, Path=EmployeesTable}"
                                        AutoCreateItemProperties="False">
        <xcdg:DataGridCollectionViewSource.ItemProperties>
           
           <xcdg:DataGridItemProperty Name="Title"/>
           <xcdg:DataGridItemProperty Name="FirstName"/>
           <xcdg:DataGridItemProperty Name="LastName"/>
           <xcdg:DataGridItemProperty Name="TitleOfCourtesy"/>

           
           <xcdg:DataGridItemProperty Name="Photo"/>

           
           <xcdg:DataGridItemProperty Name="EmployeeID"
                                      Title="Employee Identification #"/>
           <xcdg:DataGridItemProperty Name="Address"/>
           <xcdg:DataGridItemProperty Name="City"/>
           <xcdg:DataGridItemProperty Name="Country"/>
           <xcdg:DataGridItemProperty Name="PostalCode"
                                      Title="Postal Code"/>
           <xcdg:DataGridItemProperty Name="HomePhone"
                                      Title="Home Phone Number"/>
           <xcdg:DataGridItemProperty Name="BirthDate"
                                      Title="Date of Birth"/>
        </xcdg:DataGridCollectionViewSource.ItemProperties>
     </xcdg:DataGridCollectionViewSource>
    </Grid.Resources>

    <xcdg:DataGridControl x:Name="EmployeesGrid"
                          ItemsSource="{Binding Source={StaticResource cvs_employees}}">
     <xcdg:DataGridControl.View>
        <xcdg:CardflowView3D>
           <xcdg:CardflowView3D.Theme>
              <xcdg:ElementalBlackTheme>
                
                <xcdg:ElementalBlackTheme.DefaultTitleRegionConfiguration>
                   <xcdg:RegionConfiguration FieldNames="TitleOfCourtesy, FirstName, LastName, Title"
                                             ReadOnly="True">
                      <xcdg:RegionConfiguration.Template>
                         <DataTemplate>
                            <Viewbox>
                               <StackPanel>
                                  <StackPanel Orientation="Horizontal"
                                              HorizontalAlignment="Center">
                                     <StackPanel.Resources>
                                        <Style TargetType="{x:Type xcdg:DataCell}">
                                           <Setter Property="Margin"
                                                   Value="0, 0, 3, 0"/>
                                        </Style>
                                     &

Providing a default region configuration

Xceed admin — Thu, 09 Oct 2008 12:34:15 GMT

The following example demonstrates how to provide a default title-region configuration that will be used by all surfaces that display a title.

Providing new gradient colors

Xceed admin — Thu, 09 Oct 2008 12:32:42 GMT

The following example demonstrates how to change the gradient applied to the card surfaces when using the Chameleon theme.

Stretching columns

Xceed admin — Wed, 08 Oct 2008 20:27:14 GMT

The following example demonstrates how to stretch all the columns in a grid equally so that they occupy the full width available in the viewport.

Using routed view properties

Xceed admin — Wed, 08 Oct 2008 20:26:17 GMT

The following example demonstrates how to set routed view properties on detail configurations to change the width of their detail indicators as well as to fix columns and remove the fixed-column splitter.

Allowing horizontal scrolling

Xceed admin — Wed, 08 Oct 2008 20:26:02 GMT

The following example demonstrates how to prevent horizontal scrolling of the group-by control in the fixed header section.

Changing the main (primary) column

Xceed admin — Wed, 08 Oct 2008 20:25:12 GMT

The following example demonstrates how to set the ShipName column as a grid's main column.

Fixing columns

Xceed admin — Wed, 08 Oct 2008 20:24:56 GMT

The following example demonstrates how to fix the ShipCountry and ShipCity columns.

Hiding the group-level indicator pane

Xceed admin — Wed, 08 Oct 2008 20:22:34 GMT

The following example demonstrates how to hide the group-level indicator pane by creating a style which sets the Visibility property of GroupLevelIndicatorPane objects to Collapsed.

Adding separator lines

Xceed admin — Wed, 08 Oct 2008 20:21:42 GMT

The following examples demonstrates how to add separator lines between card "columns".

Recreating the default card-view header

Xceed admin — Wed, 08 Oct 2008 20:19:34 GMT

The following example demonstrates how to recreate the default card-view header, which contains a ColumnManagerRow to the right of a GroupByControl.

Clearing a fixed header section

Xceed admin — Wed, 08 Oct 2008 20:17:01 GMT

The following example demonstrates how to clear the content of all header and footer sections of a grid using its view's UseDefaultHeadersFooters property.

Adding an InsertionRow to the fixed headers

Xceed admin — Wed, 08 Oct 2008 20:16:17 GMT

The following example demonstrates how to add an InsertionRow to the fixed header section of a grid.

Coercing a surface configuration

Xceed admin — Wed, 08 Oct 2008 20:13:56 GMT

The following example demonstrates how to apply a different surface configuration on the back surface of the center card using the CoercedSurfaceConfiguration attached property.

VB.NET

Private m_fullSurfaceConfiguration As New ImageAndDataSurfaceConfiguration()

Private Sub ApplyCoercedSurfaceConfiguration( ByVal sender As Object, ByVal e As RoutedEventArgs )
If Not Me.ProductsGrid.CurrentItem Is Nothing Then
    Dim card As Xceed.Wpf.DataGrid.DataRow = CType( Me.ProductsGrid.GetContainerFromItem( Me.ProductsGrid.CurrentItem ), Xceed.Wpf.DataGrid.DataRow )

    If Not card Is Nothing Then
       card.SetValue( MultiSurfaceViewBase.CoercedSurfaceConfigurationProperty, m_fullSurfaceConfiguration )
    End If
End If
End Sub

C#

private ImageAndDataSurfaceConfiguration m_fullSurfaceConfiguration = new ImageAndDataSurfaceConfiguration();
private void ApplyCoercedSurfaceConfiguration( object sender, RoutedEventArgs e )
{
if( this.ProductsGrid.CurrentItem != null )
{
   Xceed.Wpf.DataGrid.DataRow card = this.ProductsGrid.GetContainerFromItem( this.ProductsGrid.CurrentItem ) as Xceed.Wpf.DataGrid.DataRow;

   if( card != null )
   {
     card.SetValue( MultiSurfaceViewBase.CoercedSurfaceConfigurationProperty, m_fullSurfaceConfiguration );
   }
}
}

The following XAML demonstrates how to define the initial surface configurations that are applied to various surfaces.

<xcdg:ImageAndTitleSurfaceConfiguration xcdg:CardflowView3D.Surfaces="Center"/>

                   <xcdg:CompleteSurfaceConfiguration xcdg:CardflowView3D.Surfaces="Back"
                                                      AutoFillDefaultRegion="False">
                      <xcdg:CompleteSurfaceConfiguration.DataRegionConfiguration>
                         <xcdg:RegionConfiguration FieldNames="ProductID, UnitPrice, UnitsInStock"/>
                      </xcdg:CompleteSurfaceConfiguration.DataRegionConfiguration>

Applying a grid background brush

Xceed admin — Wed, 08 Oct 2008 20:13:38 GMT

The following example demonstrates how to apply a one of the custom background brushes (provided by Xceed) to a grid's background.

Providing surface configurations

Xceed admin — Wed, 08 Oct 2008 20:13:19 GMT

The following example demonstrates how to provide an image and title surface configuration that will be applied to the center surface and a title surface configuration that will be applied to the left and right side cards.

Setting a view and theme

Xceed admin — Wed, 08 Oct 2008 20:12:50 GMT

The following example demonstrates how to use attribute syntax to apply a card-view layout, with the normal-color Aero theme, to a grid.

The following example demonstrates how to use property element syntax to apply a card-view layout, with the normal-color Aero theme, to a grid.

Retrieving child contexts

Xceed admin — Wed, 08 Oct 2008 20:12:19 GMT

The following example demonstrates how to retrieve the child contexts of the master data items and collapse any expanded details using the CollapseDetail method.

The next example provides the implementation of the button's Click event.

VB.NET

Private Sub Button_Click( ByVal sender As Object, ByVal e As RoutedEventArgs )
Dim rootContext As DataGridContext = DataGridControl.GetDataGridContext( Me.EmployeesGrid )
Dim childContexts As New List( Of DataGridContext)( Me.EmployeesGrid.GetChildContexts() )

Dim context As DataGridContext
For Each context In childContexts
context.ParentDataGridContext.CollapseDetails( context.ParentItem )
Next context
End Sub

C#

private void Button_Click( object sender, RoutedEventArgs e )
{
DataGridContext rootContext = DataGridControl.GetDataGridContext( this.EmployeesGrid );
List<DataGridContext> childContexts = new List<DataGridContext>( this.EmployeesGrid.GetChildContexts() );

foreach( DataGridContext context in childContexts )
{
context.ParentDataGridContext.CollapseDetails( context.ParentItem );
}
}

Providing a default detail configuration

Xceed admin — Wed, 08 Oct 2008 20:11:54 GMT

The following example demonstrates how to provide a default detail configuration that will be applied to all details in a grid and any descendant details for which an explicit detail configuration has not been provided.

Indenting a non-row item in a detail configuration header

Xceed admin — Wed, 08 Oct 2008 20:11:09 GMT

The following example demonstrates how to add a non-row item that will act as a detail separator to the header section of a detail configuration whose indentation will correspond to detail and group levels in which it is contained.

Defining detail descriptions

Xceed admin — Wed, 08 Oct 2008 20:10:50 GMT

The following example demonstrates how to explicitly define detail descriptions for the DataRelations found in the DataTable to which the grid is bound and how to calculate statistical functions for a detail description whose results will be displayed in the StatRows contained in the footer sections of the details to which the description's corresponding detail configuration will be applied.

<Grid>
<Grid.Resources>
     <xcdg:DataGridCollectionViewSource x:Key="cvs_employees"
                                        Source="{Binding Source={x:Static Application.Current},
                                                         Path=Employees}">

       <xcdg:DataGridCollectionViewSource.DetailDescriptions>
          <xcdg:DataRelationDetailDescription RelationName="Employee_Orders"
                                              Title="Employee Orders">

             <xcdg:DataRelationDetailDescription.DetailDescriptions>
                <xcdg:DataRelationDetailDescription RelationName="Order_OrderDetails"
                                                    Title="Order Details">
                   <xcdg:DataRelationDetailDescription.ItemProperties>
                      <xcdg:DataGridItemProperty Name="UnitPrice" />
                      <xcdg:DataGridItemProperty Name="Quantity" />
                      <xcdg:DataGridItemProperty Name="Discount" />
                   </xcdg:DataRelationDetailDescription.ItemProperties>
                   <xcdg:DataRelationDetailDescription.StatFunctions>
                      <xcdg:SumFunction ResultPropertyName="sum_quantity"
                                        SourcePropertyName="Quantity" />
                      <xcdg:AverageFunction ResultPropertyName="average_unitprice"
                                            SourcePropertyName="UnitPrice" />
                   </xcdg:DataRelationDetailDescription.StatFunctions>
                </xcdg:DataRelationDetailDescription>
             </xcdg:DataRelationDetailDescription.DetailDescriptions>
          </xcdg:DataRelationDetailDescription>
       </xcdg:DataGridCollectionViewSource.DetailDescriptions>
     </xcdg:DataGridCollectionViewSource>
</Grid.Resources>

<xcdg:DataGridControl x:Name="EmployeesGrid"
                      ItemsSource="{Binding Source={StaticResource cvs_employees}}"
                      ItemsSourceName="Employee Information"
                      AutoCreateDetailConfigurations="True">

    <xcdg:DataGridControl.DetailConfigurations>
       <xcdg:DetailConfiguration RelationName="Employee_Orders">
          <xcdg:DetailConfiguration.DetailConfigurations>
             <xcdg:DetailConfiguration RelationName="Order_OrderDetails">
                <xcdg:DetailConfiguration.Footers>
                   <DataTemplate>
                      <xcdg:StatRow realsrc="AliceBlue" background="http://dev.xceed.xcd/kb/admin/AliceBlue">
                         <xcdg:StatCell FieldName="UnitPrice"
                                        ResultPropertyName="average_unitprice"
                                        ResultConverterParameter="f2" />
                         <xcdg:StatCell FieldName="Quantity"
                                        ResultPropertyName="sum_quantity" />
                      </xcdg:StatRow>
                   </DataTemplate>
                </xcdg:DetailConfiguration.Footers>
             </xcdg:DetailConf

Creating a custom detail description

Xceed admin — Wed, 08 Oct 2008 20:10:35 GMT

The following example demonstrates how to create and use a custom detail description that handles LINQ detail relations, which are provided by properties to which the AssociationAttribute is applied.

VB.NET

Imports System
Imports System.Collections.Generic
Imports System.Linq
Imports System.Text
Imports Xceed.Wpf.DataGrid
Imports System.Reflection
Imports System.Data.Linq.Mapping
Imports System.Diagnostics
Imports System.Collections

Namespace Xceed.Wpf.Documentation
Public Class LinqToSqlDetailDescription
               Inherits DataGridDetailDescription

    Protected Overrides Function GetDetailsForParentItem( ByVal parentCollectionView As DataGridCollectionView, _
                                                          ByVal parentItem As Object ) As IEnumerable
      Dim parentItemType As Type = parentItem.GetType()
      Dim foundProperty As PropertyInfo = Nothing
      Dim properties() As PropertyInfo = parentItemType.GetProperties()
      Dim propertyInfo As PropertyInfo

      For Each propertyInfo In properties
        Dim attributes() As Object = propertyInfo.GetCustomAttributes( Type.GetType( AssociationAttribute ), False)

        If attributes.GetLength( 0 ) = 0 Then
          continue
        End If

        Dim associationAttribute As AssociationAttribute = CType( attributes( 0 ), AssociationAttribute )

        If associationAttribute.Name = Me.RelationName Then
          foundProperty = propertyInfo
          Exit Property
        End If
      Next

      If foundProperty Is Nothing Then
        Return New Object()
      Else
        Dim details As Object = foundProperty.GetValue( parentItem, Nothing )
        Dim detailsType As Type = details.GetType()
        Dim getNewBindingList As MethodInfo = detailsType.GetMethod( "GetNewBindingList" )

        Return CType( getNewBindingList.Invoke( details, Nothing), IEnumerable )
      End If
    End Function
End Class
End Namespace

C#

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using Xceed.Wpf.DataGrid;
using System.Reflection;
using System.Data.Linq.Mapping;
using System.Diagnostics;
using System.Collections;

namespace Xceed.Wpf.Documentation
{
public class LinqToSqlDetailDescription: DataGridDetailDescription
{
   protected override IEnumerable GetDetailsForParentItem( DataGridCollectionView parentCollectionView, object parentItem )
   {
     Type parentItemType = parentItem.GetType();
     PropertyInfo foundProperty = null;

     PropertyInfo[] properties = parentItemType.GetProperties();
     foreach( PropertyInfo propertyInfo in properties )
     {
       object[] attributes = propertyInfo.GetCustomAttributes( typeof( AssociationAttribute ), false );

       if( attributes.GetLength( 0 ) == 0 )
         continue;

       AssociationAttribute associationAttribute = ( AssociationAttribute )attributes[ 0 ];
       if( associationAttribute.Name == this.RelationName )
       {
         foundProperty = propertyInfo;
         break;
       }
     }

     if( foundProperty == null )
     {
       return new object[] { };
     }
     else
     {
       object details = foundProperty.GetValue( parentItem, null );
       Type detailsType = details.GetType();
       MethodInfo getNewBindingList = detailsType.GetMethod( "GetNewBindingList" );

       return ( IEnumerable )getNewBindingList.Invoke( details, null );
     }
   }
}<

Displaying statistical functions in details

Xceed admin — Wed, 08 Oct 2008 20:08:25 GMT

<Grid>
<Grid.Resources>
     <xcdg:DataGridCollectionViewSource x:Key="cvs_employees"
                                        Source="{Binding Source={x:Static Application.Current},
                                                         Path=Employees}">

       <xcdg:DataGridCollectionViewSource.DetailDescriptions>
          <xcdg:DataRelationDetailDescription RelationName="Employee_Orders"
                                              Title="Employee Orders">
             <xcdg:DataRelationDetailDescription.DetailDescriptions>
                <xcdg:DataRelationDetailDescription RelationName="Order_OrderDetails"
                                                    Title="Order Details">

                   <xcdg:DataRelationDetailDescription.ItemProperties>
                      <xcdg:DataGridItemProperty Name="UnitPrice" />
                      <xcdg:DataGridItemProperty Name="Quantity" />
                      <xcdg:DataGridItemProperty Name="Discount" />
                   </xcdg:DataRelationDetailDescription.ItemProperties>

                   <xcdg:DataRelationDetailDescription.StatFunctions>
                      <xcdg:SumFunction ResultPropertyName="sum_quantity"
                                        SourcePropertyName="Quantity" />
                      <xcdg:AverageFunction ResultPropertyName="average_unitprice"
                                            SourcePropertyName="UnitPrice" />
                   </xcdg:DataRelationDetailDescription.StatFunctions>

                </xcdg:DataRelationDetailDescription>
             </xcdg:DataRelationDetailDescription.DetailDescriptions>
          </xcdg:DataRelationDetailDescription>
       </xcdg:DataGridCollectionViewSource.DetailDescriptions>
     </xcdg:DataGridCollectionViewSource>
</Grid.Resources>

<xcdg:DataGridControl x:Name="EmployeesGrid"
                      ItemsSource="{Binding Source={StaticResource cvs_employees}}"
                      ItemsSourceName="Employee Information"
                      AutoCreateDetailConfigurations="True">
    <xcdg:DataGridControl.DetailConfigurations>
       <xcdg:DetailConfiguration RelationName="Employee_Orders">
          <xcdg:DetailConfiguration.DetailConfigurations>
             <xcdg:DetailConfiguration RelationName="Order_OrderDetails">
                <xcdg:DetailConfiguration.Footers>
                   <DataTemplate>
                      <xcdg:StatRow realsrc="AliceBlue" background="http://dev.xceed.xcd/kb/admin/AliceBlue">
                         <xcdg:StatCell FieldName="UnitPrice"
                                        ResultPropertyName="average_unitprice"
                                        ResultConverterParameter="f2" />
                         <xcdg:StatCell FieldName="Quantity"
                                        ResultPropertyName="sum_quantity" />
                      </xcdg:StatRow>
                   </DataTemplate>
                </xcdg:DetailConfiguration.Footers>
             </xcdg:Detai

Custom statistical-result layout

Xceed admin — Wed, 08 Oct 2008 20:08:13 GMT

The following example demonstrates how to create a custom data template that will be used in the footers of the first-level groups to display the results of various statistical functions.

    <xcdg:DataGridCollectionViewSource.StatFunctions>
       <xcdg:CountFunction ResultPropertyName="orderid_count"
                           SourcePropertyName="OrderID"/>
       <xcdg:SumFunction ResultPropertyName="unitprice_sum"
                         SourcePropertyName="UnitPrice"/>
       <xcdg:AverageFunction ResultPropertyName="unitprice_average"
                             SourcePropertyName="UnitPrice"/>
       <xcdg:SumFunction ResultPropertyName="quantity_sum"
                         SourcePropertyName="Quantity"/>
     </xcdg:DataGridCollectionViewSource.StatFunctions>

      <xcdg:DataGridCollectionViewSource.GroupDescriptions>
        <xcdg:DataGridGroupDescription PropertyName="ProductID"/>
      </xcdg:DataGridCollectionViewSource.GroupDescriptions>
    </xcdg:DataGridCollectionViewSource>

   <xcdg:StatResultConverter x:Key="valueConverter"/>

</Grid.Resources>

<xcdg:DataGridControl x:Name="OrderDetailsGrid"
                        ItemsSource="{Binding Source={StaticResource cvs_orderdetails}}">
    <xcdg:DataGridControl.DefaultGroupConfiguration>
      <xcdg:GroupConfiguration>
        <xcdg:GroupConfiguration.Footers>
          <xcdg:GroupHeaderFooterItemTemplate VisibleWhenCollapsed="True">
            <DataTemplate>
              <Border realsrc="#999999" background="http://dev.xceed.xcd/kb/admin/#999999"
                      BorderBrush="LightBlue"
                      BorderThickness="3"
                      Margin="5" >
                <Grid>
                  <Grid.ColumnDefinitions>
                    <ColumnDefinition/>
                    <ColumnDefinition/>
                  </Grid.ColumnDefinitions>
                  <Grid.RowDefinitions>
                    <RowDefinition/>
                    <RowDefinition/>
                    <RowDefinition/>
                    <RowDefinition/>
                  </Grid.RowDefinitions>
                  <TextBlock Text="Total Orders: " Grid.Row="0" Grid.Column="0"/>

<TextBlock Text="{Binding RelativeSource={RelativeSource Self},

Changing statistical contexts

Xceed admin — Wed, 08 Oct 2008 20:08:00 GMT

The following example demonstrates how to change the statistical context of a TextBlock that displays the results of a statistical function when the current item is changed. The statistical context of the TextBlock will be changed in the grid's PropertyChanged event handler by using the GetParentGroupFromItem method to retrieve the current group and set it as the new statistical context.

To simplify the code below, the DataContext of the StackPanel could have been modified rather than the DataContext of each TextBlock.

      <xcdg:DataGridCollectionViewSource.StatFunctions>
        <xcdg:CountFunction ResultPropertyName="orderid_count"
                            SourcePropertyName="OrderID"/>
        <xcdg:AverageFunction ResultPropertyName="unitprice_average"
                              SourcePropertyName="UnitPrice"/>
      </xcdg:DataGridCollectionViewSource.StatFunctions>

      <xcdg:DataGridCollectionViewSource.GroupDescriptions>
        <xcdg:DataGridGroupDescription PropertyName="ProductID"/>
      </xcdg:DataGridCollectionViewSource.GroupDescriptions>
    </xcdg:DataGridCollectionViewSource>

    <xcdg:StatResultConverter x:Key="valueConverter"/>
</Grid.Resources>

<DockPanel>
    <StackPanel Orientation="Horizontal" DockPanel.Dock="Top">
      <TextBlock Text="Results for product "/>
      <TextBlock x:Name="CurrentGroupTitle" Text="{Binding Name}"/>
      <TextBlock Text=": "/>
      <TextBlock Text="     Total Orders-"/>
      <TextBlock x:Name="TotalOrders" Text="{Binding orderid_count}"/>
      <TextBlock Text="     Average Unit Price-"/>
      <TextBlock x:Name="AveragePrice"
                 Text="{Binding unitprice_average,
                        Converter={StaticResource valueConverter},
                        ConverterParameter=f2}"/>
    </StackPanel>

    <xcdg:DataGridControl x:Name="OrderDetailsGrid"
                          ItemsSource="{Binding Source={StaticResource cvs_orderdetails}}"
                          PropertyChanged="CurrentItemChanged"
                          DockPanel.Dock="Bottom"/>
</DockPanel>
</Grid>

The following code provides the implementation of the PropertyChanged event handler.

VB.NET

Private Sub CurrentItemChanged( ByVal sender As Object, ByVal e AsPropertyChangedEventArgs )
If e.PropertyName = "CurrentItem" Then
    If Me.OrderDetailsGrid.CurrentItem Is Nothing Then
      Return
    End If

    Dim group As CollectionViewGroup = Me.OrderDetailsGrid.GetParentGroupFromItem( Me.OrderDetailsGrid.CurrentItem )

    Me.CurrentGroupTitle.DataContext = group
    Me.TotalOrders.DataContext = group
    Me.AveragePrice.DataContext = group
End If
End Sub

C#

private void CurrentItemChanged( object sender, PropertyChangedEventArgs e )
{
if( e.PropertyName == "CurrentItem" )
{
    if( this.OrderDetailsGrid.CurrentItem == null )
      return;

    CollectionView

Displaying statistical functions

Xceed admin — Wed, 08 Oct 2008 20:07:41 GMT

The following example demonstrates how to display the results of various statistical functions in and outside of a grid.

     <xcdg:DataGridCollectionViewSource.StatFunctions>
       <xcdg:CountFunction ResultPropertyName="orderid_count"
                           SourcePropertyName="OrderID"/>
       <xcdg:SumFunction ResultPropertyName="unitprice_sum"
                         SourcePropertyName="UnitPrice"/>
       <xcdg:SumFunction ResultPropertyName="quantity_sum" SourcePropertyName="Quantity"/>
     </xcdg:DataGridCollectionViewSource.StatFunctions>

     <xcdg:DataGridCollectionViewSource.GroupDescriptions>
       <xcdg:DataGridGroupDescription PropertyName="ProductID"/>
     </xcdg:DataGridCollectionViewSource.GroupDescriptions>
    </xcdg:DataGridCollectionViewSource>

   <xcdg:StatResultConverter x:Key="valueConverter"/>
</Grid.Resources>

<DockPanel>
    <StackPanel Orientation="Horizontal" DockPanel.Dock="Top">
      <TextBlock Text="Total Orders: "/>
      <TextBlock Text="{Binding ElementName=OrderDetailsGrid,
                 Path=StatContext.orderid_count}"/>
    </StackPanel>

     <StackPanel Orientation="Horizontal" DockPanel.Dock="Top">
       <TextBlock Text="Average Unit Price: "/>
     <TextBlock Text="{Binding ElementName=OrderDetailsGrid,
                        Path=StatContext.unitprice_average,
                        Converter={StaticResource valueConverter},
                        ConverterParameter=f2}"/>
    </StackPanel>

    <xcdg:DataGridControl x:Name="OrderDetailsGrid"
                          ItemsSource="{Binding Source={StaticResource cvs_orderdetails}}"
                          DockPanel.Dock="Bottom">
      <xcdg:DataGridControl.DefaultGroupConfiguration>
        <xcdg:GroupConfiguration>
        <xcdg:GroupConfiguration.Footers>
           <DataTemplate>
               <xcdg:StatRow>
               <xcdg:StatCell FieldName="UnitPrice"
                              ResultPropertyName="unitprice_sum"/>
               <xcdg:StatCell FieldName="Quantity"
                              ResultPropertyName="quantity_sum"/>
               <xcdg:StatCell FieldName="OrderID"
                              ResultPropertyName="orderid_count"/>
             </xcdg:StatRow>
           </DataTemplate>
         </xcdg:GroupConfiguration.Footers>
        </xcdg:GroupConfiguration>
      </xcdg:DataGridControl.DefaultGroupConfiguration>
    </xcdg:DataGridControl>
</DockPanel>
</Grid>

Providing binding-level validation

Xceed admin — Wed, 08 Oct 2008 20:07:15 GMT

The following example demonstrates how to create a custom ValidationRule and apply it to a column's binding to provide binding-level validation.

Implementation of theYearValidationRulevalidation rule.

VB.NET

Imports System
Imports System.Windows.Controls
Imports System.Globalization

Namespace Xceed.Wpf.Documentation
Public Class YearValidationRule
               Inherits ValidationRule

    Public Overrides Function Validate( ByVal value As Object, _
                                        ByVal cultureInfo As CultureInfo ) As ValidationResult
      Dim year As Integer = CInt( value )

      If year > DateTime.Now.Year Then
        Return New ValidationResult( False, "Chosen year cannot be greater than this year." )
      End If
      Return ValidationResult.ValidResult
    End Function
End Class
End Namespace

C#

using System;
using System.Windows.Controls;
using System.Globalization;

namespace Xceed.Wpf.Documentation
{
public class YearValidationRule : ValidationRule
{
   public override ValidationResult Validate( object value, CultureInfo cultureInfo )
   {
     int year = ( int )value;

     if( year > DateTime.Now.Year )
       return new ValidationResult( false, "Chosen year cannot be greater than this year." );

     return ValidationResult.ValidResult;
   }
}
}

Providing a cell error style

Xceed admin — Wed, 08 Oct 2008 20:07:03 GMT

The following example demonstrates how to provide a new style that will change the foreground color of a cell when its value fails the validation process

Providing a custom sort comparer

Xceed admin — Wed, 08 Oct 2008 20:01:25 GMT

The following example demonstrates how to provide a custom sort comparer that sorts addresses. The AddressComparer class (provided below) will first sort addresses which begin with numeric values by street name and then civic number. Address that do not have a civic number will be sorted alphabetically.

The following code provides the implementation of the AddressComparer class.

VB.NET

Imports System
Imports System.Collections
Imports System.Data

Namespace Xceed.Wpf.Documentation
Public Class AddressComparer
               Implements IComparer

    Public Sub New()
    End Sub

    Public Function Compare( x As Object, y As Object ) As Integer Implements IComparer.Compare
      Dim stringX As String = CType( x, String )
      Dim stringY As String = Ctyle( y, String )
      Const digits As String = "0123456789"

      If( ( digits.IndexOf( stringX( 0 ) ) >= 0 ) And ( digits.IndexOf( stringY( 0 ) ) >= 0 ) ) Then
        Dim index As Integer = 0
        Dim xNumber As System.Text.StringBuilder = New System.Text.StringBuilder()

        While( ( index < stringX.Length ) And ( digits.IndexOf( stringX( index ) ) >= 0 ) )
          xNumber.Append( stringX( index ) )
          index++
        End While

        index = 0
        Dim yNumber As System.Text.StringBuilder = New System.Text.StringBuilder()

        While( ( index < stringY.Length ) And ( digits.IndexOf( stringY( index ) ) >= 0 ) )
          yNumber.Append( stringY( index ) )
          index++
        End While

        Dim xValue = Long.Parse( xNumber.ToString() )
        Dim yValue As Long = Long.Parse( yNumber.ToString() )

        If( xValue > yValue ) Then
          Return 1
        End If

        If( xValue < yValue ) Then
          Return -1
        End If

        Return stringX.CompareTo( stringY )
      Else
        Return stringX.CompareTo( stringY )
      End If
    End Function
End Class
End Namespace

C#

using System;
using System.Collections;
using System.Data;

namespace Xceed.Wpf.Documentation
{
public class AddressComparer: IComparer
{
   public AddressComparer()
   {
   }

   int IComparer.Compare( object x, object y )
   {
     string stringX = ( string )x;
     string stringY = ( string )y;

     const string digits = "0123456789";
     if( ( digits.IndexOf( stringX[ 0 ] ) >= 0 ) && ( digits.IndexOf( stringY[ 0 ] ) >= 0 ) )
     {
       int index = 0;
       System.Text.StringBuilder xNumber = new System.Text.StringBuilder();

       while( ( index < stringX.Length ) && ( digits.IndexOf( stringX[ index ] ) >= 0 ) )
       {
         xNumber.Append( stringX[ index ] );
         index++;
       }

       index = 0;
       System.Text.StringBuilder yNumber = new System.Text.StringBuilder();

       while( ( index < stringY.Length ) && ( digits.IndexOf( stringY[ index ] ) >= 0 ) )
       {
         yNumber.Append( stringY[ index ] );
         index++;
       }

       long xValue = long.Parse( xNumber.ToString() );
       long yValue = long.Parse( yNumber.ToString() );

       if( xValue > yValue )
         return 1;

       if( xValue < yValue )
         return -1;

       return stringX.CompareTo( stringY );
     }
     else
     {
       return stringX.CompareTo( stringY );
     }
   }
}
}

Sorting data items

Xceed admin — Wed, 08 Oct 2008 19:59:37 GMT

The following example demonstrates how to sort the data items in an ascending direction according to the values of the ShipCountry column.

Manually handling the insertion process

Xceed admin — Wed, 08 Oct 2008 19:59:21 GMT

The following example demonstrates how to manually handle the insertion process of a new item into a collection.

    <xcdg:DataGridCollectionViewSource x:Key="cvs_persons"
                                       Source="{Binding Source={x:Static Application.Current},
                                                        Path=PersonList}"
                                       CreatingNewItem="CollectionView_CreatingNewItem"
                                       CommittingNewItem="CollectionView_CommittingNewItem"
                                       CancelingNewItem="CollectionView_CancelingNewItem"/>
</Grid.Resources>

<xcdg:DataGridControl x:Name="PersonsGrid"
                        ItemsSource="{Binding Source={StaticResource cvs_persons}}">
     <xcdg:DataGridControl.View>
        <xcdg:TableView>
           <xcdg:TableView.FixedHeaders>
              <DataTemplate>
                 <xcdg:InsertionRow/>
              </DataTemplate>
           </xcdg:TableView.FixedHeaders>
        </xcdg:TableView>
     </xcdg:DataGridControl.View>
</xcdg:DataGridControl>
</Grid>

The following code provides the implementation of the CreatingNewItem, CommittingNewItem, and CancelingNewItem events.

VB.NET

Private Sub CollectionView_CreatingNewItem( ByVal sender As Object, _
                                            ByVal e As DataGridCreatingNewItemEventArgs )

e.NewItem = New Person( Person.AutoIncrementID, String.Empty, String.Empty, -1 )
e.Handled = True
End Sub

Private Sub CollectionView_CommittingNewItem( ByVal sender As Object, _
                                              ByVal e As DataGridCommittingNewItemEventArgs )

Dim source As List( Of Person ) = CType( e.CollectionView.SourceCollection, List( Of Person ) )
source.Add( CType( e.Item, Person ) )
Person.AutoIncrementID = Person.AutoIncrementID + 1

' the new item is always added at the end of the list.
e.Index = source.Count - 1
e.NewCount = source.Count
e.Handled = True
End Sub

Private Sub CollectionView_CancelingNewItem( ByVal sender As Object, _
                                             ByVal e As DataGridItemHandledEventArgs )

' Manually handling the insertion of new items requires that the CreatingNewItem,
' CommitingNewItem, and CancelingNewItem events must all be handled even if nothing
' is done in the event.
e.Handled = True
End Sub

private void CollectionView_CreatingNewItem( object sender, DataGridCreatingNewItemEventArgs e )
{
e.NewItem = new Person( Person.AutoIncrementID, string.Empty, string.Empty, -1 );
e.Handled = true;
}

private void CollectionView_CommittingNewItem( object sender, DataGridCommittingNewItemEventArgs e )
{
List<Person> source = e.CollectionView.SourceCollection as List<Person>;
source.Add( ( Person )e.Item );
Person.AutoIncrementID = Person.AutoIncrementID + 1;

// the new item is always added at the end of the list.
e.Index = source.Count - 1;
e.NewCount = source.Count;
e.Handled = true;
}

privat

Binding to a master/detail data table

Xceed admin — Wed, 08 Oct 2008 19:59:00 GMT

The following example demonstrates how to bind a grid to a DataTable that contains DataRelations that will be displayed as child and grandchild detail data.

The code below demonstrates how to create a connection to the Access version of the Northwind database and create a property named "Employees" that retrieves its values from the Employees data table and to which a child and grandchild detail are added.

VB.NET

Shared Sub New()
Dim dataSet As New DataSet()
Dim mdbfile As String = "Data\Northwind.mdb"
Dim connString As String = String.Format("Provider=Microsoft.Jet.OLEDB.4.0; Data Source={0}", mdbfile)
Dim conn As New OleDbConnection(connString)
Dim adapter As New OleDbDataAdapter()

m_adapter = New OleDbDataAdapter()
m_adapter.SelectCommand = New OleDbCommand( "SELECT * FROM Employees;", conn )
m_adapter.Fill( dataSet, "Employees" )
m_employees = dataSet.Tables( "Employees" )
m_adapter = New OleDbDataAdapter()
m_adapter.SelectCommand = New OleDbCommand( "SELECT * FROM Orders;", conn )
m_adapter.Fill( dataSet, "Orders" )
m_orders = dataSet.Tables( "Orders" )

m_adapter = New OleDbDataAdapter()
m_adapter.SelectCommand = New OleDbCommand( "SELECT * FROM [Order Details];", conn )
m_adapter.Fill( dataSet, "Order Details" )
m_orderDetails = dataSet.Tables( "Order Details" )

m_employees.ChildRelations.Add( New DataRelation( "Employee_Orders", m_employees.Columns( "EmployeeID" ), m_orders.Columns( "EmployeeID" ) ) )
m_orders.ChildRelations.Add( New DataRelation( "Order_OrderDetails", m_orders.Columns( "OrderID" ), m_orderDetails.Columns( "OrderID" ) ) )
End Sub

Public Shared ReadOnly Property Employees As DataTable
Get
    Return m_employees
   End Get
End Property

Private Shared m_employees As DataTable
Private Shared m_orders As DataTable
Private Shared m_orderDetails As DataTable
Private Shared m_adapter As OleDbDataAdapter = Nothing

C#

static App()
{
DataSet dataSet = new DataSet();
string mdbFile = @"Data\Northwind.mdb";
string connString = String.Format( "Provider=Microsoft.Jet.OLEDB.4.0; Data Source={0}", mdbFile );
OleDbConnection conn = new OleDbConnection( connString );

  m_adapter = new OleDbDataAdapter();
m_adapter.SelectCommand = new OleDbCommand( "SELECT * FROM Employees;", conn );
m_adapter.Fill( dataSet, "Employees" );
  m_employees = dataSet.Tables[ "Employees" ];
m_adapter = new OleDbDataAdapter();
m_adapter.SelectCommand = new OleDbCommand( "SELECT * FROM Orders;", conn );
m_adapter.Fill( dataSet, "Orders" );
m_orders = dataSet.Tables[ "Orders" ];

m_adapter = new OleDbDataAdapter();
m_adapter.SelectCommand = new OleDbCommand( "SELECT * FROM [Order Details];", conn );
m_adapter.Fill( dataSet, "Order Details" );
m_orderDetails = dataSet.Tables[ "Order Details" ];

  m_employees.ChildRelations.Add( new DataRelation( "Employee_Orders", m_employees.Columns[ "EmployeeID" ], m_orders.Columns[ "EmployeeID" ] ) );
m_orders.ChildRelations.Add( new DataRelation( "Order_OrderDetails", m_orders.Columns[ "OrderID" ], m_orderDetails.Columns[ "OrderID" ] ) );
}

public static DataTable Employees
{
get
{
   return m_employees;
}
}

private static DataTable m_employees;
private static DataTable m_orders;
private static DataTable m_orderDetails;
private static OleDbDataAdapter m_adapter = null;

The following code demonstrates how to bind the grid to the Employees property and provide a detail confi

Binding to a LINQ query (SQL)

Xceed admin — Wed, 08 Oct 2008 19:58:43 GMT

The following example demonstrates how to bind a grid to an SQL LINQ query and submit any modifications made to the data items using the SubmitChanges method.

Although existing data items can be modified and the changes committed, it is not possible to insert new data items.

This example assumes that a new LINQ to SQL Classes item named Northwind.dbml has been added to the project and that it contains the Orders, Customers, and Shippers tables. The Northwind.designer.cs that is created at the same time represents the NorthwindDataContext and should automatically contain all the relevant members. It also assumes that a property named OrdersQuery that returns a new new query based on the value selected in the combo box.

    <xcdg:DataGridCollectionViewSource x:Key="cvs_orders"
                                      Source="{Binding RelativeSource={RelativeSource AncestorType={x:Type Window}},
                                                       Path=OrdersQuery}">
      <xcdg:DataGridCollectionViewSource.GroupDescriptions>
        <xcdg:DataGridGroupDescription PropertyName="Shipper"/>
      </xcdg:DataGridCollectionViewSource.GroupDescriptions>
    </xcdg:DataGridCollectionViewSource>

    <xcdg:DataGridControl x:Name="OrdersGrid"
                          ItemsSource="{Binding Source={StaticResource cvs_orders}}">
      <xcdg:DataGridControl.Columns>
        <xcdg:Column FieldName="Shipper"
                     VisiblePosition="0"/>
        <xcdg:Column FieldName="OrderID"
                     Visible="False"/>
        <xcdg:Column FieldName="EmployeeID"
                     Visible="False"/>
        <xcdg:Column FieldName="CustomerID"
                     Visible="False"/>
        <xcdg:Column FieldName="Customer"
                     Title="Company Name"/>
        <xcdg:Column FieldName="ShipVia"
                     Visible="False"/>
      </xcdg:DataGridControl.Columns>
    </xcdg:DataGridControl>
</DockPanel>
</Grid>

The Window1 class implements INotifyPropertyChanged so that the DataGridCollectionViewSource can be notified

Binding to a LINQ query (XML)

Xceed admin — Wed, 08 Oct 2008 19:58:32 GMT

The following example demonstrates how to bind a grid to an XML query on an XDocument that loads the XML version of the Orders table of the Northwind database.

The content of the resulting grid will not be editable.

    <xcdg:DataGridCollectionViewSource x:Key="cvs_orders"
                    Source="{Binding RelativeSource={RelativeSource AncestorType={x:Type Window}},
                                     Path=XmlData}"/>
</Grid.Resources>

<xcdg:DataGridControl x:Name="OrdersGrid"
                       ItemsSource="{Binding Source={StaticResource cvs_orders}}"/>
</Grid>

The following code provides the implementation for the XmlData property, which returns the query result.

VB.NET

Public ReadOnly Property XmlData() As IEnumerable
Get
    Dim document As XDocument = App.NorthwindDocument

    Dim data As IEnumerable = From order In document.Element("dataroot").Descendants("Orders") _
                              Select New With {.ShipCountry = order.Element("ShipCountry").Value, _
                                .ShipCity = order.Element("ShipCity").Value, _
                                .ShipAddress = order.Element("ShipAddress").Value, _
                                .ShipName = order.Element("ShipName").Value, _
                                .Freight = order.Element("Freight").Value}
    Return data
End Get
End Property

C#

public IEnumerable XmlData
{
get
{
   XDocument document = App.NorthwindDocument;

   IEnumerable data = from order in document.Element( "dataroot" ).Descendants( "Orders" )
                      select new
                      {
                        ShipCountry = order.Element( "ShipCountry" ).Value,
                        ShipCity = order.Element( "ShipCity" ).Value,
                        ShipAddress = order.Element( "ShipAddress" ).Value,
                        ShipName = order.Element( "ShipName" ).Value,
                        ShipVia = order.Element( "ShipVia" ).Value,
                        Freight = order.Element( "Freight" ).Value
                      };
   return data;
}
}

Providing unbound data

Xceed admin — Wed, 08 Oct 2008 19:58:14 GMT

The following example demonstrates how to add Person data to a custom ObservableCollection of Person objects.

Styling a page

Xceed admin — Wed, 08 Oct 2008 19:57:22 GMT

The following example demonstrates how to create a style to change the layout of the printed pages by providing a new ControlTemplate that will place the page headers and footers at the top of each page and display an orange border around the area where the grid is printed.

The Print method will be called in the button's Click event, whose implementation is provided below.

VB.NET

Private Sub PrintGrid( ByVal sender As Object, ByVal e As RoutedEventArgs )
Me.EmployeeGrid.Pr

Configuring a progress window

Xceed admin — Wed, 08 Oct 2008 19:57:12 GMT

The following example demonstrates how to change the default text displayed in the progress window when the Print or ExportToXps methods are called.

The implementation of the PrintGrid method is provided below.

VB.NET

Private Sub PrintGrid( ByVal sender As Object, ByVal e As RoutedEventArgs )
Me.EmployeesGrid.Print( "EmployeeInformation", True )
End Sub

C#

private void PrintGrid( object sender, RoutedEventArgs e )
{
this.EmployeesGrid.Print( "EmployeeInformation", true );
}

Configuring a print view

Xceed admin — Wed, 08 Oct 2008 19:56:56 GMT

The following example demonstrates how to use a PrintTableView and configure it to display a title in the page headers and the page number in the page footers. The elements added to these sections must be added as DataTemplates and will be repeated on each page.

Creating a group-configuration selector

Xceed admin — Wed, 08 Oct 2008 19:56:46 GMT

The following example demonstrates how to create a custom group-configuration selector that will return the appropriate group configuration depending on the number of items in a group. The implementation of the ItemCountGroupConfigurationSelector is provided below.

<xcdg:DataGridControl x:Name="OrdersGrid"
ItemsSource="{Binding Source={StaticResource cvs_orders}}">

    <xcdg:DataGridControl.GroupConfigurationSelector>
      <local:ItemCountGroupConfigurationSelector MinItemCount="10" />
    </xcdg:DataGridControl.GroupConfigurationSelector>
</xcdg:DataGridControl>
</Grid>

The following code provides the implementation of the ItemCountGroupConfigurationSelector.

VB.NET

Public Class ItemCountGroupConfigurationSelector
               Inherits GroupConfigurationSelector
    Public Sub New
    End Sub

    Public Overrides Function SelectGroupConfiguration( ByVal groupLevel As Integer, _
                    ByVal collectionViewGroup As System.Windows.Data.CollectionViewGroup, _
                    ByVal groupDescription As System.ComponentModel.GroupDescription ) As GroupConfiguration

      If collectionViewGroup Is Nothing Then
        Return MyBase.SelectGroupConfiguration( groupLevel, collectionViewGroup, groupDescription )
      End If

      Dim groupConfiguration As New GroupConfiguration()
      Dim style As New Style( GetType( Xceed.Wpf.DataGrid.DataRow ) )

      If collectionViewGroup.ItemCount <= m_minItemCount Then ' red
        style.Setters.Add( New Setter( Xceed.Wpf.DataGrid.DataRow.BackgroundProperty, Brushes.Red ) )
      Else ' green
        style.Setters.Add( New Setter( Xceed.Wpf.DataGrid.DataRow.BackgroundProperty, Brushes.LightGreen ) )
      End If

      groupConfiguration.ItemContainerStyle = style
      Return groupConfiguration
    End Function

    Private m_minItemCount As Integer = 0
    Public Property MinItemCount As Integer
      Get
        Return m_minItemCount
      End Get
      Set
        m_minItemCount = value
    End Property
End Class

C#

public class ItemCountGroupConfigurationSelector : GroupConfigurationSelector
{
    public ItemCountGroupConfigurationSelector()
    {
    }

   public override GroupConfiguration SelectGroupConfiguration( int groupLevel,
                   System.Windows.Data.CollectionViewGroup collectionViewGroup,
                   System.ComponentModel.GroupDescription groupDescription )
   {
     if( collectionViewGroup == null )
       return base.SelectGroupConfiguration( groupLevel, collectionViewGroup, groupDescription );

     GroupConfiguration groupConfiguration = new Group

Providing a group-configuration selector

Xceed admin — Wed, 08 Oct 2008 19:56:34 GMT

The following example demonstrates how to provide a FieldNameGroupConfigurationSelector that will apply the defined group configuration to all groups that are created from the values of the column corresponding to the specified field name.

Defining a default group configuration

Xceed admin — Wed, 08 Oct 2008 19:55:04 GMT

The following example demonstrates how to provide a default group configuration.

Preventing group and sorting

Xceed admin — Wed, 08 Oct 2008 19:54:54 GMT

The following example demonstrates how to bind a grid to the Orders table and prevent columns from being sorted and reordered and groups from being created or removed. By default, the ShipCountry and ShipCity columns will be sorted, grouped, and fixed.

<Grid.Resources>
    <xcdg:DataGridCollectionViewSource x:Key="cvs_orders"
                                    Source="{Binding Source={x:Static Application.Current},
                                                      Path=Orders}">

      <xcdg:DataGridCollectionViewSource.SortDescriptions>
        <scm:SortDescription PropertyName="ShipCountry" Direction="Ascending"/>
        <scm:SortDescription PropertyName="ShipCity" Direction="Ascending"/>
      </xcdg:DataGridCollectionViewSource.SortDescriptions>

      <xcdg:DataGridCollectionViewSource.GroupDescriptions>
        <xcdg:DataGridGroupDescription PropertyName="ShipCountry"/>
        <xcdg:DataGridGroupDescription PropertyName="ShipCity"/>
      </xcdg:DataGridCollectionViewSource.GroupDescriptions>
    </xcdg:DataGridCollectionViewSource>

</Grid.Resources>

<xcdg:DataGridControl x:Name="OrdersGrid"
                        ItemsSource="{Binding Source={StaticResource cvs_orders}}">
    <xcdg:DataGridControl.Columns>
      <xcdg:Column FieldName="ShipCountry" VisiblePosition="0"/>
      <xcdg:Column FieldName="ShipCity" VisiblePosition="1"/>
    </xcdg:DataGridControl.Columns>

    <xcdg:DataGridControl.View>
      <xcdg:TableView FixedColumnCount="2" UseDefaultHeadersFooters="False">
        <xcdg:TableView.FixedHeaders>
          <DataTemplate>
            <xcdg:GroupByControl AllowSort="False" AllowGroupingModification="False"/>
          </DataTemplate>
          <DataTemplate>
            <xcdg:ColumnManagerRow AllowSort="False" AllowColumnReorder="False"/>
          </DataTemplate>
        </xcdg:TableView.FixedHeaders>
      </xcdg:TableView>
    </xcdg:DataGridControl.View>
</xcdg:DataGridControl>
</Grid>

Enabling automatic filtering

Xceed admin — Wed, 08 Oct 2008 19:53:56 GMT

The following example demonstrates how to enable automatic filtering, disabling it for the columns that will not support it and filtering the distinct values of the ShipCity column.

<xcdg:DataGridCollectionViewSource x:Key="cvs_orders"
                                     Source="{Binding Source={x:Static Application.Current},
                                                      Path=Orders}"
                                     AutoFilterMode="And"
                                     DistinctValuesConstraint="Filtered"
                                     AutoCreateItemProperties="False">
       <xcdg:DataGridCollectionViewSource.ItemProperties>
         <xcdg:DataGridItemProperty Name="ShipCountry"
                                          Title="Country"/>

         <xcdg:DataGridItemProperty Name="ShipCity"
                                   Title="City"/>
        <xcdg:DataGridItemProperty Name="ShipAddress"
                                   Title="Address"/>
        <xcdg:DataGridItemProperty Name="ShipPostalCode"
                                   Title="Postal Code"/>

         <xcdg:DataGridItemProperty Name="ShipName"
                                   Title="Name"
                                   CalculateDistinctValues="False"/>
         <xcdg:DataGridItemProperty Name="OrderDate"
                                   Title="Order Date"
                                   CalculateDistinctValues="False"/>
         <xcdg:DataGridItemProperty Name="Freight"
                                   CalculateDistinctValues="False"/>
      </xcdg:DataGridCollectionViewSource.ItemProperties>
    </xcdg:DataGridCollectionViewSource>
</Grid.Resources>

<xcdg:DataGridControl x:Name="OrdersGrid"
ItemsSource="{Binding Source={StaticResource cvs_orders}}"/>
</Grid>

Filtering data items (Filter Event)

Xceed admin — Wed, 08 Oct 2008 19:53:45 GMT

The following example demonstrates how to filter the data items displayed in a grid using the Filter event. Only the data items whose ShipVia property value is "3" will be displayed in the grid.

<xcdg:DataGridControl x:Name="OrdersGrid"
ItemsSource="{Binding Source={StaticResource cvs_orders}}"/>
</Grid>

The following code provides the implementation of the ShipViaFilter event. This code should be placed in the "code-behind" of your XAML page.

VB.NET

Private Sub ShipViaFilter( sender As Object, e As FilterEventArgs )
Dim value As Object = CType( e.Item, System.Data.DataRow )( "ShipVia" )

If( Not value Is Nothing ) And ( Not value Is DBNull.Value ) Then
If CInt( value ) = 3 Then

e.Accepted = True
Else

e.Accepted = False
End If
End If

End Sub

C#

private void ShipViaFilter( object sender, FilterEventArgs e )
{
object value = ( ( System.Data.DataRow )e.Item )[ "ShipVia" ];

if( ( value != null ) && ( value != DBNull.Value ) )
{
    if( ( int )value == 3 )
    {
     e.Accepted = true;
    }
    else
    {
     e.Accepted = false;
    }
}
}

Using a masked text box

Xceed admin — Wed, 08 Oct 2008 19:53:21 GMT

The following example demonstrates how to use the MaskedTextBox control outside a grid to allow a user to input a fictious identity number. The foreground color of the masked text box will change from red when it contains invalid text (HasParsingError), to blue when all required characters have been inputted (IsMaskCompleted), to green when all characters, required and optional, have been inputted (IsMaskFull).

    <xcdg:MaskedTextBox Mask=">LLLL 000000 ??"
                        PromptChar="-"
                        AllowPromptAsInput="True"
                        ResetOnPrompt="True"
                        ResetOnSpace="True"
                        Height="Auto"/>
</Grid>

Entering edit when a cell is current

Xceed admin — Wed, 08 Oct 2008 19:53:11 GMT

The following example demonstrates how to enter edit mode only when a cell becomes current by setting the EditTriggers property to CellIsCurrent.

<xcdg:DataGridControl x:Name="OrdersGrid"
ItemsSource="{Binding Source={StaticResource cvs_orders}}"
EditTriggers="CellIsCurrent"/>
</Grid>