API Reference

Cmdlet

Set-OfficeExcelSheetTabColor

Aliases: ExcelSheetTabColor
Namespace PSWriteOffice
Aliases
ExcelSheetTabColor
Inputs
OfficeIMO.Excel.ExcelDocument
Outputs
System.Object

Sets or clears the worksheet tab color.

Remarks

Sets or clears the worksheet tab color.

Examples

Authored help example

Set a worksheet tab color.

PS>


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

Applies the color to the active worksheet tab.

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-OfficeExcelSheetTabColor [-Clear] [-Color <String>] [-PassThru] [<CommonParameters>]
#
Parameter set: Context

Parameters

Clear SwitchParameter optionalposition: namedpipeline: False
Clear the worksheet tab color.
Color String optionalposition: 0pipeline: False
Named color, RGB hex, or RGBA hex value.
PassThru SwitchParameter optionalposition: namedpipeline: False
Emit the worksheet after applying the tab color.

Outputs

System.Object

Set-OfficeExcelSheetTabColor [-Clear] [-Color <String>] -Document <ExcelDocument> [-PassThru] [-Sheet <String>] [-SheetIndex <Nullable`1>] [<CommonParameters>]
#
Parameter set: Document

Parameters

Clear SwitchParameter optionalposition: namedpipeline: False
Clear the worksheet tab color.
Color String optionalposition: 0pipeline: False
Named color, RGB hex, or RGBA hex value.
Document ExcelDocument requiredposition: namedpipeline: True (ByValue)
Workbook to operate on outside the DSL context.
PassThru SwitchParameter optionalposition: namedpipeline: False
Emit the worksheet after applying the tab color.
Sheet String optionalposition: namedpipeline: False
Worksheet name when using Document.
SheetIndex Nullable`1 optionalposition: namedpipeline: False
Worksheet index (0-based) when using Document.

Outputs

System.Object