DataControlDetailDescriptor Class

Represents a detail that displays a grid control and natively integrates with the master grid.

Assembly: DevExpress.Xpf.Grid.v21.2.Core.dll

NuGet Package: DevExpress.Wpf.Grid.Core

Declaration

C#
VB.NET

public class DataControlDetailDescriptor :
    DetailDescriptorBase,
    IDataControlOwner

Public Class DataControlDetailDescriptor
    Inherits DetailDescriptorBase
    Implements IDataControlOwner

Remarks

When setting up master-detail hierarchy, the Detail may display either another grid or custom controls. If you choose to display another grid, you will need to use the DataControlDetailDescriptor object in one of the following ways:

assign it to the master grid’s GridControl.DetailDescriptor property;
add it to the MultiDetailDescriptor.DetailDescriptors collection of a TabViewDetailDescriptor if you are setting up tabbed details.

The following are the main members that you will need to work with when using a DataControlDetailDescriptor:

Member	Description
DataControlDetailDescriptor.ItemsSourcePath	Gets or sets the detail grid’s data binding by specifying the path relative to the master grid’s records.
DataControlDetailDescriptor.DataControl	Gets or sets the GridControl that displays detail data.
DataViewBase.DetailHeaderContent	Gets or sets the detail section’s header content.

If you are using the DataControlDetailDescriptor to display a Detail, the following integration features become available:

Detail synchronization
Single scrollbar for both master and detail views
Common group panel displayed at the top of the master view
Common filter panel displayed at the bottom of the master view

Note

The DataControlDetailDescriptor does not support UI Automation.

Example

The following example shows how to create a new grid and set up Master-Detail data representation in code. When setting up a Master-Detail hierarchy, a detail grid and a custom detail section are placed within a tabbed container. So, the following Detail Descriptor types are used: DataControlDetailDescriptor, ContentDetailDescriptor, and TabViewDetailDescriptor.

View Example

<dxg:GridControl Grid.Row="0" Name="gridControl1" AutoGenerateColumns="AddNew" >
    <dxg:GridControl.View>
        <dxg:TableView DetailHeaderContent="Employees" AutoWidth="True" ShowGroupPanel="False"  />
    </dxg:GridControl.View>
    <dxg:GridControl.DetailDescriptor>
        <dxg:TabViewDetailDescriptor>
            <dxg:TabViewDetailDescriptor.DetailDescriptors>
                <dxg:DataControlDetailDescriptor ItemsSourcePath="Orders">
                    <dxg:DataControlDetailDescriptor.DataControl>
                        <dxg:GridControl AutoGenerateColumns="AddNew">
                            <dxg:GridControl.View>
                                <dxg:TableView DetailHeaderContent="Orders" AutoWidth="True" ShowGroupPanel="False" />
                            </dxg:GridControl.View>
                        </dxg:GridControl>
                    </dxg:DataControlDetailDescriptor.DataControl>
                </dxg:DataControlDetailDescriptor>
                <dxg:ContentDetailDescriptor ContentTemplate="{StaticResource EmployeeNotes}" HeaderContent="Notes">
                </dxg:ContentDetailDescriptor>
            </dxg:TabViewDetailDescriptor.DetailDescriptors>
        </dxg:TabViewDetailDescriptor>
    </dxg:GridControl.DetailDescriptor>
</dxg:GridControl>

private void Button_Click(object sender, RoutedEventArgs e)
{
    GridControl newGrid = CreateGrid();
    AddDetailsToGrid(newGrid);
    Grid.SetRow(newGrid, 2);
    mainGrid.Children.Add(newGrid);
}
private GridControl CreateGrid()
{
    GridControl newGrid = new GridControl();
    newGrid.AutoGenerateColumns = AutoGenerateColumnsMode.AddNew;
    newGrid.View = new TableView();
    (newGrid.View as TableView).AutoWidth = true;
    (newGrid.View as TableView).ShowGroupPanel = false;
    newGrid.View.DetailHeaderContent = "Employees";
    newGrid.ItemsSource = Employees;
    return newGrid;
}

