Cmdlet

Export-OfficeWordImage

Module PSWriteOffice

Inputs

OfficeIMO.Word.WordDocument

Outputs

OfficeIMO.Drawing.OfficeImageExportResult

Source

ExportOfficeWordImageCommand.cs:25 Edit on GitHub

Exports one or more Word pages through the format-neutral OfficeIMO image pipeline.

Syntax

Export-OfficeWordImage [-AllPages] [-Format <OfficeImageExportFormat>] [-Options <WordImageExportOptions>] [-OutputPath] <String> [-PassThru] [-Path] <String> [<CommonParameters>]

Parameter set: Path

Export-OfficeWordImage [-AllPages] -Document <WordDocument> [-Format <OfficeImageExportFormat>] [-Options <WordImageExportOptions>] [-OutputPath] <String> [-PassThru] [<CommonParameters>]

Parameter set: Document

Examples

Authored help example

Export the first page as SVG.

Export-OfficeWordImage -Path .\Report.docx -OutputPath .\Report.svg -Format Svg

Writes the image quietly. Add -PassThru to receive the structured export result.

Export every page as JPEG files.

Export-OfficeWordImage -Path .\Report.docx -OutputPath .\Pages -Format Jpeg -AllPages

For a bounded batch, create options with New-OfficeWordImageOptions -PageIndex 0 -PageCount 2.

Parameters

-AllPages SwitchParameter optional: Export every estimated page to the destination folder.
-Format OfficeImageExportFormat optional: Output image format.; Possible values: Png, Svg, Jpeg, Tiff, Webp, Bmp, Pbm, Tga, Icon
-Options WordImageExportOptions optional: Optional page, size, scale, theme, and rendering settings.
-OutputPath String requiredposition: 1: Destination image file, or destination folder when -AllPages or Options.PageCount requests a batch.
-PassThru SwitchParameter optional: Emit the structured image export result.
-Path String requiredposition: 0sets: Path: Path to the Word document.
-Document WordDocument requiredpipeline: True (ByValue)sets: Document: Open Word document instance.

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.