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.v20.1.dll

Declaration

public bool IsMasterRowExpanded(
    int rowHandle,
    DetailDescriptorBase descriptor = null
)
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

Optional. 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.

Examples

This sample shows you a few members that allow expanding and collapsing master rows. Keyboard presses are processed to allow the CTRL+* shortcut to toggle the currently focused master row's state. There are also two buttons - one allowing expansion of all master rows, and another that collapses details for all but the focused row.

The following members are 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.
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 groupo row is focused
    If Not view.IsFocusedView OrElse view.FocusedRowHandle < 0 Then
        Return
    End If

    ' 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 buttonExpandAll_Click(ByVal sender As Object, ByVal e As RoutedEventArgs)
    For i As Integer = 0 To gridControl1.VisibleRowCount - 1
        Dim rowHandle = gridControl1.GetRowHandleByVisibleIndex(i)
        gridControl1.ExpandMasterRow(rowHandle)
    Next i
End Sub
Private Sub buttonCollapseAllButThis_Click(ByVal sender As Object, ByVal e As RoutedEventArgs)
    If tableView1.FocusedRowHandle >= 0 Then
        gridControl1.ExpandMasterRow(tableView1.FocusedRowHandle)
    End If
    For i As Integer = 0 To gridControl1.VisibleRowCount - 1
        Dim rowHandle As Integer = gridControl1.GetRowHandleByVisibleIndex(i)
        If rowHandle <> tableView1.FocusedRowHandle Then
            gridControl1.CollapseMasterRow(rowHandle)
        End If
    Next i
End Sub
See Also