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-OfficeExcelImageOptions

Module
PSWriteOffice
Inputs
None
Outputs
OfficeIMO.Excel.ExcelImageExportOptions
Source
NewOfficeExcelImageOptionsCommand.cs:22 Edit on GitHub

Creates discoverable rendering settings for Excel range and chart image export.

Syntax

New-OfficeExcelImageOptions
[-BackgroundColor <String>]
[-IncludeCharts]
[-IncludeConditionalFormatting]
[-IncludeDrawingObjects]
[-IncludeHidden]
[-IncludeImages]
[-MaximumDegreeOfParallelism <Int32>]
[-MaximumOutputCount <Int32>]
[-MaximumOutputHeight <Int32>]
[-MaximumOutputWidth <Int32>]
[-MaximumRasterPixels <Int64>]
[-MaximumRenderedCells <Int32>]
[-MaximumTotalEncodedBytes <Int64>]
[-MaximumTotalRasterPixels <Int64>]
[-RasterOverflowBehavior <ReduceScale|Throw>]
[-RenderTimeoutSeconds <Double>]
[-Scale <Double>]
[-ShowCommentBodies]
[-ShowGridlines]
[-ShowHyperlinkHints]
[-TargetDpi <Double>]
[-TextShapingLanguage <String>]
[<CommonParameters>]
#
Parameter set: All Parameter Sets

Examples

Render a range with gridlines and hyperlinks visible.

$options = New-OfficeExcelImageOptions -ShowGridlines -ShowHyperlinkHints -TargetDpi 144
Export-OfficeExcelRangeImage -Path .\Workbook.xlsx -Worksheet Summary -Range A1:H20 -OutputPath .\Summary.svg -Options $options

Reuse the same rendering controls for a chart.

$options = New-OfficeExcelImageOptions -TargetDpi 144 -MaximumOutputWidth 1600
Export-OfficeExcelChartImage -Path .\Workbook.xlsx -Worksheet Summary -ChartName Revenue -OutputPath .\Revenue.svg -Options $options

Parameters

-BackgroundColor String optional
Background color name or hex value.
-IncludeCharts SwitchParameter optional
Include worksheet charts.
-IncludeConditionalFormatting SwitchParameter optional
Include conditional formatting.
-IncludeDrawingObjects SwitchParameter optional
Include drawing objects.
-IncludeHidden SwitchParameter optional
Include hidden rows and columns.
-IncludeImages SwitchParameter optional
Include worksheet images.
-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.
-MaximumRenderedCells Int32 optional
Maximum cells rendered.
-MaximumTotalEncodedBytes Int64 optional
Maximum aggregate encoded bytes accepted from one batch.
-MaximumTotalRasterPixels 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.
-Scale Double optional
Output scale multiplier.
-ShowCommentBodies SwitchParameter optional
Show cell comment bodies.
-ShowGridlines SwitchParameter optional
Show worksheet gridlines.
-ShowHyperlinkHints SwitchParameter optional
Show hyperlink hints.
-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.