Get Started

API Reference

Class

HtmlConversionDocument

Edit on GitHub
Namespace OfficeIMO.Html
Assembly OfficeIMO.Html
Source OfficeIMO.Html/Engine/HtmlConversionDocument.cs:72
Modifiers sealed

Canonical OfficeIMO HTML conversion document shared by target adapters.

Inheritance

  • Object
  • HtmlConversionDocument

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by

Accepted by parameters

Methods

public HtmlConversionPreflight AnalyzeFor(HtmlConversionTarget target) #
OfficeIMO.Html/Engine/HtmlConversionDocument.cs:157
Returns: HtmlConversionPreflight

Predicts supported, approximated, and omitted source features for a target before artifact creation. Results are cached per prepared document and target.

Parameters

target OfficeIMO.Html.HtmlConversionTarget requiredposition: 0
CreateDocumentForConversion 2 overloads
public IHtmlDocument CreateDocumentForConversion() #
OfficeIMO.Html/Engine/HtmlConversionDocument.cs:72
Returns: IHtmlDocument

Creates an independent policy-normalized DOM for the conversion profile's default media context.

public IHtmlDocument CreateDocumentForConversion(HtmlCssMediaContext mediaContext) #
OfficeIMO.Html/Engine/HtmlConversionDocument.cs:80
Returns: IHtmlDocument

Creates a policy-normalized DOM filtered for a target media context without reparsing source HTML or mutating shared state.

Parameters

mediaContext OfficeIMO.Html.HtmlCssMediaContext requiredposition: 0
Screen or print media context selected by the target adapter.

Returns

An independent DOM clone that the target adapter may safely mutate.

Load 2 overloads
public static HtmlConversionDocument Load(String path, HtmlConversionDocumentOptions options = null, Encoding encoding = null) #
OfficeIMO.Html/Engine/HtmlConversionDocument.IO.cs:11
Returns: HtmlConversionDocument

Loads and parses an HTML file.

Parameters

path System.String requiredposition: 0
options OfficeIMO.Html.HtmlConversionDocumentOptions = null optionalposition: 1
encoding System.Text.Encoding = null optionalposition: 2
public static HtmlConversionDocument Load(Stream stream, HtmlConversionDocumentOptions options = null, Encoding encoding = null) #
OfficeIMO.Html/Engine/HtmlConversionDocument.IO.cs:18
Returns: HtmlConversionDocument

Loads and parses HTML from a caller-owned stream.

Parameters

stream System.IO.Stream requiredposition: 0
options OfficeIMO.Html.HtmlConversionDocumentOptions = null optionalposition: 1
encoding System.Text.Encoding = null optionalposition: 2
LoadAsync 2 overloads
public static async Task<HtmlConversionDocument> LoadAsync(String path, HtmlConversionDocumentOptions options = null, Encoding encoding = null, CancellationToken cancellationToken = null) #
Returns: Task<HtmlConversionDocument>

Asynchronously loads and parses an HTML file.

Parameters

path System.String requiredposition: 0
options OfficeIMO.Html.HtmlConversionDocumentOptions = null optionalposition: 1
encoding System.Text.Encoding = null optionalposition: 2
cancellationToken System.Threading.CancellationToken = null optionalposition: 3
public static async Task<HtmlConversionDocument> LoadAsync(Stream stream, HtmlConversionDocumentOptions options = null, Encoding encoding = null, CancellationToken cancellationToken = null) #
Returns: Task<HtmlConversionDocument>

Asynchronously loads and parses HTML from a caller-owned stream.

Parameters

stream System.IO.Stream requiredposition: 0
options OfficeIMO.Html.HtmlConversionDocumentOptions = null optionalposition: 1
encoding System.Text.Encoding = null optionalposition: 2
cancellationToken System.Threading.CancellationToken = null optionalposition: 3
public static HtmlConversionDocument Parse(String html, HtmlConversionDocumentOptions options = null) #
OfficeIMO.Html/Engine/HtmlConversionDocument.Parse.cs:10
Returns: HtmlConversionDocument

Parses HTML and builds a shared conversion document with logical, style, resource, and normalized-output evidence.

Parameters

html System.String requiredposition: 0
options OfficeIMO.Html.HtmlConversionDocumentOptions = null optionalposition: 1

Properties

public String SourceHtml { get; } #
OfficeIMO.Html/Engine/HtmlConversionDocument.cs:67

Original HTML supplied by the caller.

public HtmlConversionProfileContract ProfileContract { get; } #
OfficeIMO.Html/Engine/HtmlConversionDocument.cs:141

Profile contract advertised to target adapters and galleries.

public HtmlInputTrust Trust { get; } #
OfficeIMO.Html/Engine/HtmlConversionDocument.cs:144

Caller-assigned input trust boundary used by downstream adapters.

public HtmlLogicalDocument LogicalDocument { get; } #
OfficeIMO.Html/Engine/HtmlConversionDocument.cs:147

