Cmdlet

Get-OfficeExcelTable

Module: PSWriteOffice
Inputs: OfficeIMO.Excel.ExcelDocument System.String[]
Source: GetOfficeExcelTableCommand.cs:27 Edit on GitHub

Lists the tables defined in a workbook.

Syntax

Get-OfficeExcelTable
[-Document <ExcelDocument>]
[-Name <String>]
[-Sheet <OfficeSheetSelector>]
[<CommonParameters>]

Parameter set: Document

Get-OfficeExcelTable
[-Name <String>]
[-Path] <String[]>
[-Sheet <OfficeSheetSelector>]
[<CommonParameters>]

Parameter set: Path

Get-OfficeExcelTable
-LiteralPath <String[]>
[-Name <String>]
[-Sheet <OfficeSheetSelector>]
[<CommonParameters>]

Parameter set: LiteralPath

Get-OfficeExcelTable
[-AllowHttp]
[-Name <String>]
[-Sheet <OfficeSheetSelector>]
[-Uri] <Uri>
[<CommonParameters>]

Parameter set: Uri

Examples

List the tables in a workbook

Get-OfficeExcelTable -Path .\Reports\Q3-Sales.xlsx

Shows every table with its sheet, range and style.

Inventory the tables across report files

Get-ChildItem -Path .\Reports -Filter *.xlsx |
                Get-OfficeExcelTable |
                Select-Object SheetName, Name, Range, StyleName

Lists the tables of every workbook in the Reports folder with where they live, to plan which ones a dashboard should read.

Parameters

-Document ExcelDocument optionalpipeline: True (ByValue)sets: Document: Caller-owned workbook; omission uses the enclosing Excel content block.
-Name String optional: Optional table name filter.
-Sheet OfficeSheetSelector optionalaliases: WorksheetName: Worksheet name, one-based position or native worksheet object. Multi-sheet commands also accept wildcard names.
-Path String[] requiredposition: 0pipeline: True (ByValue)aliases: FilePathsets: Path: Workbook paths resolved with filesystem wildcard support.
-LiteralPath String[] requiredpipeline: True (ByPropertyName)aliases: FullName, PSPathsets: LiteralPath: Literal workbook paths, including FileInfo.FullName and provider PSPath.
-AllowHttp SwitchParameter optionalsets: Uri: Allow HTTP workbook downloads in addition to HTTPS.
-Uri Uri requiredposition: 0sets: Uri: Remote workbook URI to inspect.

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.