OfficeIMO

API Reference

Command

Add-OfficeExcelConditionalIconSet

Namespace PSWriteOffice
Inputs
OfficeIMO.Excel.ExcelDocument
Outputs
System.Object

Adds an icon set conditional format to a range.

Remarks

Adds an icon set conditional format to a range.

Examples

Add traffic light icons.


PS>ExcelSheet 'Data' { Add-OfficeExcelConditionalIconSet -Range 'E2:E50' -IconSet ThreeTrafficLights1 }

Applies a traffic-light icon set.

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

Add-OfficeExcelConditionalIconSet [-IconSet <String>] [-NumberThresholds <Double[]>] [-PassThru] [-PercentThresholds <Double[]>] -Range <String> [-Reverse <Boolean>] [-ShowValue <Boolean>] [<CommonParameters>]
#
Parameter set: Context

Parameters

IconSet String optionalposition: namedpipeline: False
Icon set to apply.
NumberThresholds Double[] optionalposition: namedpipeline: False
Number thresholds matching the icon count.
PassThru SwitchParameter optionalposition: namedpipeline: False
Emit the range after applying the format.
PercentThresholds Double[] optionalposition: namedpipeline: False
Percent thresholds (0..100) matching the icon count.
Range String requiredposition: 0pipeline: False
A1 range to format.
Reverse Boolean optionalposition: namedpipeline: False
Reverse the icon order.
ShowValue Boolean optionalposition: namedpipeline: False
Show the underlying values.

Outputs

System.Object

Add-OfficeExcelConditionalIconSet -Document <ExcelDocument> [-IconSet <String>] [-NumberThresholds <Double[]>] [-PassThru] [-PercentThresholds <Double[]>] -Range <String> [-Reverse <Boolean>] [-Sheet <String>] [-SheetIndex <Nullable`1>] [-ShowValue <Boolean>] [<CommonParameters>]
#
Parameter set: Document

Parameters

Document ExcelDocument requiredposition: namedpipeline: True (ByValue)
Workbook to operate on outside the DSL context.
IconSet String optionalposition: namedpipeline: False
Icon set to apply.
NumberThresholds Double[] optionalposition: namedpipeline: False
Number thresholds matching the icon count.
PassThru SwitchParameter optionalposition: namedpipeline: False
Emit the range after applying the format.
PercentThresholds Double[] optionalposition: namedpipeline: False
Percent thresholds (0..100) matching the icon count.
Range String requiredposition: 0pipeline: False
A1 range to format.
Reverse Boolean optionalposition: namedpipeline: False
Reverse the icon order.
Sheet String optionalposition: namedpipeline: False
Worksheet name when using Document.
SheetIndex Nullable`1 optionalposition: namedpipeline: False
Worksheet index (0-based) when using Document.
ShowValue Boolean optionalposition: namedpipeline: False
Show the underlying values.

Outputs

System.Object