Normalized logical structure used for semantic scoring and adapter planning.

public HtmlSemanticDocument SemanticDocument { get; } #
OfficeIMO.Html/Engine/HtmlConversionDocument.cs:150

Typed semantic structure interpreted once for generic native target adapters.

public HtmlComputedStyleSummary StyleSummary { get; } #
OfficeIMO.Html/Engine/HtmlConversionDocument.cs:167

Compact computed-style capability summary.

public HtmlResourceManifest ResourceManifest { get; } #
OfficeIMO.Html/Engine/HtmlConversionDocument.cs:170

Raw resource manifest discovered in document order.

public HtmlResourceDependencyPlan ResourcePlan { get; } #
OfficeIMO.Html/Engine/HtmlConversionDocument.cs:173

Resource dependency plan grouped for adapters, reports, and gallery manifests.

public Uri BaseUri { get; } #
OfficeIMO.Html/Engine/HtmlConversionDocument.cs:176

Effective base URI used to resolve relative resources, including a document base element when present.

public String NormalizedHtml { get; } #
OfficeIMO.Html/Engine/HtmlConversionDocument.cs:182

Policy-aware normalized HTML, or an empty string when normalization was disabled.

public IReadOnlyList<HtmlDiagnostic> Diagnostics { get; } #
OfficeIMO.Html/Engine/HtmlConversionDocument.cs:187

Diagnostics emitted while lazily preparing shared conversion views.

public String HtmlForConversion { get; } #
OfficeIMO.Html/Engine/HtmlConversionDocument.cs:194

HTML text target adapters should use when no adapter-specific source preference is configured.

Extension Methods

public static OfficeImageExportResult ExportImage(HtmlConversionDocument document, OfficeImageExportFormat format, HtmlRenderOptions options = null, Int32 pageIndex = 0) #
OfficeIMO.Html/Rendering/HtmlImageExportExtensions.Results.Sources.cs:8
Returns: OfficeImageExportResult

Renders one selected surface to the requested image format with dimensions and diagnostics.

Parameters

document OfficeIMO.Html.HtmlConversionDocument requiredposition: 0
format OfficeIMO.Drawing.OfficeImageExportFormat requiredposition: 1
options OfficeIMO.Html.HtmlRenderOptions = null optionalposition: 2
pageIndex System.Int32 = 0 optionalposition: 3
public static async Task<OfficeImageExportResult> ExportImageAsync(HtmlConversionDocument document, OfficeImageExportFormat format, HtmlRenderOptions options = null, Int32 pageIndex = 0, CancellationToken cancellationToken = null) #
Returns: Task<OfficeImageExportResult>

Asynchronously renders one selected surface to the requested image format.

Parameters

document OfficeIMO.Html.HtmlConversionDocument requiredposition: 0
format OfficeIMO.Drawing.OfficeImageExportFormat requiredposition: 1
options OfficeIMO.Html.HtmlRenderOptions = null optionalposition: 2
pageIndex System.Int32 = 0 optionalposition: 3
cancellationToken System.Threading.CancellationToken = null optionalposition: 4
ExportImages 2 overloads
public static IReadOnlyList<OfficeImageExportResult> ExportImages(HtmlConversionDocument document, OfficeImageExportFormat format, HtmlRenderOptions options = null) #
OfficeIMO.Html/Rendering/HtmlImageExportExtensions.Results.Sources.cs:16
Returns: IReadOnlyList<OfficeImageExportResult>

Renders all surfaces to the requested image format.

Parameters

document OfficeIMO.Html.HtmlConversionDocument requiredposition: 0
format OfficeIMO.Drawing.OfficeImageExportFormat requiredposition: 1
options OfficeIMO.Html.HtmlRenderOptions = null optionalposition: 2
public static Void ExportImages(HtmlConversionDocument document, OfficeImageExportFormat format, OfficeImageExportConsumer consumer, HtmlRenderOptions options = null, CancellationToken cancellationToken = null) #
OfficeIMO.Html/Rendering/HtmlImageExportExtensions.Results.Sources.cs:28
Returns: Void

Streams rendered surfaces without retaining earlier encoded payloads.

Parameters

document OfficeIMO.Html.HtmlConversionDocument requiredposition: 0
format OfficeIMO.Drawing.OfficeImageExportFormat requiredposition: 1
consumer OfficeIMO.Drawing.OfficeImageExportConsumer requiredposition: 2
options OfficeIMO.Html.HtmlRenderOptions = null optionalposition: 3
cancellationToken System.Threading.CancellationToken = null optionalposition: 4
ExportImagesAsync 2 overloads
public static async Task<IReadOnlyList<OfficeImageExportResult>> ExportImagesAsync(HtmlConversionDocument document, OfficeImageExportFormat format, HtmlRenderOptions options = null, CancellationToken cancellationToken = null) #
Returns: Task<IReadOnlyList<OfficeImageExportResult>>

Asynchronously renders all surfaces to the requested image format.

Parameters

