Get Started

API Reference

Cmdlet

New-OfficeExcelWorkbookImageOptions

Namespace PSWriteOffice
Inputs
None
Outputs
OfficeIMO.Excel.ExcelWorkbookImageExportOptions
Source
Sources/PSWriteOffice/Cmdlets/Excel/NewOfficeExcelWorkbookImageOptionsCommand.cs:16 Edit on GitHub

Creates discoverable sheet selection and rendering settings for Export-OfficeExcelImage.

Remarks

Creates discoverable sheet selection and rendering settings for Export-OfficeExcelImage.

Examples

Authored help example

Render selected worksheets with charts and conditional formatting.

PS>


$options = New-OfficeExcelWorkbookImageOptions -SheetName Summary,Data -IncludeCharts -IncludeConditionalFormatting
            Export-OfficeExcelImage -Path .\Workbook.xlsx -OutputPath .\Sheets -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-OfficeExcelWorkbookImageOptions [-BackgroundColor <String>] [-IncludeCharts] [-IncludeConditionalFormatting] [-IncludeDrawingObjects] [-IncludeHidden] [-IncludeHiddenSheets] [-IncludeImages] [-MaximumDegreeOfParallelism <Int32>] [-MaximumOutputCount <Int32>] [-MaximumOutputHeight <Int32>] [-MaximumOutputWidth <Int32>] [-MaximumRasterPixels <Int64>] [-MaximumRenderedCells <Int32>] [-MaximumTotalEncodedBytes <Int64>] [-MaximumTotalRasterPixels <Int64>] [-RasterOverflowBehavior <ReduceScale|Throw>] [-RenderTimeoutSeconds <Double>] [-Scale <Double>] [-SheetName <String[]>] [-ShowGridlines] [-SplitWorksheetsByManualPageBreaks] [-TargetDpi <Double>] [-TextShapingLanguage <String>] [-UseWorksheetPrintAreas] [<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.
IncludeHiddenSheets SwitchParameter optionalposition: namedpipeline: False
Include hidden worksheets.
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 per worksheet.
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
SheetName String[] optionalposition: namedpipeline: False
Worksheet names to export.
ShowGridlines SwitchParameter optionalposition: namedpipeline: False
Show worksheet gridlines.
SplitWorksheetsByManualPageBreaks SwitchParameter optionalposition: namedpipeline: False
Split worksheets at manual page breaks.
TargetDpi Double optionalposition: namedpipeline: False
TextShapingLanguage String optionalposition: namedpipeline: False
UseWorksheetPrintAreas SwitchParameter optionalposition: namedpipeline: False
Use worksheet print areas.

Outputs

OfficeIMO.Excel.ExcelWorkbookImageExportOptions