Get-OfficeDocumentStructured

Namespace PSWriteOffice

Inputs

System.String

Outputs

OfficeIMO.Reader.OfficeDocumentStructuredExtractionResult

Source

Sources/PSWriteOffice/Cmdlets/Reader/GetOfficeDocumentStructuredCommand.cs:14 Edit on GitHub

Extracts a bounded schema-friendly view of a supported document.

Remarks

Extracts a bounded schema-friendly view of a supported document.

Examples

Authored help example

Extract sections, tables, forms, and scalar records.

PS>


$result = Get-OfficeDocumentStructured -Path .\report.docx; $result.Records | Group-Object Category

Returns deterministic structured records and source diagnostics without format-specific parsing.

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-OfficeDocumentStructured [-ExtractionOptions <OfficeDocumentStructuredExtractionOptions>] -Path <String> [-Reader <OfficeDocumentReader>] [-ReaderOptions <ReaderOptions>] [<CommonParameters>]

Parameter set: All Parameter Sets

Parameters

ExtractionOptions OfficeDocumentStructuredExtractionOptions optionalposition: namedpipeline: False: Optional structured extraction categories and limits.
Path String requiredposition: 0pipeline: True (ByValue): Path to read.
Reader OfficeDocumentReader optionalposition: namedpipeline: False
ReaderOptions ReaderOptions optionalposition: namedpipeline: False: Optional source-reading limits and format behavior.

Outputs

OfficeIMO.Reader.OfficeDocumentStructuredExtractionResult