document OfficeIMO.Html.HtmlConversionDocument requiredposition: 0
format OfficeIMO.Drawing.OfficeImageExportFormat requiredposition: 1
options OfficeIMO.Html.HtmlRenderOptions = null optionalposition: 2
cancellationToken System.Threading.CancellationToken = null optionalposition: 3
public static async Task ExportImagesAsync(HtmlConversionDocument document, OfficeImageExportFormat format, OfficeImageExportAsyncConsumer consumer, HtmlRenderOptions options = null, CancellationToken cancellationToken = null) #
Returns: Task

Asynchronously streams rendered surfaces without retaining earlier encoded payloads.

Parameters

document OfficeIMO.Html.HtmlConversionDocument requiredposition: 0
format OfficeIMO.Drawing.OfficeImageExportFormat requiredposition: 1
consumer OfficeIMO.Drawing.OfficeImageExportAsyncConsumer requiredposition: 2
options OfficeIMO.Html.HtmlRenderOptions = null optionalposition: 3
cancellationToken System.Threading.CancellationToken = null optionalposition: 4
SaveAsJpeg 2 overloads
public static OfficeImageExportResult SaveAsJpeg(HtmlConversionDocument document, String path, HtmlRenderOptions options = null, Int32 pageIndex = 0) #
OfficeIMO.Html/Rendering/HtmlImageExportExtensions.Sources.RasterFormats.cs:32
Returns: OfficeImageExportResult

Saves a shared HTML conversion document as a JPEG file.

Parameters

document OfficeIMO.Html.HtmlConversionDocument requiredposition: 0
path System.String requiredposition: 1
options OfficeIMO.Html.HtmlRenderOptions = null optionalposition: 2
pageIndex System.Int32 = 0 optionalposition: 3
public static OfficeImageExportResult SaveAsJpeg(HtmlConversionDocument document, Stream stream, HtmlRenderOptions options = null, Int32 pageIndex = 0) #
OfficeIMO.Html/Rendering/HtmlImageExportExtensions.Sources.RasterFormats.cs:44
Returns: OfficeImageExportResult

Writes a shared HTML conversion document as JPEG to a caller-owned stream.

Parameters

document OfficeIMO.Html.HtmlConversionDocument requiredposition: 0
stream System.IO.Stream requiredposition: 1
options OfficeIMO.Html.HtmlRenderOptions = null optionalposition: 2
pageIndex System.Int32 = 0 optionalposition: 3
SaveAsJpegAsync 2 overloads
public static Task<OfficeImageExportResult> SaveAsJpegAsync(HtmlConversionDocument document, String path, HtmlRenderOptions options = null, Int32 pageIndex = 0, CancellationToken cancellationToken = null) #
OfficeIMO.Html/Rendering/HtmlImageExportExtensions.Sources.RasterFormats.cs:56
Returns: Task<OfficeImageExportResult>

Asynchronously resolves resources and saves a shared HTML conversion document as a JPEG file.

Parameters

document OfficeIMO.Html.HtmlConversionDocument requiredposition: 0
path System.String requiredposition: 1
options OfficeIMO.Html.HtmlRenderOptions = null optionalposition: 2
pageIndex System.Int32 = 0 optionalposition: 3
cancellationToken System.Threading.CancellationToken = null optionalposition: 4
public static Task<OfficeImageExportResult> SaveAsJpegAsync(HtmlConversionDocument document, Stream stream, HtmlRenderOptions options = null, Int32 pageIndex = 0, CancellationToken cancellationToken = null) #
OfficeIMO.Html/Rendering/HtmlImageExportExtensions.Sources.RasterFormats.cs:68
Returns: Task<OfficeImageExportResult>

Asynchronously resolves resources and writes JPEG to a caller-owned stream.

Parameters

document OfficeIMO.Html.HtmlConversionDocument requiredposition: 0
stream System.IO.Stream requiredposition: 1
options OfficeIMO.Html.HtmlRenderOptions = null optionalposition: 2
pageIndex System.Int32 = 0 optionalposition: 3
cancellationToken System.Threading.CancellationToken = null optionalposition: 4
SaveAsPng 2 overloads
public static OfficeImageExportResult SaveAsPng(HtmlConversionDocument document, String path, HtmlRenderOptions options = null, Int32 pageIndex = 0) #
OfficeIMO.Html/Rendering/HtmlImageExportExtensions.Sources.cs:24
Returns: OfficeImageExportResult

Saves a shared HTML conversion document as a PNG file.

Parameters

document OfficeIMO.Html.HtmlConversionDocument requiredposition: 0
path System.String requiredposition: 1
options OfficeIMO.Html.HtmlRenderOptions = null optionalposition: 2
pageIndex System.Int32 = 0 optionalposition: 3
public static OfficeImageExportResult SaveAsPng(HtmlConversionDocument document, Stream stream, HtmlRenderOptions options = null, Int32 pageIndex = 0) #
OfficeIMO.Html/Rendering/HtmlImageExportExtensions.Sources.cs:32
Returns: OfficeImageExportResult

