Cmdlet

Set-OfficeExcelRowGroup

Aliases: ExcelRowGroup

Module PSWriteOffice

Aliases

ExcelRowGroup

Inputs

None

Source

SetOfficeExcelRowGroupCommand.cs:17 Edit on GitHub

Configures collapsible Excel outline grouping for worksheet rows.

Syntax

Set-OfficeExcelRowGroup [-Clear] [-Collapsed] [[-EndRow] <Int32>] [-Hidden] [-KeepHidden] [-OutlineLevel <Int32>] [-PassThru] [-StartRow] <Int32> [-SummaryBelow <Boolean>] [<CommonParameters>]

Parameter set: All Parameter Sets

Examples

Authored help example

Group detail rows and collapse them.

ExcelSheet 'Data' { Set-OfficeExcelRowGroup -StartRow 2 -EndRow 20 -Collapsed }

Applies Excel row outline metadata using OfficeIMO.

Parameters

-Clear SwitchParameter optional: Clear row grouping metadata from the target range.
-Collapsed SwitchParameter optional: Hide the grouped rows and mark the following summary row as collapsed.
-EndRow Int32 optionalposition: 1: Last 1-based row in the group. Defaults to StartRow.
-Hidden SwitchParameter optional: Hide the grouped rows without marking the group collapsed.
-KeepHidden SwitchParameter optional: Keep hidden rows hidden when clearing row grouping metadata.
-OutlineLevel Int32 optional: Excel outline level from 1 through 7.
-PassThru SwitchParameter optional: Emit the object created or changed by the command.
-StartRow Int32 requiredposition: 0: First 1-based row in the group.
-SummaryBelow Boolean optional: Set whether row summary controls appear below grouped rows.

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.