private void AddDetailsToGrid(GridControl grid)
{
    DataControlDetailDescriptor dataControlDetail = new DataControlDetailDescriptor();
    dataControlDetail.ItemsSourcePath = "Orders";

    GridControl detailGrid = new GridControl();
    dataControlDetail.DataControl = detailGrid;
    detailGrid.AutoGenerateColumns = AutoGenerateColumnsMode.AddNew;
    detailGrid.View.DetailHeaderContent = "Orders";
    (detailGrid.View as TableView).ShowGroupPanel = false;

    ContentDetailDescriptor contentDetail = new ContentDetailDescriptor();
    contentDetail.ContentTemplate = (DataTemplate)FindResource("EmployeeNotes");
    contentDetail.HeaderContent = "Notes";

    TabViewDetailDescriptor tabDetail = new TabViewDetailDescriptor();
    tabDetail.DetailDescriptors.Add(dataControlDetail);
    tabDetail.DetailDescriptors.Add(contentDetail);

    grid.DetailDescriptor = tabDetail;
}

Private Sub Button_Click(ByVal sender As Object, ByVal e As RoutedEventArgs)
    Dim newGrid As GridControl = CreateGrid()
    AddDetailsToGrid(newGrid)
    Grid.SetRow(newGrid, 2)
    mainGrid.Children.Add(newGrid)
End Sub
Private Function CreateGrid() As GridControl
    Dim newGrid As New GridControl()
    newGrid.AutoGenerateColumns = AutoGenerateColumnsMode.AddNew
    newGrid.View = New TableView()
    TryCast(newGrid.View, TableView).AutoWidth = True
    TryCast(newGrid.View, TableView).ShowGroupPanel = False
    newGrid.View.DetailHeaderContent = "Employees"
    newGrid.ItemsSource = Employees
    Return newGrid
End Function

Private Sub AddDetailsToGrid(ByVal grid As GridControl)
    Dim dataControlDetail As New DataControlDetailDescriptor()
    dataControlDetail.ItemsSourcePath = "Orders"

    Dim detailGrid As New GridControl()
    dataControlDetail.DataControl = detailGrid
    detailGrid.AutoGenerateColumns = AutoGenerateColumnsMode.AddNew
    detailGrid.View.DetailHeaderContent = "Orders"
    TryCast(detailGrid.View, TableView).ShowGroupPanel = False

    Dim contentDetail As New ContentDetailDescriptor()
    contentDetail.ContentTemplate = CType(FindResource("EmployeeNotes"), DataTemplate)
    contentDetail.HeaderContent = "Notes"

    Dim tabDetail As New TabViewDetailDescriptor()
    tabDetail.DetailDescriptors.Add(dataControlDetail)
    tabDetail.DetailDescriptors.Add(contentDetail)

    grid.DetailDescriptor = tabDetail
End Sub

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

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

XAML

wpf-data-grid-bind-master-and-detail-focused-rows-to-viewmodel-properties/CS/Window1.xaml#L25

<dxg:GridControl.DetailDescriptor>
    <dxg:DataControlDetailDescriptor ItemsSourceBinding="{Binding Data}">
        <dxg:GridControl AutoPopulateColumns="True" Name="detail1"

wpf-data-grid-display-different-details-based-on-master-row-data/CS/WpfApp30/MainWindow.xaml#L19

<dxg:DetailDescriptorSelector.DefaultValue>
    <dxg:DataControlDetailDescriptor ItemsSourcePath="CompletedActions">
        <dxg:GridControl AutoGenerateColumns="AddNew">

wpf-data-grid-display-detail-content-in-tabs/CS/WpfApplication18/MainWindow.xaml#L18

<dxg:TabViewDetailDescriptor>
    <dxg:DataControlDetailDescriptor ItemsSourcePath="Orders">
        <dxg:DataControlDetailDescriptor.DataControl>

wpf-data-grid-display-chart-control-in-grid-details/CS/WpfApplication19/MainWindow.xaml#L54

<dxg:ContentDetailDescriptor ContentTemplate="{StaticResource ContentDetail}" HeaderContent="ContentDetailDescriptor"/>
<dxg:DataControlDetailDescriptor ContentTemplate="{StaticResource ContentDetail}" ItemsSourcePath="Orders">
    <dxg:GridControl AutoGenerateColumns="AddNew">

wpf-data-grid-expand-and-collapse-master-rows/CS/WpfApplication21/MainWindow.xaml#L15

<dxg:GridControl.DetailDescriptor>
    <dxg:DataControlDetailDescriptor ItemsSourcePath="Orders">
        <dxg:DataControlDetailDescriptor.DataControl>