Get-OfficeExcelTable

Namespace PSWriteOffice

Inputs

OfficeIMO.Excel.ExcelDocument

Outputs

System.Management.Automation.PSObject

Source

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

Gets Excel tables defined in a workbook.

Remarks

Gets Excel tables defined in a workbook.

Examples

Authored help example

Example 1: List tables and export table metadata.

PS>


$tables = Get-OfficeExcelTable -Path .\report.xlsx -Sheet Data
            $tables |
                Select-Object -Property Name, Sheet, Range |
                Export-Csv -Path .\ExcelTables.csv -NoTypeInformation

Returns table metadata for workbook documentation or generated-artifact proof.

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-OfficeExcelTable -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 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-OfficeExcelTable [-AllowHttp] [-Name <String>] [-Sheet <String>] [-SheetIndex <Nullable`1>] -Uri <Uri> [<CommonParameters>]

Parameter set: Uri

Parameters

AllowHttp SwitchParameter optionalposition: namedpipeline: False: Allow HTTP workbook downloads in addition to HTTPS.
Name String optionalposition: namedpipeline: False: Optional table name filter.
Sheet String optionalposition: namedpipeline: False: Optional sheet name filter.
SheetIndex Nullable`1 optionalposition: namedpipeline: False: Optional sheet index (0-based) filter.
Uri Uri requiredposition: 0pipeline: Falsealiases: Url: Remote workbook URI to inspect.

Outputs

System.Management.Automation.PSObject

Get-OfficeExcelTable -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 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