Add-OfficeExcelTable

Aliases: ExcelTable

Namespace PSWriteOffice

Aliases

ExcelTable

Inputs

System.Object

Source

Sources/PSWriteOffice/Cmdlets/Excel/AddOfficeExcelTableCommand.cs:22 Edit on GitHub

Writes tabular data to the current worksheet and formats it as an Excel table.

Remarks

Accepts objects, dictionaries, DataTable/DataView/IDataReader inputs, or DataRow sequences and writes them into an Excel table with optional styling.

Examples

Authored help example

Example 1: Insert a table starting at A1.

PS>


$data = @([pscustomobject]@{ Region='NA'; Revenue=100 }, [pscustomobject]@{ Region='EMEA'; Revenue=150 })
              ExcelSheet 'Data' { Add-OfficeExcelTable -InputObject $data -TableName 'Sales' }

Writes two rows and formats them as a styled Excel 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.

Syntax

Add-OfficeExcelTable [-AutoFit] -InputObject <Object> [-NoAutoFilter] [-NoHeader] [-NoRowStripes] [-PassThru] [-ShowColumnStripes] [-ShowFirstColumn] [-ShowLastColumn] [-StartColumn <Int32>] [-StartRow <Int32>] [-TableName <String>] [-TableStyle <String>] [-View <Normal|Transpose>] [<CommonParameters>]

Parameter set: All Parameter Sets

Parameters

AutoFit SwitchParameter optionalposition: namedpipeline: False: Auto-fit the table columns after insertion.
InputObject Object requiredposition: 0pipeline: True (ByValue)aliases: Data, DataTable: Source objects, dictionaries, DataTable/DataView/IDataReader inputs, or DataRow sequences to convert into table rows.
NoAutoFilter SwitchParameter optionalposition: namedpipeline: False: Disable AutoFilter dropdowns.
NoHeader SwitchParameter optionalposition: namedpipeline: False: Skip writing headers.
NoRowStripes SwitchParameter optionalposition: namedpipeline: False: Disable alternating row stripes for the created table.
PassThru SwitchParameter optionalposition: namedpipeline: False: Return the created range string.
ShowColumnStripes SwitchParameter optionalposition: namedpipeline: False: Enable alternating column stripes for the created table.
ShowFirstColumn SwitchParameter optionalposition: namedpipeline: False: Emphasize the first table column when the selected style supports it.
ShowLastColumn SwitchParameter optionalposition: namedpipeline: False: Emphasize the last table column when the selected style supports it.
StartColumn Int32 optionalposition: namedpipeline: False: Starting column for the data (1-based).
StartRow Int32 optionalposition: namedpipeline: False: Starting row for the data (1-based).
TableName String optionalposition: namedpipeline: False: Name to assign to the table.
TableStyle String optionalposition: namedpipeline: False: Built-in table style to apply.
View OfficeTableView optionalposition: namedpipeline: Falsevalues: 2: Projection to apply before writing the table. Possible values: Normal, Transpose; Possible values: Normal, Transpose