Writes a shared HTML conversion document as PNG to a caller-owned stream.

Parameters

document OfficeIMO.Html.HtmlConversionDocument requiredposition: 0
stream System.IO.Stream requiredposition: 1
options OfficeIMO.Html.HtmlRenderOptions = null optionalposition: 2
pageIndex System.Int32 = 0 optionalposition: 3
SaveAsPngAsync 2 overloads
public static Task<OfficeImageExportResult> SaveAsPngAsync(HtmlConversionDocument document, String path, HtmlRenderOptions options = null, Int32 pageIndex = 0, CancellationToken cancellationToken = null) #
OfficeIMO.Html/Rendering/HtmlImageExportExtensions.Sources.cs:40
Returns: Task<OfficeImageExportResult>

Asynchronously resolves resources and saves a shared HTML conversion document as a PNG file.

Parameters

document OfficeIMO.Html.HtmlConversionDocument requiredposition: 0
path System.String requiredposition: 1
options OfficeIMO.Html.HtmlRenderOptions = null optionalposition: 2
pageIndex System.Int32 = 0 optionalposition: 3
cancellationToken System.Threading.CancellationToken = null optionalposition: 4
public static Task<OfficeImageExportResult> SaveAsPngAsync(HtmlConversionDocument document, Stream stream, HtmlRenderOptions options = null, Int32 pageIndex = 0, CancellationToken cancellationToken = null) #
OfficeIMO.Html/Rendering/HtmlImageExportExtensions.Sources.cs:48
Returns: Task<OfficeImageExportResult>

Asynchronously resolves resources and writes PNG to a caller-owned stream.

Parameters

document OfficeIMO.Html.HtmlConversionDocument requiredposition: 0
stream System.IO.Stream requiredposition: 1
options OfficeIMO.Html.HtmlRenderOptions = null optionalposition: 2
pageIndex System.Int32 = 0 optionalposition: 3
cancellationToken System.Threading.CancellationToken = null optionalposition: 4
SaveAsRtf 2 overloads
public static Void SaveAsRtf(HtmlConversionDocument document, String path, HtmlToRtfOptions readOptions = null, RtfWriteOptions writeOptions = null, Encoding encoding = null) #
OfficeIMO.Html/Rtf/HtmlRtfConverterExtensions.cs:104
Returns: Void

Saves semantic HTML as an RTF file at the specified path.

Parameters

document OfficeIMO.Html.HtmlConversionDocument requiredposition: 0
path System.String requiredposition: 1
readOptions OfficeIMO.Html.HtmlToRtfOptions = null optionalposition: 2
writeOptions OfficeIMO.Rtf.RtfWriteOptions = null optionalposition: 3
encoding System.Text.Encoding = null optionalposition: 4
public static Void SaveAsRtf(HtmlConversionDocument document, Stream stream, HtmlToRtfOptions readOptions = null, RtfWriteOptions writeOptions = null, Encoding encoding = null) #
OfficeIMO.Html/Rtf/HtmlRtfConverterExtensions.cs:113
Returns: Void

Saves semantic HTML as RTF to a stream without closing or rewinding the stream.

Parameters

document OfficeIMO.Html.HtmlConversionDocument requiredposition: 0
stream System.IO.Stream requiredposition: 1
readOptions OfficeIMO.Html.HtmlToRtfOptions = null optionalposition: 2
writeOptions OfficeIMO.Rtf.RtfWriteOptions = null optionalposition: 3
encoding System.Text.Encoding = null optionalposition: 4
SaveAsRtfAsync 2 overloads
public static async Task SaveAsRtfAsync(HtmlConversionDocument document, String path, HtmlToRtfOptions readOptions = null, RtfWriteOptions writeOptions = null, Encoding encoding = null, CancellationToken cancellationToken = null) #
Returns: Task

Saves semantic HTML as an RTF file at the specified path.

Parameters

document OfficeIMO.Html.HtmlConversionDocument requiredposition: 0
path System.String requiredposition: 1
readOptions OfficeIMO.Html.HtmlToRtfOptions = null optionalposition: 2
writeOptions OfficeIMO.Rtf.RtfWriteOptions = null optionalposition: 3
encoding System.Text.Encoding = null optionalposition: 4
cancellationToken System.Threading.CancellationToken = null optionalposition: 5
public static async Task SaveAsRtfAsync(HtmlConversionDocument document, Stream stream, HtmlToRtfOptions readOptions = null, RtfWriteOptions writeOptions = null, Encoding encoding = null, CancellationToken cancellationToken = null) #
Returns: Task

Saves semantic HTML as RTF to a writable stream without closing or rewinding the stream.

Parameters

