Cmdlet

Get-OfficeWordImage

Aliases: WordImages

Module PSWriteOffice

Aliases

WordImages

Inputs

OfficeIMO.Word.WordDocument OfficeIMO.Word.WordParagraph OfficeIMO.Word.WordSection

Outputs

OfficeIMO.Word.WordImage

Source

GetOfficeWordImageCommand.cs:22 Edit on GitHub

Gets images from a Word document, section, or paragraph.

Syntax

Get-OfficeWordImage [-Path] <String> [<CommonParameters>]

Parameter set: Path

Get-OfficeWordImage -Document <WordDocument> [<CommonParameters>]

Parameter set: Document

Get-OfficeWordImage -Section <WordSection> [<CommonParameters>]

Parameter set: Section

Get-OfficeWordImage -Paragraph <WordParagraph> [<CommonParameters>]

Parameter set: Paragraph

Examples

Authored help example

List images and their accessibility metadata.

$images = Get-OfficeWordImage -Path .\Report.docx
$images |
    Select-Object -Property Title, Description, Width, Height |
    Format-Table -AutoSize

Reads images from a document so metadata and sizing can be reviewed before publication.

Parameters

-Path String requiredposition: 0aliases: FilePath, InputPathsets: Path: Path to the document.
-Document WordDocument requiredpipeline: True (ByValue)sets: Document: Document to inspect.
-Section WordSection requiredpipeline: True (ByValue)sets: Section: Section to inspect.
-Paragraph WordParagraph requiredpipeline: True (ByValue)sets: Paragraph: Paragraph to inspect.

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.