Cmdlet

Add-OfficeExcelReportCallout

Aliases: ExcelReportCallout

Module PSWriteOffice

Aliases

ExcelReportCallout

Inputs

None

Source

OfficeExcelReportBlockCommands.cs:140 Edit on GitHub

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

Syntax

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

Parameter set: All Parameter Sets

Examples

Authored help example

Add a warning callout to a report sheet.

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.

Parameters

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

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.