Cmdlet

Add-OfficeExcelReportTable

Aliases: ExcelReportTable

Module PSWriteOffice

Aliases

ExcelReportTable

Inputs

System.Object

Source

OfficeExcelReportBlockCommands.cs:278 Edit on GitHub

Adds an object table to the current Excel report sheet using the OfficeIMO sheet composer.

Syntax

Add-OfficeExcelReportTable [-CollectionSeparator <String>] [-DictionaryEntrySeparator <String>] [-DictionaryKeyValueSeparator <String>] [-ExcludeProperty <String[]>] [-InputObject] <Object> [-MaxCollectionItems <Int32>] [-MaxNestingDepth <Int32>] [-NoAutoFilter] [-NoAutoFormatDynamicCollections] [-NoFreezeHeaderRow] [-NoRowStripes] [-PassThru] [-Property <String[]>] [-ShowColumnStripes] [-ShowFirstColumn] [-ShowLastColumn] [-TableStyle <ExcelTableStyle>] [[-Title] <String>] [<CommonParameters>]

Parameter set: All Parameter Sets

Examples

Authored help example

Add a styled report table from objects.

$rows = @(
    [pscustomobject]@{ Area = 'PDF'; Status = 'Ready' }
    [pscustomobject]@{ Area = 'Word'; Status = 'Review' }
)
New-OfficeExcel -Path .\Operations.xlsx {
    Add-OfficeExcelReportSheet -Name Summary {
        Add-OfficeExcelReportTable -InputObject $rows -Title 'Documentation coverage' -TableStyle TableStyleMedium9
    }
}

Renders object rows as a formatted Excel table through the sheet composer.

Parameters

-CollectionSeparator String optional: Text used between items when a cell contains a collection.
-DictionaryEntrySeparator String optional: Text used between entries when a cell contains a dictionary.
-DictionaryKeyValueSeparator String optional: Text used between a dictionary key and value.
-ExcludeProperty String[] optional: Properties to exclude from the rendered table.
-InputObject Object requiredposition: 0pipeline: True (ByValue)aliases: Data: Objects to flatten and render as a table.
-MaxCollectionItems Int32 optional: Maximum number of items allowed in one nested collection or dictionary cell. Defaults to 1,048,575; increase explicitly for trusted larger values.
-MaxNestingDepth Int32 optional: Maximum nesting depth allowed while normalizing one cell value. Defaults to 64; increase explicitly for trusted deeper values.
-NoAutoFilter SwitchParameter optional: Disable AutoFilter dropdowns.
-NoAutoFormatDynamicCollections SwitchParameter optional: Disable composer auto-formatting for dynamic collection columns.
-NoFreezeHeaderRow SwitchParameter optional: Do not freeze through the table header row.
-NoRowStripes SwitchParameter optional: Disable alternating row stripes for the generated table.
-PassThru SwitchParameter optional: Emit the A1 range used by the generated table.
-Property String[] optional: Properties to include, in the requested column order.
-ShowColumnStripes SwitchParameter optional: Enable alternating column stripes for the generated table.
-ShowFirstColumn SwitchParameter optional: Emphasize the first table column when the selected style supports it.
-ShowLastColumn SwitchParameter optional: Emphasize the last table column when the selected style supports it.
-TableStyle ExcelTableStyle optional: Built-in table style to apply.; Possible values: TableStyleLight1, TableStyleLight2, TableStyleLight3, TableStyleLight4, TableStyleLight5, TableStyleLight6, TableStyleLight7, TableStyleLight8, TableStyleLight9, TableStyleLight10, TableStyleLight11, TableStyleLight12, TableStyleLight13, TableStyleLight14, TableStyleLight15, TableStyleLight16, TableStyleLight17, TableStyleLight18, TableStyleLight19, TableStyleLight20, TableStyleLight21, TableStyleMedium1, TableStyleMedium2, TableStyleMedium3, TableStyleMedium4, TableStyleMedium5, TableStyleMedium6, TableStyleMedium7, TableStyleMedium8, TableStyleMedium9, TableStyleMedium10, TableStyleMedium11, TableStyleMedium12, TableStyleMedium13, TableStyleMedium14, TableStyleMedium15, TableStyleMedium16, TableStyleMedium17, TableStyleMedium18, TableStyleMedium19, TableStyleMedium20, TableStyleMedium21, TableStyleMedium22, TableStyleMedium23, TableStyleMedium24, TableStyleMedium25, TableStyleMedium26, TableStyleMedium27, TableStyleMedium28, TableStyleDark1, TableStyleDark2, TableStyleDark3, TableStyleDark4, TableStyleDark5, TableStyleDark6, TableStyleDark7, TableStyleDark8, TableStyleDark9, TableStyleDark10, TableStyleDark11
-Title String optionalposition: 1: Optional section title displayed above the table.

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.