Share via

How to: Programmatically group rows in a worksheet

  • Article

Applies to: yesVisual Studio noVisual Studio for Mac

Note

This article applies to Visual Studio 2017. If you're looking for the latest Visual Studio documentation, see Visual Studio documentation. We recommend upgrading to the latest version of Visual Studio. Download it here

You can group one or more whole rows. To create a group in a worksheet, use a NamedRange control or a native Excel range object.

Applies to: The information in this topic applies to document-level projects and VSTO Add-in projects for Excel. For more information, see Features available by Office application and project type.

Use a NamedRange control

If you add a NamedRange control to a document-level project at design time, you can use the control to programmatically create a group. The following example assumes that there are three NamedRange controls on the same worksheet: data2001, data2002, and dataAll. Each named range refers to a whole row in the worksheet.

To create a group of NamedRange controls on a worksheet

  1. Group three named ranges by calling the Group method of each range. This code must be placed in a sheet class, not in the ThisWorkbook class.

    this.data2001.Group();

    With Me
    .data2001.Group()
    .data2002.Group()
    .dataAll.Group()
End With

    Note

    To ungroup rows, call the Ungroup method.

Use native Excel ranges

The code assumes that you have three Excel ranges named data2001, data2002, and dataAll on a worksheet.

To create a group of Excel ranges in a worksheet

  1. Group three named ranges by calling the Group method of each range. The following example assumes that there are three Range controls named data2001, data2002, and dataAll on the same worksheet. Each named range refers to a whole row in the worksheet.

    this.Application.get_Range("data2001");
    
this.Application.get_Range("data2002")
    .Group();

this.Application.get_Range("dataAll")
    .Group();

    With Me.Application
    .Range("data2001").Group()
    .Range("data2002").Group()
    .Range("dataAll").Group()
End With

    Note

    To ungroup rows, call the Ungroup method.

See also