Set-OfficeExcelRowGroup

Aliases: ExcelRowGroup

Namespace PSWriteOffice

Aliases

ExcelRowGroup

Inputs

None

Outputs

System.Object

Source

Sources/PSWriteOffice/Cmdlets/Excel/SetOfficeExcelRowGroupCommand.cs:15 Edit on GitHub

Configures collapsible Excel outline grouping for worksheet rows.

Remarks

Configures collapsible Excel outline grouping for worksheet rows.

Examples

Authored help example

Group detail rows and collapse them.

PS>


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

Applies Excel row outline metadata using OfficeIMO.

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.

Syntax

Set-OfficeExcelRowGroup [-Clear] [-Collapsed] [-EndRow <Nullable`1>] [-Hidden] [-KeepHidden] [-OutlineLevel <Int32>] -StartRow <Int32> [-SummaryBelow <Nullable`1>] [<CommonParameters>]

Parameter set: All Parameter Sets

Parameters

Clear SwitchParameter optionalposition: namedpipeline: False: Clear row grouping metadata from the target range.
Collapsed SwitchParameter optionalposition: namedpipeline: False: Hide the grouped rows and mark the following summary row as collapsed.
EndRow Nullable`1 optionalposition: 1pipeline: False: Last 1-based row in the group. Defaults to StartRow.
Hidden SwitchParameter optionalposition: namedpipeline: False: Hide the grouped rows without marking the group collapsed.
KeepHidden SwitchParameter optionalposition: namedpipeline: False: Keep hidden rows hidden when clearing row grouping metadata.
OutlineLevel Int32 optionalposition: namedpipeline: False: Excel outline level from 1 through 7.
StartRow Int32 requiredposition: 0pipeline: False: First 1-based row in the group.
SummaryBelow Nullable`1 optionalposition: namedpipeline: False: Set whether row summary controls appear below grouped rows.

Outputs

System.Object