Cmdlet

Get-OfficeDocumentAsset

Aliases: Export-OfficeDocumentAsset, Read-OfficeDocumentAsset

Module PSWriteOffice

Aliases

Export-OfficeDocumentAsset Read-OfficeDocumentAsset

Inputs

System.String

Outputs

OfficeIMO.Reader.OfficeDocumentAsset OfficeIMO.Reader.OfficeDocumentMaterializedAsset

Source

GetOfficeDocumentAssetCommand.cs:26 Edit on GitHub

Reads or materializes embedded assets discovered by OfficeIMO.Reader from a supported document.

Syntax

Get-OfficeDocumentAsset [-ExcelA1Range <String>] [-ExcelChunkRows <Int32>] [-ExcelSheetName <String>] [-ExcludePowerPointNotes] [-ExcludeWordFootnotes] [-Extension <String[]>] [-Kind <String[]>] [-MaxChars <Int32>] [-MaxInputBytes <Int64>] [-MaxTableRows <Int32>] [-MediaType <String[]>] [-NoExcelHeaders] [-NoHashes] [-NoMarkdownHeadingChunks] [-NoOverwrite] [-OpenXmlMaxCharactersInPart <Int64>] [-OutputDirectory <String>] [-Path] <String> [-Reader <OfficeDocumentReader>] [-ValidatePayloadHash] [<CommonParameters>]

Parameter set: All Parameter Sets

Examples

Authored help example

List embedded assets in a document.

Get-OfficeDocumentAsset -Path .\Report.docx |
                Select-Object Id, Kind, MediaType, FileName, LengthBytes

Reads the normalized asset metadata emitted by the shared Reader envelope.

Export document images to a folder.

Get-OfficeDocumentAsset -Path .\Deck.pptx -OutputDirectory .\reader-assets -Kind image -ValidatePayloadHash

Writes materializable image payloads to deterministic filenames and returns materialization results.

Parameters

-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.
-Extension String[] optional: Only include assets with one of these file extensions.
-Kind String[] optional: Only include assets with one of these normalized kinds, such as image or preview.
-MaxChars Int32 optional: Maximum emitted chunk characters.
-MaxInputBytes Int64 optional: Maximum input size in bytes.
-MaxTableRows Int32 optional: Maximum table rows per emitted table.
-MediaType String[] optional: Only include assets with one of these media types.
-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.
-NoOverwrite SwitchParameter optional: Do not overwrite existing payload files when -OutputDirectory is used.
-OpenXmlMaxCharactersInPart Int64 optional: OpenXML maximum characters per part.
-OutputDirectory String optional: Optional directory where materializable asset payloads should be written.
-Path String requiredposition: 0pipeline: True (ByValue, ByPropertyName)aliases: FilePath, FullName, LiteralPath: File path to read.
-Reader OfficeDocumentReader optional: Optional immutable OfficeIMO reader with caller-configured handlers and processors.
-ValidatePayloadHash SwitchParameter optional: Validate payload hashes before writing assets when hash metadata is present.

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.