document OfficeIMO.Html.HtmlConversionDocument requiredposition: 0
stream System.IO.Stream requiredposition: 1
readOptions OfficeIMO.Html.HtmlToRtfOptions = null optionalposition: 2
writeOptions OfficeIMO.Rtf.RtfWriteOptions = null optionalposition: 3
encoding System.Text.Encoding = null optionalposition: 4
cancellationToken System.Threading.CancellationToken = null optionalposition: 5
SaveAsSvg 2 overloads
public static OfficeImageExportResult SaveAsSvg(HtmlConversionDocument document, String path, HtmlRenderOptions options = null, Int32 pageIndex = 0) #
OfficeIMO.Html/Rendering/HtmlImageExportExtensions.Sources.cs:28
Returns: OfficeImageExportResult

Saves a shared HTML conversion document as an SVG file.

Parameters

document OfficeIMO.Html.HtmlConversionDocument requiredposition: 0
path System.String requiredposition: 1
options OfficeIMO.Html.HtmlRenderOptions = null optionalposition: 2
pageIndex System.Int32 = 0 optionalposition: 3
public static OfficeImageExportResult SaveAsSvg(HtmlConversionDocument document, Stream stream, HtmlRenderOptions options = null, Int32 pageIndex = 0) #
OfficeIMO.Html/Rendering/HtmlImageExportExtensions.Sources.cs:36
Returns: OfficeImageExportResult

Writes a shared HTML conversion document as SVG to a caller-owned stream.

Parameters

document OfficeIMO.Html.HtmlConversionDocument requiredposition: 0
stream System.IO.Stream requiredposition: 1
options OfficeIMO.Html.HtmlRenderOptions = null optionalposition: 2
pageIndex System.Int32 = 0 optionalposition: 3
SaveAsSvgAsync 2 overloads
public static Task<OfficeImageExportResult> SaveAsSvgAsync(HtmlConversionDocument document, String path, HtmlRenderOptions options = null, Int32 pageIndex = 0, CancellationToken cancellationToken = null) #
OfficeIMO.Html/Rendering/HtmlImageExportExtensions.Sources.cs:44
Returns: Task<OfficeImageExportResult>

Asynchronously resolves resources and saves a shared HTML conversion document as an SVG file.

Parameters

document OfficeIMO.Html.HtmlConversionDocument requiredposition: 0
path System.String requiredposition: 1
options OfficeIMO.Html.HtmlRenderOptions = null optionalposition: 2
pageIndex System.Int32 = 0 optionalposition: 3
cancellationToken System.Threading.CancellationToken = null optionalposition: 4
public static Task<OfficeImageExportResult> SaveAsSvgAsync(HtmlConversionDocument document, Stream stream, HtmlRenderOptions options = null, Int32 pageIndex = 0, CancellationToken cancellationToken = null) #
OfficeIMO.Html/Rendering/HtmlImageExportExtensions.Sources.cs:52
Returns: Task<OfficeImageExportResult>

Asynchronously resolves resources and writes SVG to a caller-owned stream.

Parameters

document OfficeIMO.Html.HtmlConversionDocument requiredposition: 0
stream System.IO.Stream requiredposition: 1
options OfficeIMO.Html.HtmlRenderOptions = null optionalposition: 2
pageIndex System.Int32 = 0 optionalposition: 3
cancellationToken System.Threading.CancellationToken = null optionalposition: 4
SaveAsTiff 2 overloads
public static OfficeImageExportResult SaveAsTiff(HtmlConversionDocument document, String path, HtmlRenderOptions options = null, Int32 pageIndex = 0) #
OfficeIMO.Html/Rendering/HtmlImageExportExtensions.Sources.RasterFormats.cs:36
Returns: OfficeImageExportResult

Saves a shared HTML conversion document as a TIFF file.

Parameters

document OfficeIMO.Html.HtmlConversionDocument requiredposition: 0
path System.String requiredposition: 1
options OfficeIMO.Html.HtmlRenderOptions = null optionalposition: 2
pageIndex System.Int32 = 0 optionalposition: 3
public static OfficeImageExportResult SaveAsTiff(HtmlConversionDocument document, Stream stream, HtmlRenderOptions options = null, Int32 pageIndex = 0) #
OfficeIMO.Html/Rendering/HtmlImageExportExtensions.Sources.RasterFormats.cs:48
Returns: OfficeImageExportResult

Writes a shared HTML conversion document as TIFF to a caller-owned stream.

Parameters

document OfficeIMO.Html.HtmlConversionDocument requiredposition: 0
stream System.IO.Stream requiredposition: 1
options OfficeIMO.Html.HtmlRenderOptions = null optionalposition: 2
pageIndex System.Int32 = 0 optionalposition: 3
SaveAsTiffAsync 2 overloads
public static Task<OfficeImageExportResult> SaveAsTiffAsync(HtmlConversionDocument document, String path, HtmlRenderOptions options = null, Int32 pageIndex = 0, CancellationToken cancellationToken = null) #
OfficeIMO.Html/Rendering/HtmlImageExportExtensions.Sources.RasterFormats.cs:60
Returns: Task<OfficeImageExportResult>

