GridView.CollapseAllDetails() Method

Closes all View’s details.

Namespace: DevExpress.XtraGrid.Views.Grid

Assembly: DevExpress.XtraGrid.v19.2.dll

Declaration

C#

public void CollapseAllDetails()

VB.NET

Public Sub CollapseAllDetails

Remarks

Use the CollapseAllDetails method to collapse all expanded master rows within the current View. Note that collapsing a master row results in destroying the corresponding detail clones. Thus, detail Views at all nesting levels are destroyed. When a particular detail clone is about to be destroyed, the grid control’s GridControl.ViewRemoved event is raised. After a master row has been collapsed, the View raises the GridView.MasterRowCollapsed event.

Note

Detail pattern Views do not contain data and they are never displayed within XtraGrid. So, the CollapseAllDetails member must not be invoked for these Views. The CollapseAllDetails 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 snippets (auto-collected from DevExpress Examples) contain references to the CollapseAllDetails() 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#

winforms-preserve-grid-state-on-refresh/CS/RefreshHelperClass.cs#L163

try {
    view.CollapseAllDetails();
    GridColumn column = view.Columns[keyFieldName];

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

{
    view.CollapseAllDetails();
}

how-to-preserve-the-xtragrid-view-state-in-multi-level-master-detail-e1466/CS/RefreshHelperClass.cs#L249

try {
    view.CollapseAllDetails();
    for (int i = 0; i < SaveMasterRowsList.Count; i++) {

VB.NET

winforms-preserve-grid-state-on-refresh/VB/RefreshHelperClass.vb#L172

Try
    view.CollapseAllDetails()
    Dim column As GridColumn = view.Columns(keyFieldName)

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

Private Sub CollapseAllMasterRows()
    view.CollapseAllDetails()
End Sub

how-to-preserve-the-xtragrid-view-state-in-multi-level-master-detail-e1466/VB/RefreshHelperClass.vb#L272

Try
    view.CollapseAllDetails()
    For i As Integer = 0 To SaveMasterRowsList.Count - 1