HtmlImageExportExtensions
OfficeIMO.Html.Pdf
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, int pageIndex = 0, CancellationToken cancellationToken = default) #Renders 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 int = 0
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeImageExportResultpublic static async Task<OfficeImageExportResult> ExportImageAsync(HtmlConversionDocument document, OfficeImageExportFormat format, HtmlRenderOptions? options = null, int pageIndex = 0, CancellationToken cancellationToken = default) #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 int = 0
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeImageExportResult>public static IReadOnlyList<OfficeImageExportResult> ExportImages(HtmlConversionDocument document, OfficeImageExportFormat format, HtmlRenderOptions? options = null) #Renders all surfaces to the requested image format.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- format OfficeIMO.Drawing.OfficeImageExportFormat
- options OfficeIMO.Html.HtmlRenderOptions? = null
Returns
IReadOnlyList<OfficeImageExportResult>public static void ExportImages(HtmlConversionDocument document, OfficeImageExportFormat format, OfficeImageExportConsumer consumer, HtmlRenderOptions? options = null, CancellationToken cancellationToken = default) #Streams 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
public static async Task<IReadOnlyList<OfficeImageExportResult>> ExportImagesAsync(HtmlConversionDocument document, OfficeImageExportFormat format, HtmlRenderOptions? options = null, CancellationToken cancellationToken = default) #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
Returns
Task<IReadOnlyList<OfficeImageExportResult>>public static async Task ExportImagesAsync(HtmlConversionDocument document, OfficeImageExportFormat format, OfficeImageExportAsyncConsumer consumer, HtmlRenderOptions? options = null, CancellationToken cancellationToken = default) #Asynchronously 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
Returns
Taskpublic static IReadOnlyList<OfficeImageExportResult> RenderImages(HtmlConversionDocument document, HtmlRenderRequest request, CancellationToken cancellationToken = default) #Executes an explicit request and encodes every retained image surface.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- request OfficeIMO.Html.HtmlRenderRequest
- cancellationToken System.Threading.CancellationToken = default
Returns
IReadOnlyList<OfficeImageExportResult>public static async Task<IReadOnlyList<OfficeImageExportResult>> RenderImagesAsync(HtmlConversionDocument document, HtmlRenderRequest request, CancellationToken cancellationToken = default) #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
Returns
Task<IReadOnlyList<OfficeImageExportResult>>public static OfficeConversionReport SaveAsImage(HtmlConversionDocument document, string path, HtmlRenderOptions? options = null, CancellationToken cancellationToken = default) #Writes the selected page to a file and returns its fidelity report.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- path string
- options OfficeIMO.Html.HtmlRenderOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeConversionReportpublic static OfficeConversionReport SaveAsImage(HtmlConversionDocument document, Stream stream, HtmlRenderOptions? options = null, CancellationToken cancellationToken = default) #Writes the selected page to a caller-owned stream and returns its fidelity report.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- stream System.IO.Stream
- options OfficeIMO.Html.HtmlRenderOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeConversionReportpublic static async Task<OfficeConversionReport> SaveAsImageAsync(HtmlConversionDocument document, string path, HtmlRenderOptions? options = null, CancellationToken cancellationToken = default) #Asynchronously writes the selected page to a file and returns its fidelity report.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- path string
- options OfficeIMO.Html.HtmlRenderOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeConversionReport>public static async Task<OfficeConversionReport> SaveAsImageAsync(HtmlConversionDocument document, Stream stream, HtmlRenderOptions? options = null, CancellationToken cancellationToken = default) #Asynchronously writes the selected page to a caller-owned stream and returns its fidelity report.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- stream System.IO.Stream
- options OfficeIMO.Html.HtmlRenderOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeConversionReport>public static OfficeConversionReport SaveAsImages(HtmlConversionDocument document, string folderPath, HtmlRenderOptions? options = null, CancellationToken cancellationToken = default) #Saves selected images without retaining payloads and returns aggregate conversion evidence.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- folderPath string
- options OfficeIMO.Html.HtmlRenderOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeConversionReportpublic static async Task<OfficeConversionReport> SaveAsImagesAsync(HtmlConversionDocument document, string folderPath, HtmlRenderOptions? options = null, CancellationToken cancellationToken = default) #Asynchronously saves selected images, retaining paths and evidence rather than encoded payloads.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- folderPath string
- options OfficeIMO.Html.HtmlRenderOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeConversionReport>public static OfficeImageExportResult SaveAsJpeg(HtmlConversionDocument document, string path, HtmlRenderOptions? options = null, int pageIndex = 0, CancellationToken cancellationToken = default) #Saves a shared HTML conversion document as a JPEG file.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- path string
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex int = 0
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeImageExportResultpublic static OfficeImageExportResult SaveAsJpeg(HtmlConversionDocument document, Stream stream, HtmlRenderOptions? options = null, int pageIndex = 0, CancellationToken cancellationToken = default) #Writes 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 int = 0
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeImageExportResultpublic static Task<OfficeImageExportResult> SaveAsJpegAsync(HtmlConversionDocument document, string path, HtmlRenderOptions? options = null, int pageIndex = 0, CancellationToken cancellationToken = default) #Asynchronously resolves resources and saves a shared HTML conversion document as a JPEG file.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- path string
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex int = 0
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeImageExportResult>public static Task<OfficeImageExportResult> SaveAsJpegAsync(HtmlConversionDocument document, Stream stream, HtmlRenderOptions? options = null, int pageIndex = 0, CancellationToken cancellationToken = default) #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 int = 0
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeImageExportResult>public static OfficeImageExportResult SaveAsPng(HtmlConversionDocument document, string path, HtmlRenderOptions? options = null, int pageIndex = 0, CancellationToken cancellationToken = default) #Saves a shared HTML conversion document as a PNG file.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- path string
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex int = 0
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeImageExportResultpublic static OfficeImageExportResult SaveAsPng(HtmlConversionDocument document, Stream stream, HtmlRenderOptions? options = null, int pageIndex = 0, CancellationToken cancellationToken = default) #Writes 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 int = 0
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeImageExportResultpublic static Task<OfficeImageExportResult> SaveAsPngAsync(HtmlConversionDocument document, string path, HtmlRenderOptions? options = null, int pageIndex = 0, CancellationToken cancellationToken = default) #Asynchronously resolves resources and saves a shared HTML conversion document as a PNG file.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- path string
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex int = 0
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeImageExportResult>public static Task<OfficeImageExportResult> SaveAsPngAsync(HtmlConversionDocument document, Stream stream, HtmlRenderOptions? options = null, int pageIndex = 0, CancellationToken cancellationToken = default) #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 int = 0
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeImageExportResult>public static OfficeImageExportResult SaveAsSvg(HtmlConversionDocument document, string path, HtmlRenderOptions? options = null, int pageIndex = 0, CancellationToken cancellationToken = default) #Saves a shared HTML conversion document as an SVG file.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- path string
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex int = 0
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeImageExportResultpublic static OfficeImageExportResult SaveAsSvg(HtmlConversionDocument document, Stream stream, HtmlRenderOptions? options = null, int pageIndex = 0, CancellationToken cancellationToken = default) #Writes 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 int = 0
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeImageExportResultpublic static Task<OfficeImageExportResult> SaveAsSvgAsync(HtmlConversionDocument document, string path, HtmlRenderOptions? options = null, int pageIndex = 0, CancellationToken cancellationToken = default) #Asynchronously resolves resources and saves a shared HTML conversion document as an SVG file.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- path string
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex int = 0
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeImageExportResult>public static Task<OfficeImageExportResult> SaveAsSvgAsync(HtmlConversionDocument document, Stream stream, HtmlRenderOptions? options = null, int pageIndex = 0, CancellationToken cancellationToken = default) #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 int = 0
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeImageExportResult>public static OfficeImageExportResult SaveAsTiff(HtmlConversionDocument document, string path, HtmlRenderOptions? options = null, int pageIndex = 0, CancellationToken cancellationToken = default) #Saves a shared HTML conversion document as a TIFF file.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- path string
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex int = 0
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeImageExportResultpublic static OfficeImageExportResult SaveAsTiff(HtmlConversionDocument document, Stream stream, HtmlRenderOptions? options = null, int pageIndex = 0, CancellationToken cancellationToken = default) #Writes 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 int = 0
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeImageExportResultpublic static Task<OfficeImageExportResult> SaveAsTiffAsync(HtmlConversionDocument document, string path, HtmlRenderOptions? options = null, int pageIndex = 0, CancellationToken cancellationToken = default) #Asynchronously resolves resources and saves a shared HTML conversion document as a TIFF file.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- path string
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex int = 0
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeImageExportResult>public static Task<OfficeImageExportResult> SaveAsTiffAsync(HtmlConversionDocument document, Stream stream, HtmlRenderOptions? options = null, int pageIndex = 0, CancellationToken cancellationToken = default) #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 int = 0
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeImageExportResult>public static OfficeImageExportResult SaveAsWebp(HtmlConversionDocument document, string path, HtmlRenderOptions? options = null, int pageIndex = 0, CancellationToken cancellationToken = default) #Saves a shared HTML conversion document as a lossless WebP file.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- path string
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex int = 0
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeImageExportResultpublic static OfficeImageExportResult SaveAsWebp(HtmlConversionDocument document, Stream stream, HtmlRenderOptions? options = null, int pageIndex = 0, CancellationToken cancellationToken = default) #Writes 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 int = 0
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeImageExportResultpublic static Task<OfficeImageExportResult> SaveAsWebpAsync(HtmlConversionDocument document, string path, HtmlRenderOptions? options = null, int pageIndex = 0, CancellationToken cancellationToken = default) #Asynchronously resolves resources and saves a shared HTML conversion document as a lossless WebP file.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- path string
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex int = 0
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeImageExportResult>public static Task<OfficeImageExportResult> SaveAsWebpAsync(HtmlConversionDocument document, Stream stream, HtmlRenderOptions? options = null, int pageIndex = 0, CancellationToken cancellationToken = default) #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 int = 0
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeImageExportResult>public static byte[] ToImage(HtmlConversionDocument document, HtmlRenderOptions? options = null, CancellationToken cancellationToken = default) #Renders the selected page using the encoding in OfficeImageExportOptions.Format.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Html.HtmlRenderOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
byte[]public static byte[] ToImage(HtmlConversionDocument document, HtmlRenderOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default) #Renders the selected page and returns its immutable fidelity report.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Html.HtmlRenderOptions?
- report OfficeIMO.OfficeConversionReport
- cancellationToken System.Threading.CancellationToken = default
Returns
byte[]public static async Task<OfficeConversionResult<byte[]>> ToImageAsync(HtmlConversionDocument document, HtmlRenderOptions? options = null, CancellationToken cancellationToken = default) #Renders the selected page with cancellation and returns the bytes and fidelity report.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Html.HtmlRenderOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeConversionResult<byte[]>>public static byte[] ToJpeg(HtmlConversionDocument document, HtmlRenderOptions? options = null, int pageIndex = 0, CancellationToken cancellationToken = default) #Renders a shared HTML conversion document to JPEG bytes.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex int = 0
- cancellationToken System.Threading.CancellationToken = default
Returns
byte[]public static async Task<byte[]> ToJpegAsync(HtmlConversionDocument document, HtmlRenderOptions? options = null, int pageIndex = 0, CancellationToken cancellationToken = default) #Asynchronously resolves resources and renders a shared HTML conversion document to JPEG bytes.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex int = 0
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<byte[]>public static byte[] ToPng(HtmlConversionDocument document, HtmlRenderOptions? options = null, int pageIndex = 0, CancellationToken cancellationToken = default) #Renders a shared HTML conversion document to PNG bytes.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex int = 0
- cancellationToken System.Threading.CancellationToken = default
Returns
byte[]public static async Task<byte[]> ToPngAsync(HtmlConversionDocument document, HtmlRenderOptions? options = null, int pageIndex = 0, CancellationToken cancellationToken = default) #Asynchronously resolves resources and renders a shared HTML conversion document to PNG bytes.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex int = 0
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<byte[]>public static string ToSvg(HtmlConversionDocument document, HtmlRenderOptions? options = null, int pageIndex = 0, CancellationToken cancellationToken = default) #Renders a shared HTML conversion document to SVG text.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex int = 0
- cancellationToken System.Threading.CancellationToken = default
Returns
stringpublic static async Task<string> ToSvgAsync(HtmlConversionDocument document, HtmlRenderOptions? options = null, int pageIndex = 0, CancellationToken cancellationToken = default) #Asynchronously resolves resources and renders a shared HTML conversion document to SVG text.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex int = 0
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<string>public static byte[] ToTiff(HtmlConversionDocument document, HtmlRenderOptions? options = null, int pageIndex = 0, CancellationToken cancellationToken = default) #Renders a shared HTML conversion document to TIFF bytes.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex int = 0
- cancellationToken System.Threading.CancellationToken = default
Returns
byte[]public static async Task<byte[]> ToTiffAsync(HtmlConversionDocument document, HtmlRenderOptions? options = null, int pageIndex = 0, CancellationToken cancellationToken = default) #Asynchronously resolves resources and renders a shared HTML conversion document to TIFF bytes.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex int = 0
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<byte[]>public static byte[] ToWebp(HtmlConversionDocument document, HtmlRenderOptions? options = null, int pageIndex = 0, CancellationToken cancellationToken = default) #Renders a shared HTML conversion document to lossless WebP bytes.
Parameters
- document OfficeIMO.Html.HtmlConversionDocument
- options OfficeIMO.Html.HtmlRenderOptions? = null
- pageIndex int = 0
- cancellationToken System.Threading.CancellationToken = default
Returns
byte[]public static async Task<byte[]> ToWebpAsync(HtmlConversionDocument document, HtmlRenderOptions? options = null, int pageIndex = 0, CancellationToken cancellationToken = default) #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 int = 0
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<byte[]>