Asynchronously resolves resources and saves a shared HTML conversion document as a TIFF file.

Parameters

document OfficeIMO.Html.HtmlConversionDocument requiredposition: 0
path System.String requiredposition: 1
options OfficeIMO.Html.HtmlRenderOptions = null optionalposition: 2
pageIndex System.Int32 = 0 optionalposition: 3
cancellationToken System.Threading.CancellationToken = null optionalposition: 4
public static Task<OfficeImageExportResult> SaveAsTiffAsync(HtmlConversionDocument document, Stream stream, HtmlRenderOptions options = null, Int32 pageIndex = 0, CancellationToken cancellationToken = null) #
OfficeIMO.Html/Rendering/HtmlImageExportExtensions.Sources.RasterFormats.cs:72
Returns: Task<OfficeImageExportResult>

Asynchronously resolves resources and writes TIFF to a caller-owned stream.

Parameters

document OfficeIMO.Html.HtmlConversionDocument requiredposition: 0
stream System.IO.Stream requiredposition: 1
options OfficeIMO.Html.HtmlRenderOptions = null optionalposition: 2
pageIndex System.Int32 = 0 optionalposition: 3
cancellationToken System.Threading.CancellationToken = null optionalposition: 4
SaveAsWebp 2 overloads
public static OfficeImageExportResult SaveAsWebp(HtmlConversionDocument document, String path, HtmlRenderOptions options = null, Int32 pageIndex = 0) #
OfficeIMO.Html/Rendering/HtmlImageExportExtensions.Sources.RasterFormats.cs:40
Returns: OfficeImageExportResult

Saves a shared HTML conversion document as a lossless WebP file.

Parameters

document OfficeIMO.Html.HtmlConversionDocument requiredposition: 0
path System.String requiredposition: 1
options OfficeIMO.Html.HtmlRenderOptions = null optionalposition: 2
pageIndex System.Int32 = 0 optionalposition: 3
public static OfficeImageExportResult SaveAsWebp(HtmlConversionDocument document, Stream stream, HtmlRenderOptions options = null, Int32 pageIndex = 0) #
OfficeIMO.Html/Rendering/HtmlImageExportExtensions.Sources.RasterFormats.cs:52
Returns: OfficeImageExportResult

Writes a shared HTML conversion document as lossless WebP to a caller-owned stream.

Parameters

document OfficeIMO.Html.HtmlConversionDocument requiredposition: 0
stream System.IO.Stream requiredposition: 1
options OfficeIMO.Html.HtmlRenderOptions = null optionalposition: 2
pageIndex System.Int32 = 0 optionalposition: 3
SaveAsWebpAsync 2 overloads
public static Task<OfficeImageExportResult> SaveAsWebpAsync(HtmlConversionDocument document, String path, HtmlRenderOptions options = null, Int32 pageIndex = 0, CancellationToken cancellationToken = null) #
OfficeIMO.Html/Rendering/HtmlImageExportExtensions.Sources.RasterFormats.cs:64
Returns: Task<OfficeImageExportResult>

Asynchronously resolves resources and saves a shared HTML conversion document as a lossless WebP file.

Parameters

document OfficeIMO.Html.HtmlConversionDocument requiredposition: 0
path System.String requiredposition: 1
options OfficeIMO.Html.HtmlRenderOptions = null optionalposition: 2
pageIndex System.Int32 = 0 optionalposition: 3
cancellationToken System.Threading.CancellationToken = null optionalposition: 4
public static Task<OfficeImageExportResult> SaveAsWebpAsync(HtmlConversionDocument document, Stream stream, HtmlRenderOptions options = null, Int32 pageIndex = 0, CancellationToken cancellationToken = null) #
OfficeIMO.Html/Rendering/HtmlImageExportExtensions.Sources.RasterFormats.cs:76
Returns: Task<OfficeImageExportResult>

Asynchronously resolves resources and writes lossless WebP to a caller-owned stream.

Parameters

document OfficeIMO.Html.HtmlConversionDocument requiredposition: 0
stream System.IO.Stream requiredposition: 1
options OfficeIMO.Html.HtmlRenderOptions = null optionalposition: 2
pageIndex System.Int32 = 0 optionalposition: 3
cancellationToken System.Threading.CancellationToken = null optionalposition: 4
ToImage 2 overloads
public static HtmlPageImageExportBuilder ToImage(HtmlConversionDocument document) #
OfficeIMO.Html/Rendering/HtmlImageExportBuilder.cs:107
Returns: HtmlPageImageExportBuilder

Starts fluent image export for one rendered HTML surface.

Parameters

document OfficeIMO.Html.HtmlConversionDocument requiredposition: 0
public static HtmlPageImageExportBuilder ToImage(HtmlConversionDocument document, HtmlRenderOptions options) #
OfficeIMO.Html/Rendering/HtmlImageExportBuilder.cs:111
Returns: HtmlPageImageExportBuilder

Starts fluent image export for one rendered HTML surface using a cloned options snapshot.

