Cmdlet

Set-OfficeExcelColumnGroup

Aliases: ExcelColumnGroup

Module: PSWriteOffice
Aliases: ExcelColumnGroup
Inputs: None
Source: SetOfficeExcelColumnGroupCommand.cs:18 Edit on GitHub

Configures collapsible Excel outline grouping for worksheet columns.

Syntax

Set-OfficeExcelColumnGroup
[-Clear]
[-Collapsed]
[[-EndColumn] <Object>]
[-EndColumnName <String>]
[-Hidden]
[-KeepHidden]
[-OutlineLevel <Int32>]
[-PassThru]
[[-StartColumn] <Object>]
[-StartColumnName <String>]
[-SummaryRight <Boolean>]
[<CommonParameters>]

Parameter set: All Parameter Sets

Examples

Group detail columns and collapse them.

ExcelSheet 'Data' { Set-OfficeExcelColumnGroup -StartColumn B -EndColumn D -Collapsed }

Applies Excel column outline metadata using OfficeIMO.

Parameters

-Clear SwitchParameter optional: Clear column grouping metadata from the target range.
-Collapsed SwitchParameter optional: Hide the grouped columns and mark the following summary column as collapsed.
-EndColumn Object optionalposition: 1: Last 1-based column in the group. Defaults to the start column.
-EndColumnName String optionalaliases: EndColumnLetter: Last column letter in the group.
-Hidden SwitchParameter optional: Hide the grouped columns without marking the group collapsed.
-KeepHidden SwitchParameter optional: Keep hidden columns hidden when clearing column grouping metadata.
-OutlineLevel Int32 optional: Excel outline level from 1 through 7.
-PassThru SwitchParameter optional: Emit the object created or changed by the command.
-StartColumn Object optionalposition: 0aliases: Column: First 1-based column in the group.
-StartColumnName String optionalaliases: ColumnLetter, ColumnName, Letter, StartColumnLetter: First column letter in the group.
-SummaryRight Boolean optional: Set whether column summary controls appear to the right of grouped columns.

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.