Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, PowerShell module, CLI, Studio and browser tools 606 stars

Talk and help

DiscordQuestions, ideas and show and tell Report an issueBugs and feature requests SponsorFund ongoing development

Mode

Background

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Search the whole siteOpen search page →
Documentation Search all OfficeIMO/
Cmdlet

Get-OfficeDocumentTable

Aliases: Read-OfficeDocumentTable
Module PSWriteOffice
Aliases
Read-OfficeDocumentTable
Inputs
System.String
Outputs
OfficeIMO.Reader.ReaderTable OfficeIMO.Reader.ReaderTableExportBundle OfficeIMO.Reader.ReaderTableMaterializedExport
Source
GetOfficeDocumentTableCommand.cs:19 Edit on GitHub

Reads structured tables discovered by OfficeIMO.Reader from a supported document.

Syntax

Get-OfficeDocumentTable [-AsExport] [-ExcelA1Range <String>] [-ExcelChunkRows <Int32>] [-ExcelSheetName <String>] [-ExcludePowerPointNotes] [-ExcludeWordFootnotes] [-Indented] [-MaxChars <Int32>] [-MaxInputBytes <Int64>] [-MaxTableRows <Int32>] [-NoCsv] [-NoExcelHeaders] [-NoHashes] [-NoJson] [-NoMarkdown] [-NoMarkdownHeadingChunks] [-NoOverwrite] [-OpenXmlMaxCharactersInPart <Int64>] [-OutputDirectory <String>] [-Path] <String> [-Reader <OfficeDocumentReader>] [<CommonParameters>]
#
Parameter set: All Parameter Sets

Guides & Samples

Authored walkthroughs and practical samples linked to this command.

Examples

Authored help example

Export discovered tables as sidecars.

$tables = Get-OfficeDocumentTable -Path .\Workbook.xlsx -AsExport -OutputDirectory .\reader-tables -Indented
$tables | Select-Object Id, CsvPath, JsonPath

Reads tables from a supported document and writes deterministic CSV, Markdown, and JSON sidecars.

Parameters

-AsExport SwitchParameter optional
Return deterministic CSV, Markdown, and JSON export bundles instead of table models.
-ExcelA1Range String optional
Optional Excel A1 range to read.
-ExcelChunkRows Int32 optional
Excel rows per emitted worksheet chunk.
-ExcelSheetName String optional
Optional Excel sheet name to read.
-ExcludePowerPointNotes SwitchParameter optional
Exclude PowerPoint speaker notes.
-ExcludeWordFootnotes SwitchParameter optional
Exclude Word footnotes.
-Indented SwitchParameter optional
Indent JSON payloads in export bundles and sidecars.
-MaxChars Int32 optional
Maximum emitted chunk characters.
-MaxInputBytes Int64 optional
Maximum input size in bytes.
-MaxTableRows Int32 optional
Maximum table rows per emitted table.
-NoCsv SwitchParameter optional
Do not write CSV sidecars when -OutputDirectory is used.
-NoExcelHeaders SwitchParameter optional
Treat the first Excel row as data instead of headers.
-NoHashes SwitchParameter optional
Disable source and chunk hash computation.
-NoJson SwitchParameter optional
Do not write JSON sidecars when -OutputDirectory is used.
-NoMarkdown SwitchParameter optional
Do not write Markdown sidecars when -OutputDirectory is used.
-NoMarkdownHeadingChunks SwitchParameter optional
Do not split Markdown by headings.
-NoOverwrite SwitchParameter optional
Do not overwrite existing sidecar files.
-OpenXmlMaxCharactersInPart Int64 optional
OpenXML maximum characters per part.
-OutputDirectory String optional
Optional directory where table sidecars should be written.
-Path String requiredposition: 0pipeline: True (ByValue)aliases: FilePath
File path to read.
-Reader OfficeDocumentReader optional
Optional immutable OfficeIMO reader with caller-configured handlers and processors.

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.