Project

PSWriteOffice

PowerShell document automation across OfficeIMO's document, spreadsheet, presentation, PDF, Project, Access, EPUB, invoicing, and conversion engines.

View on GitHub Releases Get package
Stars 654
Forks 82
Open issues 1
Total downloads 4,320,051
Release OfficeIMO-v3.5.3
Language: C# Updated: 2026-11-03
Cmdlet

New-OfficeWordImageOptions

Module
PSWriteOffice
Inputs
None
Outputs
OfficeIMO.Word.WordImageExportOptions
Source
NewOfficeWordImageOptionsCommand.cs:17 Edit on GitHub

Creates discoverable page and rendering settings for Export-OfficeWordImage.

Syntax

New-OfficeWordImageOptions
[-BackgroundColor <String>]
[-IncludeDocumentContent]
[-MaximumDegreeOfParallelism <Int32>]
[-MaximumOutputCount <Int32>]
[-MaximumOutputHeight <Int32>]
[-MaximumOutputWidth <Int32>]
[-MaximumRasterPixels <Int64>]
[-MaximumTotalEncodedBytes <Int64>]
[-MaximumTotalRasterPixels <Int64>]
[-PageCount <Int32>]
[-PageIndex <Int32>]
[-RasterOverflowBehavior <ReduceScale|Throw>]
[-RenderTimeoutSeconds <Double>]
[-Scale <Double>]
[-TargetDpi <Double>]
[-TextShapingLanguage <String>]
[<CommonParameters>]
#
Parameter set: All Parameter Sets

Examples

Render the first two pages at higher density.

$options = New-OfficeWordImageOptions -PageIndex 0 -PageCount 2 -TargetDpi 144 -IncludeDocumentContent
Export-OfficeWordImage -Path .\Report.docx -OutputPath .\Pages -Options $options

Supplying PageCount selects batch export, so OutputPath is a folder. Use -AllPages on the export command for the complete document.

Parameters

-BackgroundColor String optional
Background color name or hex value.
-IncludeDocumentContent SwitchParameter optional
Render document content.
-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.
-MaximumRasterPixels Int64 optional
Maximum pixels allocated for one raster image.
-MaximumTotalEncodedBytes Int64 optional
Maximum aggregate encoded bytes accepted from one batch.
-MaximumTotalRasterPixels Int64 optional
Maximum aggregate raster pixels accepted from one batch.
-PageCount Int32 optional
Maximum pages exported. Supplying this value selects batch export.
-PageIndex Int32 optional
Zero-based first page index.
-RasterOverflowBehavior OfficeRasterOverflowBehavior optional
Reduce or reject oversized raster output.
Possible values: ReduceScale, Throw
-RenderTimeoutSeconds Double optional
Maximum seconds allowed for one render.
-Scale Double optional
Output scale multiplier.
-TargetDpi Double optional
Target output density in dots per inch.
-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.