Export-OfficeWordImage

Namespace PSWriteOffice

Inputs

OfficeIMO.Word.WordDocument

Outputs

OfficeIMO.Drawing.OfficeImageExportResult

Source

Sources/PSWriteOffice/Cmdlets/Word/ExportOfficeWordImageCommand.cs:16 Edit on GitHub

Exports a Word page as PNG or SVG with structured image diagnostics.

Remarks

Exports a Word page as PNG or SVG with structured image diagnostics.

Examples

Authored help example

Export the first page as SVG.

PS>


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

Returns the OfficeIMO image export result after writing the image.

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

Export-OfficeWordImage [-Format <Png|Svg|Jpeg|Tiff|Webp>] [-Options <WordImageExportOptions>] -OutputPath <String> -Path <String> [<CommonParameters>]

Parameter set: Path

Parameters

Format OfficeImageExportFormat optionalposition: namedpipeline: Falsevalues: 5: Output image format.; Possible values: Png, Svg, Jpeg, Tiff, Webp
Options WordImageExportOptions optionalposition: namedpipeline: False: Optional page, size, scale, theme, and rendering settings.
OutputPath String requiredposition: 1pipeline: False: Destination PNG or SVG path.
Path String requiredposition: 0pipeline: False: Path to the Word document.

Outputs

OfficeIMO.Drawing.OfficeImageExportResult

Export-OfficeWordImage -Document <WordDocument> [-Format <Png|Svg|Jpeg|Tiff|Webp>] [-Options <WordImageExportOptions>] -OutputPath <String> [<CommonParameters>]

Parameter set: Document

Parameters

Document WordDocument requiredposition: namedpipeline: True (ByValue): Open Word document instance.
Format OfficeImageExportFormat optionalposition: namedpipeline: Falsevalues: 5: Output image format.; Possible values: Png, Svg, Jpeg, Tiff, Webp
Options WordImageExportOptions optionalposition: namedpipeline: False: Optional page, size, scale, theme, and rendering settings.
OutputPath String requiredposition: 1pipeline: False: Destination PNG or SVG path.

Outputs

OfficeIMO.Drawing.OfficeImageExportResult