Project

PSWriteOffice

PowerShell document automation across Word, Excel, PowerPoint, PDF, Reader, Confluence, Visio, and open text formats.

View on GitHub Releases Get package
Stars 159
Forks 14
PowerShell Gallery downloads 158,661
Release v3.0.5
Language: C# Updated: 2026-09-03

API Reference

Cmdlet

Export-OfficeHtmlImage

Namespace PSWriteOffice
Inputs
OfficeIMO.Html.HtmlConversionDocument System.String
Outputs
OfficeIMO.Drawing.OfficeImageExportResult
Source
Sources/PSWriteOffice/Cmdlets/Html/ExportOfficeHtmlImageCommand.cs:18 Edit on GitHub

Exports an HTML render surface as PNG or SVG with structured diagnostics.

Remarks

Exports an HTML render surface as PNG or SVG with structured diagnostics.

Examples

Authored help example

Render an HTML file to PNG.

PS>


Export-OfficeHtmlImage -Path .\Report.html -OutputPath .\Report.png

Uses the dependency-free OfficeIMO HTML renderer. Add -PassThru to receive the structured export result.

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-OfficeHtmlImage [-DocumentOptions <HtmlConversionDocumentOptions>] [-Format <Png|Svg|Jpeg|Tiff|Webp>] -OutputPath <String> [-PageIndex <Int32>] [-PassThru] -Path <String> [-RenderOptions <HtmlRenderOptions>] [<CommonParameters>]
#
Parameter set: Path

Parameters

DocumentOptions HtmlConversionDocumentOptions optionalposition: namedpipeline: False
Optional HTML parsing and trust settings for path or markup input.
Format OfficeImageExportFormat optionalposition: namedpipeline: Falsevalues: 5
Output image format.
Possible values: Png, Svg, Jpeg, Tiff, Webp
OutputPath String requiredposition: 1pipeline: False
Destination PNG, JPEG, TIFF, SVG, or WebP path.
PageIndex Int32 optionalposition: namedpipeline: False
Zero-based rendered page index.
PassThru SwitchParameter optionalposition: namedpipeline: False
Emit the structured image export result.
Path String requiredposition: 0pipeline: False
Path to an HTML file.
RenderOptions HtmlRenderOptions optionalposition: namedpipeline: False
Optional size, pagination, resource, and rendering settings.

Outputs

OfficeIMO.Drawing.OfficeImageExportResult

Export-OfficeHtmlImage [-DocumentOptions <HtmlConversionDocumentOptions>] [-Format <Png|Svg|Jpeg|Tiff|Webp>] -Html <String> -OutputPath <String> [-PageIndex <Int32>] [-PassThru] [-RenderOptions <HtmlRenderOptions>] [<CommonParameters>]
#
Parameter set: Html

Parameters

DocumentOptions HtmlConversionDocumentOptions optionalposition: namedpipeline: False
Optional HTML parsing and trust settings for path or markup input.
Format OfficeImageExportFormat optionalposition: namedpipeline: Falsevalues: 5
Output image format.
Possible values: Png, Svg, Jpeg, Tiff, Webp
Html String requiredposition: namedpipeline: True (ByValue)
HTML markup to render.
OutputPath String requiredposition: 1pipeline: False
Destination PNG, JPEG, TIFF, SVG, or WebP path.
PageIndex Int32 optionalposition: namedpipeline: False
Zero-based rendered page index.
PassThru SwitchParameter optionalposition: namedpipeline: False
Emit the structured image export result.
RenderOptions HtmlRenderOptions optionalposition: namedpipeline: False
Optional size, pagination, resource, and rendering settings.

Outputs

OfficeIMO.Drawing.OfficeImageExportResult

Export-OfficeHtmlImage -Document <HtmlConversionDocument> [-DocumentOptions <HtmlConversionDocumentOptions>] [-Format <Png|Svg|Jpeg|Tiff|Webp>] -OutputPath <String> [-PageIndex <Int32>] [-PassThru] [-RenderOptions <HtmlRenderOptions>] [<CommonParameters>]
#
Parameter set: Document

Parameters

Document HtmlConversionDocument requiredposition: namedpipeline: True (ByValue)
Shared HTML conversion document.
DocumentOptions HtmlConversionDocumentOptions optionalposition: namedpipeline: False
Optional HTML parsing and trust settings for path or markup input.
Format OfficeImageExportFormat optionalposition: namedpipeline: Falsevalues: 5
Output image format.
Possible values: Png, Svg, Jpeg, Tiff, Webp
OutputPath String requiredposition: 1pipeline: False
Destination PNG, JPEG, TIFF, SVG, or WebP path.
PageIndex Int32 optionalposition: namedpipeline: False
Zero-based rendered page index.
PassThru SwitchParameter optionalposition: namedpipeline: False
Emit the structured image export result.
RenderOptions HtmlRenderOptions optionalposition: namedpipeline: False
Optional size, pagination, resource, and rendering settings.

Outputs

OfficeIMO.Drawing.OfficeImageExportResult