GridControl.IsMasterRowExpanded(Int32, DetailDescriptorBase) Method

Determines the specified master row’s expanded state and, optionally, the specified Detail’s visibility.

Namespace: DevExpress.Xpf.Grid

Assembly: DevExpress.Xpf.Grid.v23.2.dll

NuGet Package: DevExpress.Wpf.Grid.Core

Declaration

C#

public bool IsMasterRowExpanded(
    int rowHandle,
    DetailDescriptorBase descriptor = null
)

VB.NET

Public Function IsMasterRowExpanded(
    rowHandle As Integer,
    descriptor As DetailDescriptorBase = Nothing
) As Boolean

Parameters

Name	Type	Description
rowHandle	Int32	An integer value specifying the master row by its value. If an invalid row handle is specified, the method returns false.

Optional Parameters

Name	Type	Default	Description
descriptor	DetailDescriptorBase	null	A DetailDescriptorBase descendant specifying the detail view whose visibility needs to be checked. If the master row is expanded but a different detail is currently visible, the method returns false. The same happens if you pass an object that doesn’t represent the specified master row’s detail.

Returns

Type	Description
Boolean	true if the specified master row is expanded and the specified detail is visible; otherwise, false.

Remarks

To change a master row’s expanded state or switch between available Details, use the following methods: GridControl.ExpandMasterRow, GridControl.CollapseMasterRow, GridControl.SetMasterRowExpanded.

Example

This example demonstrates how to expand and collapse the GridControl‘s master rows in code. The example contains the following buttons:

• The Expand All button expands all master rows.
• The Collapse All button collapses all master rows.
• The Collapse All But This button collapses all master rows except for the focused row / row with the focused detail.

The CTRL+* shortcut is bound to toggle the focused master row’s expanded state.

View Example: Expand and Collapse Master Rows

The following table lists members used in this example:

Member	Description
GridControl.CollapseMasterRow	Collapses the detail section for the specified row.
GridControl.ExpandMasterRow	Expands the specified master row and, optionally, shows the specified Detail.
GridControl.IsMasterRowExpanded	Determines the specified master row’s expanded state and, optionally, the specified Detail’s visibility.
GridControl.SetMasterRowExpanded	Changes the expanded state for a specified master row and, optionally, shows a specified Detail.

XAML

<dxg:GridControl x:Name="grid" AutoGenerateColumns="AddNew" Grid.Column="0">
    <dxg:GridControl.View>
        <dxg:TableView x:Name="view" AutoWidth="True" ShowGroupPanel="False" PreviewKeyDown="TableView_KeyDown"/>
    </dxg:GridControl.View>
    <dxg:GridControl.DetailDescriptor>
        <dxg:DataControlDetailDescriptor ItemsSourcePath="Orders">
            <dxg:DataControlDetailDescriptor.DataControl>
                <dxg:GridControl AutoGenerateColumns="AddNew">
                    <dxg:GridControl.View>
                        <dxg:TableView AutoWidth="True" ShowGroupPanel="False"/>
                    </dxg:GridControl.View>
                </dxg:GridControl>
            </dxg:DataControlDetailDescriptor.DataControl>
        </dxg:DataControlDetailDescriptor>
    </dxg:GridControl.DetailDescriptor>
</dxg:GridControl>

<StackPanel Grid.Column="1" Orientation="Vertical" Margin="10,10,10,10">
    <Button Click="ExpandAll" Content="Expand All" Margin="0,10,0,0"/>
    <Button Click="CollapseAll" Content="Collapse All" Margin="0,10,0,0"/>
    <Button Click="CollapseAllButThis" Content="Collapse All But This"  Margin="0,10,0,0"/>
    <TextBlock TextWrapping="Wrap" Margin="0,30,0,0">
        Press <Bold>CTRL+*</Bold> to toggle the focused master row's expanded state.
    </TextBlock>
</StackPanel>

C#

private void TableView_KeyDown(object sender, KeyEventArgs e) {
    TableView view = sender as TableView;

    // Avoid key processing when focus is within detail views or when a group row is focused:
    if (!view.IsFocusedView || view.FocusedRowHandle < 0)
        return;

    // Process CTRL+* key combination:
    if (e.Key == Key.Multiply && ((Keyboard.Modifiers & ModifierKeys.Control) == ModifierKeys.Control)) {
        bool finalExpandedState = !view.Grid.IsMasterRowExpanded(view.FocusedRowHandle);
        view.Grid.SetMasterRowExpanded(view.FocusedRowHandle, finalExpandedState);
        e.Handled = true;
    }
}

