Back to Devexpress

GridView.CollapseAllGroups() Method

windowsforms-devexpress-dot-xtragrid-dot-views-dot-grid-dot-gridview-b074b1c5.md

latest4.2 KB
Original Source

GridView.CollapseAllGroups() Method

Collapses all groups.

Namespace : DevExpress.XtraGrid.Views.Grid

Assembly : DevExpress.XtraGrid.v25.2.dll

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

Declaration

csharp
public virtual void CollapseAllGroups()
vb
Public Overridable Sub CollapseAllGroups

Remarks

The method collapses all group rows within the current View. Only the top level group rows are then visible. End-users can do this also by using the group panel context menu.

If you need to collapse a particular group row via code, use the GridView.SetRowExpanded method.

Note

Detail pattern Views do not contain data and they are never displayed within XtraGrid. So, the CollapseAllGroups member must not be invoked for these Views. The CollapseAllGroups 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.

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

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

csharp
try {
    view.CollapseAllGroups();
    foreach(RowInfo info in list)

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

vb
Try
    view.CollapseAllGroups()
    For Each info As RowInfo In list

See Also

SetRowExpanded

ExpandAllGroups()

GroupRowCollapsed

GroupRowCollapsing

Working with Groups in Code

GridView Class

GridView Members

DevExpress.XtraGrid.Views.Grid Namespace