Get-OfficeWordImage

Aliases: WordImages

Namespace PSWriteOffice

Aliases

WordImages

Inputs

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

Outputs

OfficeIMO.Word.WordImage

Source

Sources/PSWriteOffice/Cmdlets/Word/GetOfficeWordImageCommand.cs:19 Edit on GitHub

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

Remarks

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

Examples

Authored help example

List images and their accessibility metadata.

PS>


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

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-OfficeWordImage -InputPath <String> [<CommonParameters>]

Parameter set: Path

Parameters

InputPath String requiredposition: 0pipeline: Falsealiases: FilePath, Path: Path to the document.

Outputs

OfficeIMO.Word.WordImage

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

Parameter set: Document

Parameters

Document WordDocument requiredposition: namedpipeline: True (ByValue): Document to inspect.

Outputs

OfficeIMO.Word.WordImage

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

Parameter set: Section

Parameters

Section WordSection requiredposition: namedpipeline: True (ByValue): Section to inspect.

Outputs

OfficeIMO.Word.WordImage

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

Parameter set: Paragraph

Parameters

Paragraph WordParagraph requiredposition: namedpipeline: True (ByValue): Paragraph to inspect.

Outputs

OfficeIMO.Word.WordImage