Cmdlet

Add-OfficeExcelConditionalColorScale

Aliases: ExcelConditionalColorScale

Module: PSWriteOffice
Aliases: ExcelConditionalColorScale
Inputs: OfficeIMO.Excel.ExcelDocument
Source: AddOfficeExcelConditionalColorScaleCommand.cs:18 Edit on GitHub

Adds a two-color scale conditional format to a range.

Syntax

Add-OfficeExcelConditionalColorScale
[-EndColor] <String>
[-HeaderName <String>]
[-HeaderRow <Int32>]
[-IncludeHeader]
[-PassThru]
[-PivotTableName <String>]
[-PivotWholeTable]
[[-Range] <String>]
[-StartColor] <String>
[-TableName <String>]
[<CommonParameters>]

Parameter set: Context

Add-OfficeExcelConditionalColorScale
-Document <ExcelDocument>
[-EndColor] <String>
[-HeaderName <String>]
[-HeaderRow <Int32>]
[-IncludeHeader]
[-PassThru]
[-PivotTableName <String>]
[-PivotWholeTable]
[[-Range] <String>]
[-Sheet <String>]
[-SheetIndex <Int32>]
[-StartColor] <String>
[-TableName <String>]
[<CommonParameters>]

Parameter set: Document

Examples

Apply a red-to-green color scale.

ExcelSheet 'Data' { Add-OfficeExcelConditionalColorScale -Range 'B2:B50' -StartColor '#FF0000' -EndColor '#00FF00' }

Applies a red-to-green scale to column B.

Parameters

-EndColor String requiredposition: 2: End color. Named colors and hexadecimal values are accepted.
-HeaderName String optionalaliases: ColumnName: Header or table column name used to resolve the target range.
-HeaderRow Int32 optional: Worksheet header row used when resolving HeaderName without a table. Use 0 for the first row of the used range.
-IncludeHeader SwitchParameter optional: Include the header cell in the resolved range.
-PassThru SwitchParameter optional: Emit the range after applying the format.
-PivotTableName String optional: Pivot table name used to resolve the target range.
-PivotWholeTable SwitchParameter optional: Use the full pivot output range instead of the default data body range.
-Range String optionalposition: 0: A1 range to format.
-StartColor String requiredposition: 1: Start color. Named colors and hexadecimal values are accepted.
-TableName String optional: Optional table name for header-based range resolution.
-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.