GridView.CollapseMasterRow(Int32, String) Method

Collapses a master row’s detail View, identified by the name of the relationship associated with it.

Namespace: DevExpress.XtraGrid.Views.Grid

Assembly: DevExpress.XtraGrid.v24.1.dll

NuGet Packages: DevExpress.Win.Grid, DevExpress.Win.Navigation

Declaration

C#

public void CollapseMasterRow(
    int rowHandle,
    string relationName
)

VB.NET

Public Sub CollapseMasterRow(
    rowHandle As Integer,
    relationName As String
)

Parameters

Name	Type	Description
rowHandle	Int32	An integer value identifying the master row by its handle.
relationName	String	A string representing the required relationship’s name.

Remarks

The CollapseMasterRow method can be used as an alternative to the GridView.SetMasterRowExpanded method which requires an additional parameter that specifies 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 from being collapsed the CollapseMasterRow method does nothing. If the row has been collapsed 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 Views that display real data within the Grid Control. Use the following methods to access these Views with which an end user interacts at runtime.

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