Add-OfficeExcelReportTitle

Aliases: ExcelReportTitle

Namespace PSWriteOffice

Aliases

ExcelReportTitle

Inputs

None

Source

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

Adds a title block to the current Excel report sheet.

Remarks

Adds a title block to the current Excel report sheet.

Examples

Authored help example

Add a polished title to a report sheet.

PS>


New-OfficeExcel -Path .\Operations.xlsx {
                Add-OfficeExcelReportSheet -Name Summary {
                    Add-OfficeExcelReportTitle -Title 'Operational Summary' -Subtitle 'Current month'
                    Add-OfficeExcelReportKpiRow -InputObject @{ Revenue = 125000; Incidents = 3; Status = 'Ready' }
                }
            }

Uses the OfficeIMO sheet composer through PSWriteOffice's thin report-block wrapper.

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-OfficeExcelReportTitle [-PassThru] [-Subtitle <String>] -Title <String> [<CommonParameters>]

Parameter set: All Parameter Sets

Parameters

PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the object created or changed by the command.
Subtitle String optionalposition: 1pipeline: False: Optional subtitle text.
Title String requiredposition: 0pipeline: False: Title text.