API Reference
Class
HtmlImageExportExtensions
Exports HTML surfaces from the same paged layout and PDF scene as PDF conversion.
Inheritance
- Object
- HtmlImageExportExtensions
Methods
public static OfficeImageExportResult ExportImage(HtmlConversionDocument document, OfficeImageExportFormat format, HtmlRenderOptions? options = null, Int32 pageIndex = 0) #Returns:
OfficeImageExportResultRenders one selected surface to the requested image format with dimensions and diagnostics.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- format OfficeIMO.Drawing.OfficeImageExportFormat
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
public static async Task<OfficeImageExportResult> ExportImageAsync(HtmlConversionDocument document, OfficeImageExportFormat format, HtmlRenderOptions? options = null, Int32 pageIndex = 0, CancellationToken cancellationToken = default) #Returns:
Task<OfficeImageExportResult>Asynchronously renders one selected surface to the requested image format.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- format OfficeIMO.Drawing.OfficeImageExportFormat
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
- cancellationToken System.Threading.CancellationToken = default
ExportImages 2 overloads
public static IReadOnlyList<OfficeImageExportResult> ExportImages(HtmlConversionDocument document, OfficeImageExportFormat format, HtmlRenderOptions? options = null) #Returns:
IReadOnlyList<OfficeImageExportResult>Renders all surfaces to the requested image format.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- format OfficeIMO.Drawing.OfficeImageExportFormat
- options OfficeIMO.Html.HtmlRenderOptions? = null
public static Void ExportImages(HtmlConversionDocument document, OfficeImageExportFormat format, OfficeImageExportConsumer consumer, HtmlRenderOptions? options = null, CancellationToken cancellationToken = default) #Returns:
VoidStreams rendered surfaces without retaining earlier encoded payloads.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- format OfficeIMO.Drawing.OfficeImageExportFormat
- consumer OfficeIMO.Drawing.OfficeImageExportConsumer
- options OfficeIMO.Html.HtmlRenderOptions? = null
- cancellationToken System.Threading.CancellationToken = default
ExportImagesAsync 2 overloads
public static async Task<IReadOnlyList<OfficeImageExportResult>> ExportImagesAsync(HtmlConversionDocument document, OfficeImageExportFormat format, HtmlRenderOptions? options = null, CancellationToken cancellationToken = default) #Returns:
Task<IReadOnlyList<OfficeImageExportResult>>Asynchronously renders all surfaces to the requested image format.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- format OfficeIMO.Drawing.OfficeImageExportFormat
- options OfficeIMO.Html.HtmlRenderOptions? = null
- cancellationToken System.Threading.CancellationToken = default
public static async Task ExportImagesAsync(HtmlConversionDocument document, OfficeImageExportFormat format, OfficeImageExportAsyncConsumer consumer, HtmlRenderOptions? options = null, CancellationToken cancellationToken = default) #Returns:
TaskAsynchronously streams rendered surfaces without retaining earlier encoded payloads.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- format OfficeIMO.Drawing.OfficeImageExportFormat
- consumer OfficeIMO.Drawing.OfficeImageExportAsyncConsumer
- options OfficeIMO.Html.HtmlRenderOptions? = null
- cancellationToken System.Threading.CancellationToken = default
public static IReadOnlyList<OfficeImageExportResult> RenderImages(HtmlConversionDocument document, HtmlRenderRequest request, CancellationToken cancellationToken = default) #Returns:
IReadOnlyList<OfficeImageExportResult>Executes an explicit request and encodes every retained image surface.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- request OfficeIMO.Html.HtmlRenderRequest
- cancellationToken System.Threading.CancellationToken = default
public static async Task<IReadOnlyList<OfficeImageExportResult>> RenderImagesAsync(HtmlConversionDocument document, HtmlRenderRequest request, CancellationToken cancellationToken = default) #Returns:
Task<IReadOnlyList<OfficeImageExportResult>>Executes an explicit request asynchronously and encodes every retained image surface.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- request OfficeIMO.Html.HtmlRenderRequest
- cancellationToken System.Threading.CancellationToken = default
SaveAsJpeg 2 overloads
public static OfficeImageExportResult SaveAsJpeg(HtmlConversionDocument document, String path, HtmlRenderOptions? options = null, Int32 pageIndex = 0) #Returns:
OfficeImageExportResultSaves a shared HTML conversion document as a JPEG file.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- path System.String
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
public static OfficeImageExportResult SaveAsJpeg(HtmlConversionDocument document, Stream stream, HtmlRenderOptions? options = null, Int32 pageIndex = 0) #Returns:
OfficeImageExportResultWrites a shared HTML conversion document as JPEG to a caller-owned stream.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- stream System.IO.Stream
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
SaveAsJpegAsync 2 overloads
public static Task<OfficeImageExportResult> SaveAsJpegAsync(HtmlConversionDocument document, String path, HtmlRenderOptions? options = null, Int32 pageIndex = 0, CancellationToken cancellationToken = default) #Returns:
Task<OfficeImageExportResult>Asynchronously resolves resources and saves a shared HTML conversion document as a JPEG file.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- path System.String
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
- cancellationToken System.Threading.CancellationToken = default
public static Task<OfficeImageExportResult> SaveAsJpegAsync(HtmlConversionDocument document, Stream stream, HtmlRenderOptions? options = null, Int32 pageIndex = 0, CancellationToken cancellationToken = default) #Returns:
Task<OfficeImageExportResult>Asynchronously resolves resources and writes JPEG to a caller-owned stream.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- stream System.IO.Stream
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
- cancellationToken System.Threading.CancellationToken = default
SaveAsPng 2 overloads
public static OfficeImageExportResult SaveAsPng(HtmlConversionDocument document, String path, HtmlRenderOptions? options = null, Int32 pageIndex = 0) #Returns:
OfficeImageExportResultSaves a shared HTML conversion document as a PNG file.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- path System.String
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
public static OfficeImageExportResult SaveAsPng(HtmlConversionDocument document, Stream stream, HtmlRenderOptions? options = null, Int32 pageIndex = 0) #Returns:
OfficeImageExportResultWrites a shared HTML conversion document as PNG to a caller-owned stream.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- stream System.IO.Stream
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
SaveAsPngAsync 2 overloads
public static Task<OfficeImageExportResult> SaveAsPngAsync(HtmlConversionDocument document, String path, HtmlRenderOptions? options = null, Int32 pageIndex = 0, CancellationToken cancellationToken = default) #Returns:
Task<OfficeImageExportResult>Asynchronously resolves resources and saves a shared HTML conversion document as a PNG file.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- path System.String
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
- cancellationToken System.Threading.CancellationToken = default
public static Task<OfficeImageExportResult> SaveAsPngAsync(HtmlConversionDocument document, Stream stream, HtmlRenderOptions? options = null, Int32 pageIndex = 0, CancellationToken cancellationToken = default) #Returns:
Task<OfficeImageExportResult>Asynchronously resolves resources and writes PNG to a caller-owned stream.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- stream System.IO.Stream
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
- cancellationToken System.Threading.CancellationToken = default
SaveAsSvg 2 overloads
public static OfficeImageExportResult SaveAsSvg(HtmlConversionDocument document, String path, HtmlRenderOptions? options = null, Int32 pageIndex = 0) #Returns:
OfficeImageExportResultSaves a shared HTML conversion document as an SVG file.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- path System.String
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
public static OfficeImageExportResult SaveAsSvg(HtmlConversionDocument document, Stream stream, HtmlRenderOptions? options = null, Int32 pageIndex = 0) #Returns:
OfficeImageExportResultWrites a shared HTML conversion document as SVG to a caller-owned stream.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- stream System.IO.Stream
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
SaveAsSvgAsync 2 overloads
public static Task<OfficeImageExportResult> SaveAsSvgAsync(HtmlConversionDocument document, String path, HtmlRenderOptions? options = null, Int32 pageIndex = 0, CancellationToken cancellationToken = default) #Returns:
Task<OfficeImageExportResult>Asynchronously resolves resources and saves a shared HTML conversion document as an SVG file.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- path System.String
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
- cancellationToken System.Threading.CancellationToken = default
public static Task<OfficeImageExportResult> SaveAsSvgAsync(HtmlConversionDocument document, Stream stream, HtmlRenderOptions? options = null, Int32 pageIndex = 0, CancellationToken cancellationToken = default) #Returns:
Task<OfficeImageExportResult>Asynchronously resolves resources and writes SVG to a caller-owned stream.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- stream System.IO.Stream
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
- cancellationToken System.Threading.CancellationToken = default
SaveAsTiff 2 overloads
public static OfficeImageExportResult SaveAsTiff(HtmlConversionDocument document, String path, HtmlRenderOptions? options = null, Int32 pageIndex = 0) #Returns:
OfficeImageExportResultSaves a shared HTML conversion document as a TIFF file.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- path System.String
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
public static OfficeImageExportResult SaveAsTiff(HtmlConversionDocument document, Stream stream, HtmlRenderOptions? options = null, Int32 pageIndex = 0) #Returns:
OfficeImageExportResultWrites a shared HTML conversion document as TIFF to a caller-owned stream.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- stream System.IO.Stream
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
SaveAsTiffAsync 2 overloads
public static Task<OfficeImageExportResult> SaveAsTiffAsync(HtmlConversionDocument document, String path, HtmlRenderOptions? options = null, Int32 pageIndex = 0, CancellationToken cancellationToken = default) #Returns:
Task<OfficeImageExportResult>Asynchronously resolves resources and saves a shared HTML conversion document as a TIFF file.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- path System.String
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
- cancellationToken System.Threading.CancellationToken = default
public static Task<OfficeImageExportResult> SaveAsTiffAsync(HtmlConversionDocument document, Stream stream, HtmlRenderOptions? options = null, Int32 pageIndex = 0, CancellationToken cancellationToken = default) #Returns:
Task<OfficeImageExportResult>Asynchronously resolves resources and writes TIFF to a caller-owned stream.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- stream System.IO.Stream
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
- cancellationToken System.Threading.CancellationToken = default
SaveAsWebp 2 overloads
public static OfficeImageExportResult SaveAsWebp(HtmlConversionDocument document, String path, HtmlRenderOptions? options = null, Int32 pageIndex = 0) #Returns:
OfficeImageExportResultSaves a shared HTML conversion document as a lossless WebP file.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- path System.String
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
public static OfficeImageExportResult SaveAsWebp(HtmlConversionDocument document, Stream stream, HtmlRenderOptions? options = null, Int32 pageIndex = 0) #Returns:
OfficeImageExportResultWrites a shared HTML conversion document as lossless WebP to a caller-owned stream.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- stream System.IO.Stream
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
SaveAsWebpAsync 2 overloads
public static Task<OfficeImageExportResult> SaveAsWebpAsync(HtmlConversionDocument document, String path, HtmlRenderOptions? options = null, Int32 pageIndex = 0, CancellationToken cancellationToken = default) #Returns:
Task<OfficeImageExportResult>Asynchronously resolves resources and saves a shared HTML conversion document as a lossless WebP file.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- path System.String
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
- cancellationToken System.Threading.CancellationToken = default
public static Task<OfficeImageExportResult> SaveAsWebpAsync(HtmlConversionDocument document, Stream stream, HtmlRenderOptions? options = null, Int32 pageIndex = 0, CancellationToken cancellationToken = default) #Returns:
Task<OfficeImageExportResult>Asynchronously resolves resources and writes lossless WebP to a caller-owned stream.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- stream System.IO.Stream
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
- cancellationToken System.Threading.CancellationToken = default
ToImage 2 overloads
public static HtmlPageImageExportBuilder ToImage(HtmlConversionDocument document) #Returns:
HtmlPageImageExportBuilderStarts fluent image export for one rendered HTML surface.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
public static HtmlPageImageExportBuilder ToImage(HtmlConversionDocument document, HtmlRenderOptions options) #Returns:
HtmlPageImageExportBuilderStarts fluent image export for one rendered HTML surface using a cloned options snapshot.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Html.HtmlRenderOptions
ToImages 2 overloads
public static HtmlPageImageBatchExportBuilder ToImages(HtmlConversionDocument document) #Returns:
HtmlPageImageBatchExportBuilderStarts fluent image export for all rendered HTML pages.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
public static HtmlPageImageBatchExportBuilder ToImages(HtmlConversionDocument document, HtmlRenderOptions options) #Returns:
HtmlPageImageBatchExportBuilderStarts fluent image export for all rendered HTML pages using a cloned options snapshot.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Html.HtmlRenderOptions
public static Byte[] ToJpeg(HtmlConversionDocument document, HtmlRenderOptions? options = null, Int32 pageIndex = 0) #Returns:
Byte[]Renders a shared HTML conversion document to JPEG bytes.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
public static async Task<Byte[]> ToJpegAsync(HtmlConversionDocument document, HtmlRenderOptions? options = null, Int32 pageIndex = 0, CancellationToken cancellationToken = default) #Returns:
Task<Byte[]>Asynchronously resolves resources and renders a shared HTML conversion document to JPEG bytes.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
- cancellationToken System.Threading.CancellationToken = default
public static Byte[] ToPng(HtmlConversionDocument document, HtmlRenderOptions? options = null, Int32 pageIndex = 0) #Returns:
Byte[]Renders a shared HTML conversion document to PNG bytes.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
public static async Task<Byte[]> ToPngAsync(HtmlConversionDocument document, HtmlRenderOptions? options = null, Int32 pageIndex = 0, CancellationToken cancellationToken = default) #Returns:
Task<Byte[]>Asynchronously resolves resources and renders a shared HTML conversion document to PNG bytes.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
- cancellationToken System.Threading.CancellationToken = default
public static String ToSvg(HtmlConversionDocument document, HtmlRenderOptions? options = null, Int32 pageIndex = 0) #Returns:
StringRenders a shared HTML conversion document to SVG text.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
public static async Task<String> ToSvgAsync(HtmlConversionDocument document, HtmlRenderOptions? options = null, Int32 pageIndex = 0, CancellationToken cancellationToken = default) #Returns:
Task<String>Asynchronously resolves resources and renders a shared HTML conversion document to SVG text.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
- cancellationToken System.Threading.CancellationToken = default
public static Byte[] ToTiff(HtmlConversionDocument document, HtmlRenderOptions? options = null, Int32 pageIndex = 0) #Returns:
Byte[]Renders a shared HTML conversion document to TIFF bytes.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
public static async Task<Byte[]> ToTiffAsync(HtmlConversionDocument document, HtmlRenderOptions? options = null, Int32 pageIndex = 0, CancellationToken cancellationToken = default) #Returns:
Task<Byte[]>Asynchronously resolves resources and renders a shared HTML conversion document to TIFF bytes.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
- cancellationToken System.Threading.CancellationToken = default
public static Byte[] ToWebp(HtmlConversionDocument document, HtmlRenderOptions? options = null, Int32 pageIndex = 0) #Returns:
Byte[]Renders a shared HTML conversion document to lossless WebP bytes.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
public static async Task<Byte[]> ToWebpAsync(HtmlConversionDocument document, HtmlRenderOptions? options = null, Int32 pageIndex = 0, CancellationToken cancellationToken = default) #Returns:
Task<Byte[]>Asynchronously resolves resources and renders a shared HTML conversion document to lossless WebP bytes.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex System.Int32 = 0
- cancellationToken System.Threading.CancellationToken = default
Inherited Methods
public virtual Boolean Equals(Object? obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object?