Project

PSWriteOffice

PowerShell document automation across Word, Excel, PowerPoint, PDF, Reader, Confluence, Visio, and open text formats.

View on GitHub Releases Get package
Stars 161
Forks 15
PowerShell Gallery downloads 158,661
Release v3.0.7
Language: C# Updated: 2026-09-24

API Reference

Cmdlet

New-OfficeWordImageOptions

Namespace PSWriteOffice
Inputs
None
Outputs
OfficeIMO.Word.WordImageExportOptions
Source
Sources/PSWriteOffice/Cmdlets/Word/NewOfficeWordImageOptionsCommand.cs:17 Edit on GitHub

Creates discoverable page and rendering settings for Export-OfficeWordImage.

Remarks

Creates discoverable page and rendering settings for Export-OfficeWordImage.

Examples

Authored help example

Render the first two pages at higher density.

PS>


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

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

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

Parameters

BackgroundColor String optionalposition: namedpipeline: False
Specifies a value for background color.
IncludeDocumentContent SwitchParameter optionalposition: namedpipeline: False
Render document content.
MaximumDegreeOfParallelism Int32 optionalposition: namedpipeline: False
Specifies a value for maximum degree of parallelism.
MaximumOutputCount Int32 optionalposition: namedpipeline: False
Specifies a value for maximum output count.
MaximumOutputHeight Int32 optionalposition: namedpipeline: False
Specifies a value for maximum output height.
MaximumOutputWidth Int32 optionalposition: namedpipeline: False
Specifies a value for maximum output width.
MaximumRasterPixels Int64 optionalposition: namedpipeline: False
Specifies a value for maximum raster pixels.
MaximumTotalEncodedBytes Int64 optionalposition: namedpipeline: False
Specifies a value for maximum total encoded bytes.
MaximumTotalRasterPixels Int64 optionalposition: namedpipeline: False
Specifies a value for maximum total raster pixels.
PageCount Int32 optionalposition: namedpipeline: False
Maximum pages exported. Supplying this value selects batch export.
PageIndex Int32 optionalposition: namedpipeline: False
Zero-based first page index.
RasterOverflowBehavior OfficeRasterOverflowBehavior optionalposition: namedpipeline: Falsevalues: 2
Specifies a value for raster overflow behavior.
Possible values: ReduceScale, Throw
RenderTimeoutSeconds Double optionalposition: namedpipeline: False
Specifies a value for render timeout seconds.
Scale Double optionalposition: namedpipeline: False
Specifies a value for scale.
TargetDpi Double optionalposition: namedpipeline: False
Specifies a value for target dpi.
TextShapingLanguage String optionalposition: namedpipeline: False
Specifies a value for text shaping language.

Outputs

OfficeIMO.Word.WordImageExportOptions