Cmdlet

Get-OfficeDocument

Aliases: Read-OfficeDocument

Module PSWriteOffice

Aliases

Read-OfficeDocument

Inputs

System.String

Outputs

OfficeIMO.Reader.OfficeDocumentReadResult System.String

Source

GetOfficeDocumentCommand.cs:21 Edit on GitHub

Reads a supported file into the OfficeIMO shared document read result envelope.

Syntax

Get-OfficeDocument [-AllStoreItems] [-AsJson] [-ExcelA1Range <String>] [-ExcelChunkRows <Int32>] [-ExcelSheetName <String>] [-ExcludePowerPointNotes] [-ExcludeWordFootnotes] [-IncludePageLocations] [-Indented] [-MaxChars <Int32>] [-MaxInputBytes <Int64>] [-MaxStoreItems <Int32>] [-MaxTableRows <Int32>] [-NoExcelHeaders] [-NoHashes] [-NoMarkdownHeadingChunks] [-OpenXmlMaxCharactersInPart <Int64>] [-Path] <String> [-Reader <OfficeDocumentReader>] [<CommonParameters>]

Parameter set: All Parameter Sets

Description

Use -AsJson for a deterministic serialized payload suitable for indexing or API handoff.

Examples

Authored help example

Read a document envelope as JSON.

$json = Get-OfficeDocument -Path .\Report.pdf -AsJson -Indented
$json | Set-Content -Path .\Report.reader.json

Reads a supported document and stores the normalized Reader result for indexing or diagnostics.

Parameters

-AllStoreItems SwitchParameter optional: Project every matching item from an email store.
-AsJson SwitchParameter optional: Return the read result as JSON.
-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.
-IncludePageLocations SwitchParameter optional: Compute Word page locations and reconstruct RTF pages from explicit page and section breaks. PDF and logical-container formats expose their native page-like locations without this switch.
-Indented SwitchParameter optional: Indent JSON output.
-MaxChars Int32 optional: Maximum emitted chunk characters.
-MaxInputBytes Int64 optional: Maximum input size in bytes.
-MaxStoreItems Int32 optional: Maximum PST, OST, OLM, or EMLX items projected from the store. The default is 1,000.
-MaxTableRows Int32 optional: Maximum table rows per emitted table chunk.
-NoExcelHeaders SwitchParameter optional: Treat the first Excel row as data instead of headers.
-NoHashes SwitchParameter optional: Disable source and chunk hash computation.
-NoMarkdownHeadingChunks SwitchParameter optional: Do not split Markdown by headings.
-OpenXmlMaxCharactersInPart Int64 optional: OpenXML maximum characters per part.
-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.