API Reference
Cmdlet
Add-OfficeExcelConditionalIconSet
Adds an icon set conditional format to a range.
Remarks
Adds an icon set conditional format to a range.
Examples
Example 1: 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 [-HeaderName <String>] [-HeaderRow <Int32>] [-IconSet <String>] [-IncludeHeader] [-NumberThresholds <Double[]>] [-PassThru] [-PercentThresholds <Double[]>] [-PivotTableName <String>] [-PivotWholeTable] [-Range <String>] [-Reverse <Boolean>] [-ShowValue <Boolean>] [-TableName <String>] [<CommonParameters>]Parameter set:
ContextParameters
- HeaderName String
- Header or table column name used to resolve the target range.
- HeaderRow Int32
- Worksheet header row used when resolving HeaderName without a table. Use 0 for the first row of the used range.
- IconSet String
- Icon set to apply.
- IncludeHeader SwitchParameter
- Include the header cell in the resolved range.
- NumberThresholds Double[]
- Number thresholds matching the icon count.
- PassThru SwitchParameter
- Emit the range after applying the format.
- PercentThresholds Double[]
- Percent thresholds (0..100) matching the icon count.
- PivotTableName String
- Pivot table name used to resolve the target range.
- PivotWholeTable SwitchParameter
- Use the full pivot output range instead of the default data body range.
- Range String
- A1 range to format.
- Reverse Boolean
- Reverse the icon order.
- ShowValue Boolean
- Show the underlying values.
- TableName String
- Optional table name for header-based range resolution.
Add-OfficeExcelConditionalIconSet -Document <ExcelDocument> [-HeaderName <String>] [-HeaderRow <Int32>] [-IconSet <String>] [-IncludeHeader] [-NumberThresholds <Double[]>] [-PassThru] [-PercentThresholds <Double[]>] [-PivotTableName <String>] [-PivotWholeTable] [-Range <String>] [-Reverse <Boolean>] [-Sheet <String>] [-SheetIndex <Nullable`1>] [-ShowValue <Boolean>] [-TableName <String>] [<CommonParameters>]Parameter set:
DocumentParameters
- Document ExcelDocument
- Workbook to operate on outside the DSL context.
- HeaderName String
- Header or table column name used to resolve the target range.
- HeaderRow Int32
- Worksheet header row used when resolving HeaderName without a table. Use 0 for the first row of the used range.
- IconSet String
- Icon set to apply.
- IncludeHeader SwitchParameter
- Include the header cell in the resolved range.
- NumberThresholds Double[]
- Number thresholds matching the icon count.
- PassThru SwitchParameter
- Emit the range after applying the format.
- PercentThresholds Double[]
- Percent thresholds (0..100) matching the icon count.
- PivotTableName String
- Pivot table name used to resolve the target range.
- PivotWholeTable SwitchParameter
- Use the full pivot output range instead of the default data body range.
- Range String
- A1 range to format.
- Reverse Boolean
- Reverse the icon order.
- Sheet String
- Worksheet name when using Document.
- SheetIndex Nullable`1
- Worksheet index (0-based) when using Document.
- ShowValue Boolean
- Show the underlying values.
- TableName String
- Optional table name for header-based range resolution.