Project

PSWriteOffice

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

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

API Reference

Cmdlet

New-OfficePdfImageOptions

Namespace PSWriteOffice
Inputs
None
Outputs
OfficeIMO.Pdf.PdfImageExportOptions
Source
Sources/PSWriteOffice/Cmdlets/Pdf/NewOfficePdfImageOptionsCommand.cs:16 Edit on GitHub

Creates discoverable thumbnail and rendering settings for Export-OfficePdfImage.

Remarks

Creates discoverable thumbnail and rendering settings for Export-OfficePdfImage.

Examples

Authored help example

Create compact PDF thumbnails with bounded output dimensions.

PS>


$options = New-OfficePdfImageOptions -ThumbnailMaxDimension 320 -MaximumOutputWidth 640
            Export-OfficePdfImage -Path .\Report.pdf -OutputPath .\Thumbnails -Options $options

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-OfficePdfImageOptions [-BackgroundColor <String>] [-MaximumDegreeOfParallelism <Int32>] [-MaximumOutputCount <Int32>] [-MaximumOutputHeight <Int32>] [-MaximumOutputWidth <Int32>] [-MaximumRasterPixels <Int64>] [-MaximumTotalEncodedBytes <Int64>] [-MaximumTotalRasterPixels <Int64>] [-RasterOverflowBehavior <ReduceScale|Throw>] [-RenderTimeoutSeconds <Double>] [-Scale <Double>] [-TargetDpi <Double>] [-TextShapingLanguage <String>] [-ThumbnailMaxDimension <Int32>] [<CommonParameters>]
#
Parameter set: All Parameter Sets

Parameters

BackgroundColor String optionalposition: namedpipeline: False
Specifies a value for background color.
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.
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.
ThumbnailMaxDimension Int32 optionalposition: namedpipeline: False
Maximum thumbnail width or height.

Outputs

OfficeIMO.Pdf.PdfImageExportOptions