GridView.CollapseMasterRow(Int32) Method

Collapses the specified master row.

Namespace: DevExpress.XtraGrid.Views.Grid

Assembly: DevExpress.XtraGrid.v18.2.dll

Declaration

C#

public void CollapseMasterRow(
    int rowHandle
)

VB.NET

Public Sub CollapseMasterRow(
    rowHandle As Integer
)

Parameters

Name	Type	Description
rowHandle	Int32	An integer value specifying the handle of the master row to be collapsed.

Remarks

The CollapseMasterRow method can be used as an alternative to the GridView.SetMasterRowExpanded method. The latter requires an additional parameter specifying how the row’s expanded state should be changed.

Before a master row is collapsed, the GridView.MasterRowCollapsing event is raised. If the event handler prohibits row collapsing, the CollapseMasterRow method does nothing. If the row has been collapsed successfully, the GridView.MasterRowCollapsed event is raised.

Please refer to the Master-Detail Relationships topic for additional information.

Note

Detail pattern Views do not contain data and they are never displayed within XtraGrid. So, the CollapseMasterRow member must not be invoked for these Views. The CollapseMasterRow member can only be used with real Views that are displayed within the Grid Control. The real Views with which an end-user interacts at runtime can be accessed using the following methods.

• GridControl.MainView - returns the top most View in a grid;
• GridControl.FocusedView - returns the focused View;
• GridControl.DefaultView - returns the currently maximized View;
• the sender parameter of View specific events;
• GridView.GetDetailView - returns a detail clone View for a specific master row.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the CollapseMasterRow(Int32) 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#

how-to-manage-the-expanded-rows-collection-when-the-master-detail-functionality-is-used-t470064/CS/View/CategoryView.cs#L167

{
    view.CollapseMasterRow(GetRowHandle(categoryID));
}

VB.NET

how-to-manage-the-expanded-rows-collection-when-the-master-detail-functionality-is-used-t470064/VB/View/CategoryView.vb#L158

Private Sub CollapseMasterRow(ByVal categoryID As Integer)
    view.CollapseMasterRow(GetRowHandle(categoryID))
End Sub