Get-OfficeExcelPivotTable

Namespace PSWriteOffice

Inputs

OfficeIMO.Excel.ExcelDocument

Outputs

System.Management.Automation.PSObject

Gets pivot tables defined in a workbook.

Remarks

Gets pivot tables defined in a workbook.

Examples

List pivot tables in a workbook.


PS>Get-OfficeExcelPivotTable -Path .\report.xlsx

Returns pivot table metadata (name, sheet, source range).

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

Get-OfficeExcelPivotTable -InputPath <String> [-Name <String>] [-Sheet <String>] [-SheetIndex <Nullable`1>] [<CommonParameters>]

Parameter set: Path

Parameters

InputPath String requiredposition: 0pipeline: Falsealiases: FilePath, Path: Path to the workbook.
Name String optionalposition: namedpipeline: False: Optional pivot table name filter.
Sheet String optionalposition: namedpipeline: False: Optional sheet name filter.
SheetIndex Nullable`1 optionalposition: namedpipeline: False: Optional sheet index (0-based) filter.

Outputs

System.Management.Automation.PSObject

Get-OfficeExcelPivotTable -Document <ExcelDocument> [-Name <String>] [-Sheet <String>] [-SheetIndex <Nullable`1>] [<CommonParameters>]

Parameter set: Document

Parameters

Document ExcelDocument requiredposition: namedpipeline: True (ByValue): Workbook to inspect.
Name String optionalposition: namedpipeline: False: Optional pivot table name filter.
Sheet String optionalposition: namedpipeline: False: Optional sheet name filter.
SheetIndex Nullable`1 optionalposition: namedpipeline: False: Optional sheet index (0-based) filter.

Outputs

System.Management.Automation.PSObject