Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, PowerShell module, CLI, Studio and browser tools 609 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-OfficeDocumentVisual

Aliases: Read-OfficeDocumentVisual
Module PSWriteOffice
Aliases
Read-OfficeDocumentVisual
Inputs
System.String
Outputs
OfficeIMO.Reader.ReaderVisual OfficeIMO.Reader.ReaderVisualExportBundle OfficeIMO.Reader.ReaderVisualMaterializedExport
Source
GetOfficeDocumentVisualCommand.cs:18 Edit on GitHub

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

Syntax

Get-OfficeDocumentVisual [-AsExport] [-ExcelA1Range <String>] [-ExcelChunkRows <Int32>] [-ExcelSheetName <String>] [-ExcludePowerPointNotes] [-ExcludeWordFootnotes] [-Indented] [-MaxChars <Int32>] [-MaxInputBytes <Int64>] [-MaxTableRows <Int32>] [-NoExcelHeaders] [-NoHashes] [-NoJson] [-NoMarkdownHeadingChunks] [-NoOverwrite] [-NoPayload] [-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.

  • Reader, Document Extraction, and OCR Guide

    Detect formats and extract normalized documents, chunks, hierarchy, tables, visuals, assets, OCR text, and ingest results. Includes examples and cmdlet links.

Examples

Authored help example

Export discovered visual payloads.

$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.

Parameters

-AsExport SwitchParameter optional
Return deterministic payload and JSON export bundles instead of visual 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.
-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.
-NoMarkdownHeadingChunks SwitchParameter optional
Do not split Markdown by headings.
-NoOverwrite SwitchParameter optional
Do not overwrite existing sidecar files.
-NoPayload SwitchParameter optional
Do not write raw payload sidecars when -OutputDirectory is used.
-OpenXmlMaxCharactersInPart Int64 optional
OpenXML maximum characters per part.
-OutputDirectory String optional
Optional directory where visual 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.