Project

PSWriteOffice

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

View on GitHub Releases Get package
Stars 165
Forks 15
PowerShell Gallery downloads 158,661
Release v3.0.8
Language: C# Updated: 2026-10-12

API Reference

Cmdlet

New-OfficePdfImageOptions

Namespace PSWriteOffice
Inputs
None
Outputs
OfficeIMO.Pdf.PdfImageExportOptions
Source
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
Background color name or hex value.
MaximumDegreeOfParallelism Int32 optionalposition: namedpipeline: False
Maximum independent renders processed concurrently.
MaximumOutputCount Int32 optionalposition: namedpipeline: False
Maximum images accepted from one batch export.
MaximumOutputHeight Int32 optionalposition: namedpipeline: False
Maximum output height in pixels.
MaximumOutputWidth Int32 optionalposition: namedpipeline: False
Maximum output width in pixels.
MaximumRasterPixels Int64 optionalposition: namedpipeline: False
Maximum pixels allocated for one raster image.
MaximumTotalEncodedBytes Int64 optionalposition: namedpipeline: False
Maximum aggregate encoded bytes accepted from one batch.
MaximumTotalRasterPixels Int64 optionalposition: namedpipeline: False
Maximum aggregate raster pixels accepted from one batch.
RasterOverflowBehavior OfficeRasterOverflowBehavior optionalposition: namedpipeline: Falsevalues: 2
Reduce or reject oversized raster output.
Possible values: ReduceScale, Throw
RenderTimeoutSeconds Double optionalposition: namedpipeline: False
Maximum seconds allowed for one render.
Scale Double optionalposition: namedpipeline: False
Output scale multiplier.
TargetDpi Double optionalposition: namedpipeline: False
Target output density in dots per inch.
TextShapingLanguage String optionalposition: namedpipeline: False
BCP 47 language hint for text shaping.
ThumbnailMaxDimension Int32 optionalposition: namedpipeline: False
Maximum thumbnail width or height.

Outputs

OfficeIMO.Pdf.PdfImageExportOptions