Add-OfficeExcelReportSheet

Aliases: ExcelReportSheet

Namespace PSWriteOffice

Aliases

ExcelReportSheet

Inputs

None

Outputs

System.Object

Source

Sources/PSWriteOffice/Cmdlets/Excel/AddOfficeExcelReportSheetCommand.cs:19 Edit on GitHub

Creates a worksheet through the OfficeIMO sheet composer and runs report-block cmdlets inside it.

Remarks

Creates a worksheet through the OfficeIMO sheet composer and runs report-block cmdlets inside it.

Examples

Authored help example

Create a composed report sheet.

PS>


New-OfficeExcel -Path .\report.xlsx {
                Add-OfficeExcelReportSheet -Name Summary {
                  Add-OfficeExcelReportTitle -Title 'Operational Summary' -Subtitle 'Current view'
                  Add-OfficeExcelReportKpiRow -InputObject @{ Ready = 12; Blocked = 2 }
                }
              }

Creates a report-oriented worksheet with title and KPI blocks.

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-OfficeExcelReportSheet [-AutoFitRows] [-Content <ScriptBlock>] [-KeyFillColor <String>] -Name <String> [-NoAutoFit] [-PassThru] [-SectionHeaderFillColor <String>] [<CommonParameters>]

Parameter set: All Parameter Sets

Parameters

AutoFitRows SwitchParameter optionalposition: namedpipeline: False: Auto-fit row heights during composer finalization.
Content ScriptBlock optionalposition: 1pipeline: False: Report block script to run inside the composer context.
KeyFillColor String optionalposition: namedpipeline: False: Override the key-cell fill color used by KPI and property blocks.
Name String requiredposition: 0pipeline: False: Name of the report worksheet to create.
NoAutoFit SwitchParameter optionalposition: namedpipeline: False: Skip composer auto-fit finalization.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the created worksheet.
SectionHeaderFillColor String optionalposition: namedpipeline: False: Override the section-header fill color.

Outputs

System.Object