Cmdlet

Set-OfficeExcelSheetTabColor

Aliases: ExcelSheetTabColor

Module PSWriteOffice

Aliases

ExcelSheetTabColor

Inputs

OfficeIMO.Excel.ExcelDocument

Source

SetOfficeExcelSheetTabColorCommand.cs:16 Edit on GitHub

Sets or clears the worksheet tab color.

Syntax

Set-OfficeExcelSheetTabColor [-Clear] [[-Color] <String>] [-PassThru] [<CommonParameters>]

Parameter set: Context

Set-OfficeExcelSheetTabColor [-Clear] [[-Color] <String>] -Document <ExcelDocument> [-PassThru] [-Sheet <String>] [-SheetIndex <Int32>] [<CommonParameters>]

Parameter set: Document

Examples

Authored help example

Set a worksheet tab color.

ExcelSheet 'Data' { Set-OfficeExcelSheetTabColor -Color '#336699' }

Applies the color to the active worksheet tab.

Parameters

-Clear SwitchParameter optional: Clear the worksheet tab color.
-Color String optionalposition: 0: Named color, RGB hex, or RGBA hex value.
-PassThru SwitchParameter optional: Emit the worksheet after applying the tab color.
-Document ExcelDocument requiredpipeline: True (ByValue)sets: Document: Workbook to operate on outside the DSL context.
-Sheet String optionalsets: Document: Worksheet name when using Document.
-SheetIndex Int32 optionalsets: Document: Worksheet index (0-based) when using Document.

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.