New-OfficeExcelImageOptions

Namespace PSWriteOffice

Inputs

None

Outputs

OfficeIMO.Excel.ExcelImageExportOptions

Source

Sources/PSWriteOffice/Cmdlets/Excel/NewOfficeExcelImageOptionsCommand.cs:22 Edit on GitHub

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

Remarks

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

Examples

Authored help example

Render a range with gridlines and hyperlinks visible.

PS>


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

PS>


$options = New-OfficeExcelImageOptions -TargetDpi 144 -MaximumOutputWidth 1600
            Export-OfficeExcelChartImage -Path .\Workbook.xlsx -Worksheet Summary -ChartName Revenue -OutputPath .\Revenue.svg -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-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

Parameters

BackgroundColor String optionalposition: namedpipeline: False
IncludeCharts SwitchParameter optionalposition: namedpipeline: False: Include worksheet charts.
IncludeConditionalFormatting SwitchParameter optionalposition: namedpipeline: False: Include conditional formatting.
IncludeDrawingObjects SwitchParameter optionalposition: namedpipeline: False: Include drawing objects.
IncludeHidden SwitchParameter optionalposition: namedpipeline: False: Include hidden rows and columns.
IncludeImages SwitchParameter optionalposition: namedpipeline: False: Include worksheet images.
MaximumDegreeOfParallelism Int32 optionalposition: namedpipeline: False
MaximumOutputCount Int32 optionalposition: namedpipeline: False
MaximumOutputHeight Int32 optionalposition: namedpipeline: False
MaximumOutputWidth Int32 optionalposition: namedpipeline: False
MaximumRasterPixels Int64 optionalposition: namedpipeline: False
MaximumRenderedCells Int32 optionalposition: namedpipeline: False: Maximum cells rendered.
MaximumTotalEncodedBytes Int64 optionalposition: namedpipeline: False
MaximumTotalRasterPixels Int64 optionalposition: namedpipeline: False
RasterOverflowBehavior OfficeRasterOverflowBehavior optionalposition: namedpipeline: Falsevalues: 2: Possible values: ReduceScale, Throw
RenderTimeoutSeconds Double optionalposition: namedpipeline: False
Scale Double optionalposition: namedpipeline: False
ShowCommentBodies SwitchParameter optionalposition: namedpipeline: False: Show cell comment bodies.
ShowGridlines SwitchParameter optionalposition: namedpipeline: False: Show worksheet gridlines.
ShowHyperlinkHints SwitchParameter optionalposition: namedpipeline: False: Show hyperlink hints.
TargetDpi Double optionalposition: namedpipeline: False
TextShapingLanguage String optionalposition: namedpipeline: False

Outputs

OfficeIMO.Excel.ExcelImageExportOptions