Parameters

document OfficeIMO.Html.HtmlConversionDocument requiredposition: 0
options OfficeIMO.Html.HtmlRenderOptions requiredposition: 1
ToImages 2 overloads
public static HtmlPageImageBatchExportBuilder ToImages(HtmlConversionDocument document) #
OfficeIMO.Html/Rendering/HtmlImageExportBuilder.cs:117
Returns: HtmlPageImageBatchExportBuilder

Starts fluent image export for all rendered HTML pages.

Parameters

document OfficeIMO.Html.HtmlConversionDocument requiredposition: 0
public static HtmlPageImageBatchExportBuilder ToImages(HtmlConversionDocument document, HtmlRenderOptions options) #
OfficeIMO.Html/Rendering/HtmlImageExportBuilder.cs:121
Returns: HtmlPageImageBatchExportBuilder

Starts fluent image export for all rendered HTML pages using a cloned options snapshot.

Parameters

document OfficeIMO.Html.HtmlConversionDocument requiredposition: 0
options OfficeIMO.Html.HtmlRenderOptions requiredposition: 1
public static Byte[] ToJpeg(HtmlConversionDocument document, HtmlRenderOptions options = null, Int32 pageIndex = 0) #
OfficeIMO.Html/Rendering/HtmlImageExportExtensions.Sources.RasterFormats.cs:8
Returns: Byte[]

Renders a shared HTML conversion document to JPEG bytes.

Parameters

document OfficeIMO.Html.HtmlConversionDocument requiredposition: 0
options OfficeIMO.Html.HtmlRenderOptions = null optionalposition: 1
pageIndex System.Int32 = 0 optionalposition: 2
public static async Task<Byte[]> ToJpegAsync(HtmlConversionDocument document, HtmlRenderOptions options = null, Int32 pageIndex = 0, CancellationToken cancellationToken = null) #
Returns: Task<Byte[]>

Asynchronously resolves resources and renders a shared HTML conversion document to JPEG bytes.

Parameters

document OfficeIMO.Html.HtmlConversionDocument requiredposition: 0
options OfficeIMO.Html.HtmlRenderOptions = null optionalposition: 1
pageIndex System.Int32 = 0 optionalposition: 2
cancellationToken System.Threading.CancellationToken = null optionalposition: 3
public static Byte[] ToPng(HtmlConversionDocument document, HtmlRenderOptions options = null, Int32 pageIndex = 0) #
OfficeIMO.Html/Rendering/HtmlImageExportExtensions.Sources.cs:8
Returns: Byte[]

Renders a shared HTML conversion document to PNG bytes.

Parameters

document OfficeIMO.Html.HtmlConversionDocument requiredposition: 0
options OfficeIMO.Html.HtmlRenderOptions = null optionalposition: 1
pageIndex System.Int32 = 0 optionalposition: 2
public static async Task<Byte[]> ToPngAsync(HtmlConversionDocument document, HtmlRenderOptions options = null, Int32 pageIndex = 0, CancellationToken cancellationToken = null) #
Returns: Task<Byte[]>

Asynchronously resolves resources and renders a shared HTML conversion document to PNG bytes.

Parameters

document OfficeIMO.Html.HtmlConversionDocument requiredposition: 0
options OfficeIMO.Html.HtmlRenderOptions = null optionalposition: 1
pageIndex System.Int32 = 0 optionalposition: 2
cancellationToken System.Threading.CancellationToken = null optionalposition: 3
public static String ToRtf(HtmlConversionDocument document, HtmlToRtfOptions readOptions = null, RtfWriteOptions writeOptions = null) #
OfficeIMO.Html/Rtf/HtmlRtfConverterExtensions.cs:89
Returns: String

Converts semantic HTML to RTF text.

Parameters

document OfficeIMO.Html.HtmlConversionDocument requiredposition: 0
readOptions OfficeIMO.Html.HtmlToRtfOptions = null optionalposition: 1
writeOptions OfficeIMO.Rtf.RtfWriteOptions = null optionalposition: 2
public static Byte[] ToRtfBytes(HtmlConversionDocument document, HtmlToRtfOptions readOptions = null, RtfWriteOptions writeOptions = null, Encoding encoding = null) #
OfficeIMO.Html/Rtf/HtmlRtfConverterExtensions.cs:94
Returns: Byte[]

Converts semantic HTML to encoded RTF bytes.

Parameters

document OfficeIMO.Html.HtmlConversionDocument requiredposition: 0
readOptions OfficeIMO.Html.HtmlToRtfOptions = null optionalposition: 1
writeOptions OfficeIMO.Rtf.RtfWriteOptions = null optionalposition: 2
encoding System.Text.Encoding = null optionalposition: 3
public static RtfDocument ToRtfDocument(HtmlConversionDocument document, HtmlToRtfOptions options = null) #
OfficeIMO.Html/Rtf/HtmlRtfConverterExtensions.cs:84
Returns: RtfDocument

