Add-OfficeExcelReportCallout

Aliases: ExcelReportCallout

Namespace PSWriteOffice

Aliases

ExcelReportCallout

Inputs

None

Source

Sources/PSWriteOffice/Cmdlets/Excel/OfficeExcelReportBlockCommands.cs:140 Edit on GitHub

Adds a colored callout block to the current Excel report sheet.

Remarks

Adds a colored callout block to the current Excel report sheet.

Examples

Authored help example

Add a warning callout to a report sheet.

PS>


New-OfficeExcel -Path .\Operations.xlsx {
                Add-OfficeExcelReportSheet -Name Summary {
                    Add-OfficeExcelReportCallout -Kind Warning -Title 'Manual validation' -Body 'Open the workbook in desktop Excel before publishing pivot-heavy reports.'
                }
            }

Renders a composer callout block using the current report theme.

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-OfficeExcelReportCallout -Body <String> [-Kind <Info|Success|Warning|Error|Critical>] [-PassThru] -Title <String> [-WidthColumns <Int32>] [<CommonParameters>]

Parameter set: All Parameter Sets

Parameters

Body String requiredposition: 2pipeline: False: Callout body text.
Kind OfficeExcelReportCalloutKind optionalposition: 0pipeline: Falsevalues: 5: Callout kind. Supported values include info, success, warning, error, and critical.; Possible values: Info, Success, Warning, Error, Critical
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the object created or changed by the command.
Title String requiredposition: 1pipeline: False: Callout title.
WidthColumns Int32 optionalposition: namedpipeline: False: Width of the highlighted callout band in worksheet columns.