API Reference

Cmdlet

Export-OfficeExcelImage

Namespace PSWriteOffice
Inputs
OfficeIMO.Excel.ExcelDocument
Outputs
OfficeIMO.Drawing.OfficeImageExportResult

Exports workbook sheets as PNG or SVG images with one result per sheet.

Remarks

Exports workbook sheets as PNG or SVG images with one result per sheet.

Examples

Authored help example

Export visible sheets as PNG files.

PS>


Export-OfficeExcelImage -Path .\Report.xlsx -OutputPath .\Images
        

Writes one image per selected sheet and returns OfficeImageExportResult objects.

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-OfficeExcelImage [-Format <Png|Svg|Jpeg|Tiff|Webp>] [-Options <ExcelWorkbookImageExportOptions>] -OutputPath <String> -Path <String> [<CommonParameters>]
#
Parameter set: Path

Parameters

Format OfficeImageExportFormat optionalposition: namedpipeline: Falsevalues: 5
Output image format.
Possible values: Png, Svg, Jpeg, Tiff, Webp
Options ExcelWorkbookImageExportOptions optionalposition: namedpipeline: False
Optional sheet selection, range, size, and rendering settings.
OutputPath String requiredposition: 1pipeline: False
Destination folder.
Path String requiredposition: 0pipeline: False
Path to the workbook.

Outputs

OfficeIMO.Drawing.OfficeImageExportResult

Export-OfficeExcelImage -Document <ExcelDocument> [-Format <Png|Svg|Jpeg|Tiff|Webp>] [-Options <ExcelWorkbookImageExportOptions>] -OutputPath <String> [<CommonParameters>]
#
Parameter set: Document

Parameters

Document ExcelDocument requiredposition: namedpipeline: True (ByValue)
Open workbook instance.
Format OfficeImageExportFormat optionalposition: namedpipeline: Falsevalues: 5
Output image format.
Possible values: Png, Svg, Jpeg, Tiff, Webp
Options ExcelWorkbookImageExportOptions optionalposition: namedpipeline: False
Optional sheet selection, range, size, and rendering settings.
OutputPath String requiredposition: 1pipeline: False
Destination folder.

Outputs

OfficeIMO.Drawing.OfficeImageExportResult