API Reference
HtmlRenderResult
A resolved request and its retained backend-neutral scene. Output adapters consume this result without choosing new CSS, layout, pagination, or page-selection defaults.
Inheritance
- Object
- HtmlRenderResult
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
- Extension method HtmlRenderResult.ExportArchive
- Extension method HtmlRenderResult.ExportImage
- Extension method HtmlRenderResult.ExportImages
- Method HtmlRenderResultArchiveExtensions.ExportArchive
- Method HtmlRenderResultImageExtensions.ExportImage
- Method HtmlRenderResultImageExtensions.ExportImages
Methods
public HtmlRenderSurface GetSurface(Int32 outputIndex) #HtmlRenderSurfaceGets one executable output surface by zero-based index.
Parameters
- outputIndex System.Int32
public HtmlRenderResult RequireNoLoss() #HtmlRenderResultThrows with the complete report when the retained result is not lossless.
public HtmlRenderResult WithAdditionalDiagnostics(IEnumerable<HtmlDiagnostic> diagnostics) #HtmlRenderResultReturns an equivalent retained result carrying additional diagnostics from an owning container, adapter, or input boundary. The current result remains unchanged.
Parameters
- diagnostics System.Collections.Generic.IEnumerable{OfficeIMO.Html.HtmlDiagnostic}
Inherited Methods
Properties
public HtmlRenderRequest Request { get; } #Independent immutable request snapshot used for this operation.
public HtmlRenderDocument Document { get; } #Selected, sliced, or stitched backend-neutral display list.
public IReadOnlyList<HtmlRenderSurfaceResult> Surfaces { get; } #Ordered surface geometry and source mapping.
public IReadOnlyList<HtmlRenderSurface> OutputSurfaces { get; } #Ordered executable surface views for preview, drawing, geometry, and hit-test consumers.
public Double RequestedScale { get; } #Requested output scale before any bounded raster scale reduction.
public OfficeColor BackgroundColor { get; } #Requested output background used by image adapters.
public HtmlCapabilityCoverage Coverage { get; } #Qualification of the exact effective request axes.
public IReadOnlyList<String> DeclaredProviderIds { get; } #Provider identities declared by the compatibility manifests for this profile.
public IReadOnlyList<HtmlDiagnostic> Diagnostics { get; } #Structured diagnostics emitted by parsing, layout, and display-list construction.
public Boolean HasLoss { get; } #Whether the retained result contains an approximation, omission, or failure.
public IReadOnlyList<HtmlDiagnostic> LossDiagnostics { get; } #Diagnostics that report an approximation, omission, or failure.
Extension Methods
public static HtmlRenderArchiveResult ExportArchive(HtmlRenderResult result, HtmlRenderArchiveOptions archiveOptions = null, CancellationToken cancellationToken = default) #HtmlRenderArchiveResultEncodes the retained PNG or SVG surfaces and packages them with manifest.json under a bounded packaging deadline derived from the retained request options.
Parameters
- result OfficeIMO.Html.HtmlRenderResult
- archiveOptions OfficeIMO.Html.HtmlRenderArchiveOptions = null
- cancellationToken System.Threading.CancellationToken = default
public static OfficeImageExportResult ExportImage(HtmlRenderResult result, CancellationToken cancellationToken = default) #OfficeImageExportResultEncodes the only retained surface using the request's explicit image encoder.
Parameters
- result OfficeIMO.Html.HtmlRenderResult
- cancellationToken System.Threading.CancellationToken = default
public static IReadOnlyList<OfficeImageExportResult> ExportImages(HtmlRenderResult result, CancellationToken cancellationToken = default) #IReadOnlyList<OfficeImageExportResult>Encodes every retained surface using the request's explicit image encoder.
Parameters
- result OfficeIMO.Html.HtmlRenderResult
- cancellationToken System.Threading.CancellationToken = default