void ExpandAll(object sender, RoutedEventArgs e) {
    for (int i = 0; i < grid.VisibleRowCount; i++) {
        var rowHandle = grid.GetRowHandleByVisibleIndex(i);
        grid.ExpandMasterRow(rowHandle);
    }
}

void CollapseAll(object sender, RoutedEventArgs e) {
    for (int i = 0; i < grid.VisibleRowCount; i++) {
        var rowHandle = grid.GetRowHandleByVisibleIndex(i);
        grid.CollapseMasterRow(rowHandle);
    }
}

void CollapseAllButThis(object sender, RoutedEventArgs e) {
    for (int i = 0; i < grid.VisibleRowCount; i++) {
        var rowHandle = grid.GetRowHandleByVisibleIndex(i);
        var detailGrid = grid.GetVisibleDetail(rowHandle);
        if (detailGrid != null) {
            var detailView = ((GridControl)detailGrid).View;
            var focusedDetailRowHandle = ((TableView)detailView).FocusedRowHandle;
            if (focusedDetailRowHandle == DataControlBase.InvalidRowHandle && rowHandle != view.FocusedRowHandle)
                grid.CollapseMasterRow(rowHandle);
        }
    }
}

VB.NET

Private Sub TableView_KeyDown(ByVal sender As Object, ByVal e As KeyEventArgs)
    Dim view As TableView = TryCast(sender, TableView)
    ' Avoid key processing when focus is within detail views or when a group row is focused:
    If Not view.IsFocusedView OrElse view.FocusedRowHandle < 0 Then Return
    ' Process CTRL+* key combination:
    If e.Key = Key.Multiply AndAlso (Keyboard.Modifiers And ModifierKeys.Control) = ModifierKeys.Control Then
        Dim finalExpandedState As Boolean = Not view.Grid.IsMasterRowExpanded(view.FocusedRowHandle)
        view.Grid.SetMasterRowExpanded(view.FocusedRowHandle, finalExpandedState)
        e.Handled = True
    End If
End Sub

Private Sub ExpandAll(ByVal sender As Object, ByVal e As RoutedEventArgs)
    For i As Integer = 0 To Me.grid.VisibleRowCount - 1
        Dim rowHandle = Me.grid.GetRowHandleByVisibleIndex(i)
        Me.grid.ExpandMasterRow(rowHandle)
    Next
End Sub

Private Sub CollapseAll(ByVal sender As Object, ByVal e As RoutedEventArgs)
    For i As Integer = 0 To Me.grid.VisibleRowCount - 1
        Dim rowHandle = Me.grid.GetRowHandleByVisibleIndex(i)
        Me.grid.CollapseMasterRow(rowHandle)
    Next
End Sub

Private Sub CollapseAllButThis(ByVal sender As Object, ByVal e As RoutedEventArgs)
    For i As Integer = 0 To Me.grid.VisibleRowCount - 1
        Dim rowHandle = Me.grid.GetRowHandleByVisibleIndex(i)
        Dim detailGrid = Me.grid.GetVisibleDetail(rowHandle)
        If detailGrid IsNot Nothing Then
            Dim detailView = CType(detailGrid, GridControl).View
            Dim focusedDetailRowHandle = CType(detailView, TableView).FocusedRowHandle
            If focusedDetailRowHandle = DataControlBase.InvalidRowHandle AndAlso rowHandle <> Me.view.FocusedRowHandle Then Me.grid.CollapseMasterRow(rowHandle)
        End If
    Next
End Sub

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the IsMasterRowExpanded(Int32, DetailDescriptorBase) method.

Note

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

C#

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

if (e.Key == Key.Multiply && ((Keyboard.Modifiers & ModifierKeys.Control) == ModifierKeys.Control)) {
    bool finalExpandedState = !view.Grid.IsMasterRowExpanded(view.FocusedRowHandle);
    view.Grid.SetMasterRowExpanded(view.FocusedRowHandle, finalExpandedState);

VB.NET

wpf-data-grid-expand-and-collapse-master-rows/VB/WpfApplication21/MainWindow.xaml.vb#L23

If e.Key = Key.Multiply AndAlso (Keyboard.Modifiers And ModifierKeys.Control) = ModifierKeys.Control Then
    Dim finalExpandedState As Boolean = Not view.Grid.IsMasterRowExpanded(view.FocusedRowHandle)
    view.Grid.SetMasterRowExpanded(view.FocusedRowHandle, finalExpandedState)