Get Started

API Reference

Cmdlet

Get-OfficeDocumentVisual

Aliases: Read-OfficeDocumentVisual
Namespace PSWriteOffice
Aliases
Read-OfficeDocumentVisual
Inputs
System.String
Outputs
OfficeIMO.Reader.ReaderVisual OfficeIMO.Reader.ReaderVisualExportBundle OfficeIMO.Reader.ReaderVisualMaterializedExport
Source
Sources/PSWriteOffice/Cmdlets/Reader/GetOfficeDocumentVisualCommand.cs:15 Edit on GitHub

Reads visual payloads discovered by OfficeIMO.Reader from a supported document.

Remarks

Reads visual payloads discovered by OfficeIMO.Reader from a supported document.

Examples

Authored help example

Export discovered visual payloads.

PS>


$visuals = Get-OfficeDocumentVisual -Path .\Deck.pptx -AsExport -OutputDirectory .\reader-visuals -Indented
            $visuals | Select-Object Id, ContentType, PayloadPath

Extracts supported visual payloads and writes payload plus metadata sidecars.

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-OfficeDocumentVisual [-AsExport] [-ExcelA1Range <String>] [-ExcelChunkRows <Nullable`1>] [-ExcelSheetName <String>] [-ExcludePowerPointNotes] [-ExcludeWordFootnotes] [-Indented] [-MaxChars <Nullable`1>] [-MaxInputBytes <Nullable`1>] [-MaxTableRows <Nullable`1>] [-NoExcelHeaders] [-NoHashes] [-NoJson] [-NoMarkdownHeadingChunks] [-NoOverwrite] [-NoPayload] [-OpenXmlMaxCharactersInPart <Nullable`1>] [-OutputDirectory <String>] -Path <String> [-Reader <OfficeDocumentReader>] [<CommonParameters>]
#
Parameter set: All Parameter Sets

Parameters

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

Outputs

OfficeIMO.Reader.ReaderVisual OfficeIMO.Reader.ReaderVisualExportBundle OfficeIMO.Reader.ReaderVisualMaterializedExport