Loads a prepared shared HTML conversion document into an RTF document model without reparsing.

Parameters

document OfficeIMO.Html.HtmlConversionDocument requiredposition: 0
options OfficeIMO.Html.HtmlToRtfOptions = null optionalposition: 1
public static HtmlToRtfResult ToRtfDocumentResult(HtmlConversionDocument document, HtmlToRtfOptions options = null) #
OfficeIMO.Html/Rtf/HtmlRtfConverterExtensions.Results.cs:6
Returns: HtmlToRtfResult

Imports a prepared shared HTML document into RTF and returns structured evidence.

Parameters

document OfficeIMO.Html.HtmlConversionDocument requiredposition: 0
options OfficeIMO.Html.HtmlToRtfOptions = null optionalposition: 1
public static MemoryStream ToRtfStream(HtmlConversionDocument document, HtmlToRtfOptions readOptions = null, RtfWriteOptions writeOptions = null, Encoding encoding = null) #
OfficeIMO.Html/Rtf/HtmlRtfConverterExtensions.cs:99
Returns: MemoryStream

Converts semantic HTML to an encoded RTF memory stream.

Parameters

document OfficeIMO.Html.HtmlConversionDocument requiredposition: 0
readOptions OfficeIMO.Html.HtmlToRtfOptions = null optionalposition: 1
writeOptions OfficeIMO.Rtf.RtfWriteOptions = null optionalposition: 2
encoding System.Text.Encoding = null optionalposition: 3
public static String ToSvg(HtmlConversionDocument document, HtmlRenderOptions options = null, Int32 pageIndex = 0) #
OfficeIMO.Html/Rendering/HtmlImageExportExtensions.Sources.cs:12
Returns: String

Renders a shared HTML conversion document to SVG text.

Parameters

document OfficeIMO.Html.HtmlConversionDocument requiredposition: 0
options OfficeIMO.Html.HtmlRenderOptions = null optionalposition: 1
pageIndex System.Int32 = 0 optionalposition: 2
public static async Task<String> ToSvgAsync(HtmlConversionDocument document, HtmlRenderOptions options = null, Int32 pageIndex = 0, CancellationToken cancellationToken = null) #
Returns: Task<String>

Asynchronously resolves resources and renders a shared HTML conversion document to SVG text.

Parameters

document OfficeIMO.Html.HtmlConversionDocument requiredposition: 0
options OfficeIMO.Html.HtmlRenderOptions = null optionalposition: 1
pageIndex System.Int32 = 0 optionalposition: 2
cancellationToken System.Threading.CancellationToken = null optionalposition: 3
public static Byte[] ToTiff(HtmlConversionDocument document, HtmlRenderOptions options = null, Int32 pageIndex = 0) #
OfficeIMO.Html/Rendering/HtmlImageExportExtensions.Sources.RasterFormats.cs:12
Returns: Byte[]

Renders a shared HTML conversion document to TIFF bytes.

Parameters

document OfficeIMO.Html.HtmlConversionDocument requiredposition: 0
options OfficeIMO.Html.HtmlRenderOptions = null optionalposition: 1
pageIndex System.Int32 = 0 optionalposition: 2
public static async Task<Byte[]> ToTiffAsync(HtmlConversionDocument document, HtmlRenderOptions options = null, Int32 pageIndex = 0, CancellationToken cancellationToken = null) #
Returns: Task<Byte[]>

Asynchronously resolves resources and renders a shared HTML conversion document to TIFF bytes.

Parameters

document OfficeIMO.Html.HtmlConversionDocument requiredposition: 0
options OfficeIMO.Html.HtmlRenderOptions = null optionalposition: 1
pageIndex System.Int32 = 0 optionalposition: 2
cancellationToken System.Threading.CancellationToken = null optionalposition: 3
public static Byte[] ToWebp(HtmlConversionDocument document, HtmlRenderOptions options = null, Int32 pageIndex = 0) #
OfficeIMO.Html/Rendering/HtmlImageExportExtensions.Sources.RasterFormats.cs:16
Returns: Byte[]

Renders a shared HTML conversion document to lossless WebP bytes.

Parameters

document OfficeIMO.Html.HtmlConversionDocument requiredposition: 0
options OfficeIMO.Html.HtmlRenderOptions = null optionalposition: 1
pageIndex System.Int32 = 0 optionalposition: 2
public static async Task<Byte[]> ToWebpAsync(HtmlConversionDocument document, HtmlRenderOptions options = null, Int32 pageIndex = 0, CancellationToken cancellationToken = null) #
Returns: Task<Byte[]>

Asynchronously resolves resources and renders a shared HTML conversion document to lossless WebP bytes.

Parameters

document OfficeIMO.Html.HtmlConversionDocument requiredposition: 0
options OfficeIMO.Html.HtmlRenderOptions = null optionalposition: 1
pageIndex System.Int32 = 0 optionalposition: 2
cancellationToken System.Threading.CancellationToken = null optionalposition: 3