Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Cmdlet

New-OfficePdfImageOptions

Module
PSWriteOffice
Inputs
None
Outputs
OfficeIMO.Pdf.PdfImageExportOptions

Creates discoverable thumbnail and rendering settings for Export-OfficeDocumentImage.

Syntax

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

Description

Pass the result to Export-OfficeDocumentImage or ConvertTo-OfficeDocumentImage -Options when rendering PDF pages.

Examples

Create compact PDF thumbnails with bounded output dimensions.

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

Parameters

-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.
-ThumbnailMaxDimension Int32 optional
Maximum thumbnail width or height.

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.