# HtmlRenderResult

A resolved request and its retained backend-neutral scene.

Class 

`OfficeIMO.Html`

**Namespace**

`OfficeIMO.Html`

**Assembly**

`OfficeIMO.Html`

**Source revision**

`3b680b1b6fb1` with working tree changes

**Source**

[HtmlRenderResult.cs:166](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderResult.cs#L166)

**Modifiers**

sealed

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

Explore 3 API references to this type

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

### Returned or exposed by 3

- Method [HtmlRenderEngine.Execute](/api/html/officeimo-html-htmlrenderengine/#method-execute-officeimo-html-htmlconversiondocument-officeimo-html-htmlrenderrequest-threading-cancellationtoken)
- Method [HtmlRenderEngine.ExecuteAsync](/api/html/officeimo-html-htmlrenderengine/#method-executeasync-officeimo-html-htmlconversiondocument-officeimo-html-htmlrenderrequest-threading-cancellationtoken)
- Method [HtmlRenderResult.WithAdditionalDiagnostics](/api/html/officeimo-html-htmlrenderresult/#method-withadditionaldiagnostics-collections-generic-ienumerable-officeimo-html-htmldiagnostic)

Filter members 

Show inherited

## Methods

`public HtmlRenderSurface GetSurface(int outputIndex)` [#](#method-getsurface-int32)

[HtmlRenderResult.cs:166](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderResult.cs#L166)

Gets one executable output surface by zero-based index.

Parameters

**outputIndex int required**

Returns

`HtmlRenderSurface`

`public void ThrowIfLoss()` [#](#method-throwifloss)

[HtmlRenderResult.cs:181](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderResult.cs#L181)

Throws with the complete report when the retained result is not lossless.

`public HtmlRenderResult WithAdditionalDiagnostics(IEnumerable<HtmlDiagnostic> diagnostics)` [#](#method-withadditionaldiagnostics-collections-generic-ienumerable-officeimo-html-htmldiagnostic)

[HtmlRenderResult.cs:176](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderResult.cs#L176)

Returns 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> required**

Returns

`HtmlRenderResult`

## Inherited Methods

`public virtual bool Equals(object? obj)` [#](#method-equals-object)

Inherited from object

Parameters

**obj object? required**

Returns

`bool`

`public virtual int GetHashCode()` [#](#method-gethashcode)

Inherited from object

Returns

`int`

`public Type GetType()` [#](#method-gettype)

Inherited from object

Returns

`Type`

`public virtual string? ToString()` [#](#method-tostring)

Inherited from object

Returns

`string?`

## Properties

`public HtmlRenderRequest Request { get; }` [#](#property-request)

[HtmlRenderResult.cs:141](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderResult.cs#L141)

Independent immutable request snapshot used for this operation.

`public HtmlRenderDocument Document { get; }` [#](#property-document)

[HtmlRenderResult.cs:144](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderResult.cs#L144)

Selected, sliced, or stitched backend-neutral display list.

`public IReadOnlyList<HtmlRenderSurfaceResult> Surfaces { get; }` [#](#property-surfaces)

[HtmlRenderResult.cs:146](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderResult.cs#L146)

Ordered surface geometry and source mapping.

`public IReadOnlyList<HtmlRenderSurface> OutputSurfaces { get; }` [#](#property-outputsurfaces)

[HtmlRenderResult.cs:148](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderResult.cs#L148)

Ordered executable surface views for preview, drawing, geometry, and hit-test consumers.

`public double RequestedScale { get; }` [#](#property-requestedscale)

[HtmlRenderResult.cs:150](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderResult.cs#L150)

Requested output scale before any bounded raster scale reduction.

`public OfficeColor BackgroundColor { get; }` [#](#property-backgroundcolor)

[HtmlRenderResult.cs:152](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderResult.cs#L152)

Requested output background used by image adapters.

`public HtmlCapabilityCoverage Coverage { get; }` [#](#property-coverage)

[HtmlRenderResult.cs:154](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderResult.cs#L154)

Qualification of the exact effective request axes.

`public IReadOnlyList<string> DeclaredProviderIds { get; }` [#](#property-declaredproviderids)

[HtmlRenderResult.cs:156](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderResult.cs#L156)

Provider identities declared by the compatibility manifests for this profile.

`public IReadOnlyList<HtmlDiagnostic> Diagnostics { get; }` [#](#property-diagnostics)

[HtmlRenderResult.cs:158](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderResult.cs#L158)

Structured diagnostics emitted by parsing, layout, and display-list construction.

`public bool HasLoss { get; }` [#](#property-hasloss)

[HtmlRenderResult.cs:160](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderResult.cs#L160)

Whether the retained result contains an approximation, omission, or failure.

`public IReadOnlyList<HtmlDiagnostic> LossDiagnostics { get; }` [#](#property-lossdiagnostics)

[HtmlRenderResult.cs:162](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderResult.cs#L162)

Diagnostics that report an approximation, omission, or failure.

<!-- PowerForge markdown artifact sha256:389DFFAC9F70C8478A240AAECC4D3DA8A812F02189C0B905DE9A090A138C0F62 -->
