Project

PSWriteOffice

PowerShell document automation across OfficeIMO's document, spreadsheet, presentation, PDF, Project, Access, EPUB, invoicing, and conversion engines.

View on GitHub Releases Get package
Stars 654
Forks 82
Open issues 1
Total downloads 4,320,051
Release OfficeIMO-v3.5.3
Language: C# Updated: 2026-11-03
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

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.