Add-OfficeExcelConditionalDataBar

Aliases: ExcelConditionalDataBar

Namespace PSWriteOffice

Aliases

ExcelConditionalDataBar

Inputs

OfficeIMO.Excel.ExcelDocument

Source

Sources/PSWriteOffice/Cmdlets/Excel/AddOfficeExcelConditionalDataBarCommand.cs:17 Edit on GitHub

Adds a data bar conditional format to a range.

Remarks

Adds a data bar conditional format to a range.

Examples

Authored help example

Example 1: Add blue data bars.

PS>


ExcelSheet 'Data' { Add-OfficeExcelConditionalDataBar -Range 'D2:D50' -Color '#4F81BD' }

Applies data bars to column D.

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-OfficeExcelConditionalDataBar -Color <String> [-HeaderName <String>] [-HeaderRow <Int32>] [-IncludeHeader] [-PassThru] [-PivotTableName <String>] [-PivotWholeTable] [-Range <String>] [-TableName <String>] [<CommonParameters>]

Parameter set: Context

Parameters

Color String requiredposition: 1pipeline: False: Bar color in hex (#RRGGBB or FFRRGGBB).
HeaderName String optionalposition: namedpipeline: Falsealiases: ColumnName: Header or table column name used to resolve the target range.
HeaderRow Int32 optionalposition: namedpipeline: False: Worksheet header row used when resolving HeaderName without a table. Use 0 for the first row of the used range.
IncludeHeader SwitchParameter optionalposition: namedpipeline: False: Include the header cell in the resolved range.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the range after applying the format.
PivotTableName String optionalposition: namedpipeline: False: Pivot table name used to resolve the target range.
PivotWholeTable SwitchParameter optionalposition: namedpipeline: False: Use the full pivot output range instead of the default data body range.
Range String optionalposition: 0pipeline: False: A1 range to format.
TableName String optionalposition: namedpipeline: False: Optional table name for header-based range resolution.

Add-OfficeExcelConditionalDataBar -Color <String> -Document <ExcelDocument> [-HeaderName <String>] [-HeaderRow <Int32>] [-IncludeHeader] [-PassThru] [-PivotTableName <String>] [-PivotWholeTable] [-Range <String>] [-Sheet <String>] [-SheetIndex <Nullable`1>] [-TableName <String>] [<CommonParameters>]

Parameter set: Document

Parameters

Color String requiredposition: 1pipeline: False: Bar color in hex (#RRGGBB or FFRRGGBB).
Document ExcelDocument requiredposition: namedpipeline: True (ByValue): Workbook to operate on outside the DSL context.
HeaderName String optionalposition: namedpipeline: Falsealiases: ColumnName: Header or table column name used to resolve the target range.
HeaderRow Int32 optionalposition: namedpipeline: False: Worksheet header row used when resolving HeaderName without a table. Use 0 for the first row of the used range.
IncludeHeader SwitchParameter optionalposition: namedpipeline: False: Include the header cell in the resolved range.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the range after applying the format.
PivotTableName String optionalposition: namedpipeline: False: Pivot table name used to resolve the target range.
PivotWholeTable SwitchParameter optionalposition: namedpipeline: False: Use the full pivot output range instead of the default data body range.
Range String optionalposition: 0pipeline: False: A1 range to format.
Sheet String optionalposition: namedpipeline: False: Worksheet name when using Document.
SheetIndex Nullable`1 optionalposition: namedpipeline: False: Worksheet index (0-based) when using Document.
TableName String optionalposition: namedpipeline: False: Optional table name for header-based range resolution.