Export-OfficeExcelRangeImage

Namespace PSWriteOffice

Inputs

OfficeIMO.Excel.ExcelDocument

Outputs

OfficeIMO.Drawing.OfficeImageExportResult

Source

Sources/PSWriteOffice/Cmdlets/Excel/ExportOfficeExcelRangeImageCommand.cs:16 Edit on GitHub

Exports one worksheet range as an image file.

Remarks

Exports one worksheet range as an image file.

Examples

Authored help example

Export a report range for use in an email.

PS>


Export-OfficeExcelRangeImage -Path .\Report.xlsx -WorksheetName Summary -Range A1:H20 -OutputPath .\summary.png

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

Export-OfficeExcelRangeImage [-Force] [-Format <Png|Svg|Jpeg|Tiff|Webp>] [-Options <ExcelImageExportOptions>] [-OutputPath <String>] -Path <String> -Range <String> -WorksheetName <String> [<CommonParameters>]

Parameter set: Path

Parameters

Force SwitchParameter optionalposition: namedpipeline: False: Replace an existing destination file.
Format OfficeImageExportFormat optionalposition: namedpipeline: Falsevalues: 5: Output image format.; Possible values: Png, Svg, Jpeg, Tiff, Webp
Options ExcelImageExportOptions optionalposition: namedpipeline: False: Optional rendering, size, font, and diagnostic policy settings.
OutputPath String optionalposition: 1pipeline: False: Optional destination image file. When omitted, returns the in-memory image result only.
Path String requiredposition: 0pipeline: False: Path to the workbook.
Range String requiredposition: namedpipeline: False: A1 range address to export.
WorksheetName String requiredposition: namedpipeline: False: Name of the worksheet containing the range.

Outputs

OfficeIMO.Drawing.OfficeImageExportResult

Export-OfficeExcelRangeImage -Document <ExcelDocument> [-Force] [-Format <Png|Svg|Jpeg|Tiff|Webp>] [-Options <ExcelImageExportOptions>] [-OutputPath <String>] -Range <String> -WorksheetName <String> [<CommonParameters>]

Parameter set: Document

Parameters

Document ExcelDocument requiredposition: namedpipeline: True (ByValue): Open workbook instance.
Force SwitchParameter optionalposition: namedpipeline: False: Replace an existing destination file.
Format OfficeImageExportFormat optionalposition: namedpipeline: Falsevalues: 5: Output image format.; Possible values: Png, Svg, Jpeg, Tiff, Webp
Options ExcelImageExportOptions optionalposition: namedpipeline: False: Optional rendering, size, font, and diagnostic policy settings.
OutputPath String optionalposition: 1pipeline: False: Optional destination image file. When omitted, returns the in-memory image result only.
Range String requiredposition: namedpipeline: False: A1 range address to export.
WorksheetName String requiredposition: namedpipeline: False: Name of the worksheet containing the range.

Outputs

OfficeIMO.Drawing.OfficeImageExportResult