Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Cmdlet

New-OfficeWordImageOptions

Module
PSWriteOffice
Inputs
None
Outputs
OfficeIMO.Word.WordImageExportOptions

Creates discoverable page and rendering settings for Export-OfficeWordImage.

Syntax

New-OfficeWordImageOptions
[-ChartFidelity <Strict|BestEffort>]
[-MaximumDegreeOfParallelism <Int32>]
[-MaximumOutputCount <Int32>]
[-MaximumOutputHeight <Int32>]
[-MaximumOutputWidth <Int32>]
[-MaximumRasterPixelCount <Int64>]
[-MaximumTotalEncodedBytes <Int64>]
[-MaximumTotalRasterPixelCount <Int64>]
[-RasterOverflowBehavior <ReduceScale|Throw>]
[-RenderTimeoutSeconds <Double>]
[-TextShapingLanguage <String>]
[<CommonParameters>]
#
Parameter set: Default

Examples

Render two pages with bounded raster output.

$options = New-OfficeWordImageOptions -MaximumRasterPixelCount 10000000
Export-OfficeDocumentImage -Path ./Report.docx -Page 1-2 -Dpi 144 -OutputDirectory ./Pages -Options $options

Parameters

-ChartFidelity OfficeChartFidelity optional
Chart handling: Strict (default) skips charts with formatting that cannot be drawn exactly; BestEffort draws the closest approximation and reports chart-approximation warnings.
Possible values: Strict, BestEffort
-MaximumDegreeOfParallelism Int32 optional
Maximum independent renders processed concurrently.
-MaximumOutputCount Int32 optional
Maximum images accepted from one batch export.
-MaximumOutputHeight Int32 optional
Maximum output height in pixels.
-MaximumOutputWidth Int32 optional
Maximum output width in pixels.
-MaximumRasterPixelCount Int64 optional
Maximum pixels allocated for one raster image.
-MaximumTotalEncodedBytes Int64 optional
Maximum aggregate encoded bytes accepted from one batch.
-MaximumTotalRasterPixelCount Int64 optional
Maximum aggregate raster pixels accepted from one batch.
-RasterOverflowBehavior OfficeRasterOverflowBehavior optional
Reduce or reject oversized raster output.
Possible values: ReduceScale, Throw
-RenderTimeoutSeconds Double optional
Maximum seconds allowed for one render.
-TextShapingLanguage String optional
BCP 47 language hint for text shaping.

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.