# HtmlRenderRequest

Immutable rendering intent.

Class 

`OfficeIMO.Html`

**Namespace**

`OfficeIMO.Html`

**Assembly**

`OfficeIMO.Html`

**Source revision**

`3b680b1b6fb1` with working tree changes

**Source**

[HtmlRenderRequest.cs:66](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderRequest.cs#L66)

**Modifiers**

sealed

Immutable rendering intent. It keeps document provenance, CSS media, layout surface, pagination, page selection, and output encoder independent from one another.

## Inheritance

- object
- HtmlRenderRequest

## Guides & Samples

Authored walkthroughs and practical samples linked to this API.

- [Read MHTML Web Archives and Site Bundles](/docs/html/mhtml-and-site-bundles/) Guide
  
  Open MHTML web archives or zipped websites, read their HTML and resources, create new archives, and convert them to PDF or images offline.

## Usage

Explore 15 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 12

- Method [HtmlRenderRequest.Create](/api/html/officeimo-html-htmlrenderrequest/#method-create-officeimo-html-htmlrenderintentprofile-officeimo-html-htmlrenderencoder-officeimo-html-htmlrenderoptions-officeimo-html-htmlrenderdocumentstate)
- Method [HtmlRenderRequest.WithAxes](/api/html/officeimo-html-htmlrenderrequest/#method-withaxes-officeimo-html-htmlcssmediacontext-officeimo-html-htmlrenderlayoutsurface-officeimo-html-htmlrenderpaginationpolicy)
- Method [HtmlRenderRequest.WithCssMedia](/api/html/officeimo-html-htmlrenderrequest/#method-withcssmedia-officeimo-html-htmlcssmediacontext)
- Method [HtmlRenderRequest.WithDocumentState](/api/html/officeimo-html-htmlrenderrequest/#method-withdocumentstate-officeimo-html-htmlrenderdocumentstate)
- Method [HtmlRenderRequest.WithEncoder](/api/html/officeimo-html-htmlrenderrequest/#method-withencoder-officeimo-html-htmlrenderencoder)
- Method [HtmlRenderRequest.WithLayout](/api/html/officeimo-html-htmlrenderrequest/#method-withlayout-officeimo-html-htmlrenderlayoutsurface-officeimo-html-htmlrenderpaginationpolicy)
- Method [HtmlRenderRequest.WithLayoutSurface](/api/html/officeimo-html-htmlrenderrequest/#method-withlayoutsurface-officeimo-html-htmlrenderlayoutsurface)
- Method [HtmlRenderRequest.WithOptions](/api/html/officeimo-html-htmlrenderrequest/#method-withoptions-officeimo-html-htmlrenderoptions)
- Method [HtmlRenderRequest.WithPageSet](/api/html/officeimo-html-htmlrenderrequest/#method-withpageset-officeimo-html-htmlrenderpageset)
- Method [HtmlRenderRequest.WithPagination](/api/html/officeimo-html-htmlrenderrequest/#method-withpagination-officeimo-html-htmlrenderpaginationpolicy)
- Property [HtmlRenderResult.Request](/api/html/officeimo-html-htmlrenderresult/#property-request)
- Method [HtmlSiteBundle.CreateRenderRequest](/api/html/officeimo-html-htmlsitebundle/#method-createrenderrequest-officeimo-html-htmlrenderrequest)

### Accepted by parameters 3

- Method [HtmlRenderEngine.Execute](/api/html/officeimo-html-htmlrenderengine/#method-execute-officeimo-html-htmlconversiondocument-officeimo-html-htmlrenderrequest-threading-cancellationtoken) parameter `request`
- Method [HtmlRenderEngine.ExecuteAsync](/api/html/officeimo-html-htmlrenderengine/#method-executeasync-officeimo-html-htmlconversiondocument-officeimo-html-htmlrenderrequest-threading-cancellationtoken) parameter `request`
- Method [HtmlSiteBundle.CreateRenderRequest](/api/html/officeimo-html-htmlsitebundle/#method-createrenderrequest-officeimo-html-htmlrenderrequest) parameter `request`

Filter members 

Show inherited

## Methods

`public static HtmlRenderRequest Create(HtmlRenderIntentProfile profile, HtmlRenderEncoder encoder = DisplayList, HtmlRenderOptions? options = null, HtmlRenderDocumentState documentState = StaticSource)` [#](#method-create-officeimo-html-htmlrenderintentprofile-officeimo-html-htmlrenderencoder-officeimo-html-htmlrenderoptions-officeimo-html-htmlrenderdocumentstate)

[HtmlRenderRequest.cs:66](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderRequest.cs#L66)

Creates a request from one built-in profile and its declared defaults.

Parameters

**profile OfficeIMO.Html.HtmlRenderIntentProfile required**

**encoder OfficeIMO.Html.HtmlRenderEncoder = DisplayList optional**

**options OfficeIMO.Html.HtmlRenderOptions? = null optional**

**documentState OfficeIMO.Html.HtmlRenderDocumentState = StaticSource optional**

Returns

`HtmlRenderRequest`

`public HtmlRenderRequest WithAxes(HtmlCssMediaContext cssMedia, HtmlRenderLayoutSurface surface, HtmlRenderPaginationPolicy pagination)` [#](#method-withaxes-officeimo-html-htmlcssmediacontext-officeimo-html-htmlrenderlayoutsurface-officeimo-html-htmlrenderpaginationpolicy)

[HtmlRenderRequest.cs:99](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderRequest.cs#L99)

Returns a copy changing CSS media, surface, and pagination atomically.

Parameters

**cssMedia OfficeIMO.Html.HtmlCssMediaContext required**

**surface OfficeIMO.Html.HtmlRenderLayoutSurface required**

**pagination OfficeIMO.Html.HtmlRenderPaginationPolicy required**

Returns

`HtmlRenderRequest`

`public HtmlRenderRequest WithCssMedia(HtmlCssMediaContext cssMedia)` [#](#method-withcssmedia-officeimo-html-htmlcssmediacontext)

[HtmlRenderRequest.cs:78](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderRequest.cs#L78)

Returns a copy selecting CSS media independently from layout geometry.

Parameters

**cssMedia OfficeIMO.Html.HtmlCssMediaContext required**

Returns

`HtmlRenderRequest`

`public HtmlRenderRequest WithDocumentState(HtmlRenderDocumentState state)` [#](#method-withdocumentstate-officeimo-html-htmlrenderdocumentstate)

[HtmlRenderRequest.cs:74](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderRequest.cs#L74)

Returns a copy selecting another immutable document-state provenance.

Parameters

**state OfficeIMO.Html.HtmlRenderDocumentState required**

Returns

`HtmlRenderRequest`

`public HtmlRenderRequest WithEncoder(HtmlRenderEncoder encoder)` [#](#method-withencoder-officeimo-html-htmlrenderencoder)

[HtmlRenderRequest.cs:103](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderRequest.cs#L103)

Returns a copy selecting another output encoder without changing layout intent.

Parameters

**encoder OfficeIMO.Html.HtmlRenderEncoder required**

Returns

`HtmlRenderRequest`

`public HtmlRenderRequest WithLayout(HtmlRenderLayoutSurface surface, HtmlRenderPaginationPolicy pagination)` [#](#method-withlayout-officeimo-html-htmlrenderlayoutsurface-officeimo-html-htmlrenderpaginationpolicy)

[HtmlRenderRequest.cs:92](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderRequest.cs#L92)

Returns a copy changing the coupled surface and pagination geometry atomically.

Parameters

**surface OfficeIMO.Html.HtmlRenderLayoutSurface required**

**pagination OfficeIMO.Html.HtmlRenderPaginationPolicy required**

Returns

`HtmlRenderRequest`

`public HtmlRenderRequest WithLayoutSurface(HtmlRenderLayoutSurface surface)` [#](#method-withlayoutsurface-officeimo-html-htmlrenderlayoutsurface)

[HtmlRenderRequest.cs:82](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderRequest.cs#L82)

Returns a copy selecting a layout surface independently from CSS media.

Parameters

**surface OfficeIMO.Html.HtmlRenderLayoutSurface required**

Returns

`HtmlRenderRequest`

`public HtmlRenderRequest WithOptions(HtmlRenderOptions options)` [#](#method-withoptions-officeimo-html-htmlrenderoptions)

[HtmlRenderRequest.cs:111](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderRequest.cs#L111)

Returns a copy using a new independent options snapshot.

Parameters

**options OfficeIMO.Html.HtmlRenderOptions required**

Returns

`HtmlRenderRequest`

`public HtmlRenderRequest WithPageSet(HtmlRenderPageSet pageSet)` [#](#method-withpageset-officeimo-html-htmlrenderpageset)

[HtmlRenderRequest.cs:107](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderRequest.cs#L107)

Returns a copy selecting another page-set behavior without rerouting layout intent.

Parameters

**pageSet OfficeIMO.Html.HtmlRenderPageSet required**

Returns

`HtmlRenderRequest`

`public HtmlRenderRequest WithPagination(HtmlRenderPaginationPolicy pagination)` [#](#method-withpagination-officeimo-html-htmlrenderpaginationpolicy)

[HtmlRenderRequest.cs:86](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderRequest.cs#L86)

Returns a copy selecting a pagination policy independently from CSS media.

Parameters

**pagination OfficeIMO.Html.HtmlRenderPaginationPolicy required**

Returns

`HtmlRenderRequest`

## 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 HtmlRenderIntentProfile Profile { get; }` [#](#property-profile)

[HtmlRenderRequest.cs:31](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderRequest.cs#L31)

Named versioned profile whose defaults created this request.

`public string ProfileId { get; }` [#](#property-profileid)

[HtmlRenderRequest.cs:33](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderRequest.cs#L33)

Stable versioned profile identifier.

`public bool MatchesNamedProfile { get; }` [#](#property-matchesnamedprofile)

[HtmlRenderRequest.cs:37](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderRequest.cs#L37)

Whether the effective axes still exactly match the named profile.

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

[HtmlRenderRequest.cs:42](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderRequest.cs#L42)

Qualification of the effective axis combination. Custom combinations are unqualified.

`public HtmlRenderDocumentState DocumentState { get; }` [#](#property-documentstate)

[HtmlRenderRequest.cs:46](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderRequest.cs#L46)

Provenance of the immutable document supplied to the operation.

`public HtmlCssMediaContext CssMedia { get; }` [#](#property-cssmedia)

[HtmlRenderRequest.cs:48](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderRequest.cs#L48)

CSS media type, independent from pagination and output format.

`public HtmlRenderLayoutSurface Surface { get; }` [#](#property-surface)

[HtmlRenderRequest.cs:50](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderRequest.cs#L50)

Geometry model used to contain the layout.

`public HtmlRenderPaginationPolicy Pagination { get; }` [#](#property-pagination)

[HtmlRenderRequest.cs:52](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderRequest.cs#L52)

How the layout becomes one or more surfaces.

`public HtmlRenderEncoder Encoder { get; }` [#](#property-encoder)

[HtmlRenderRequest.cs:54](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderRequest.cs#L54)

Output adapter intended to consume the retained result.

`public HtmlRenderPageSet PageSet { get; }` [#](#property-pageset)

[HtmlRenderRequest.cs:56](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderRequest.cs#L56)

Explicit page selection and composition policy.

`public HtmlRenderOptions Options { get; }` [#](#property-options)

[HtmlRenderRequest.cs:58](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderRequest.cs#L58)

Independent rendering, resource, font, safety, and encoder settings snapshot.

<!-- PowerForge markdown artifact sha256:270558380575CD1B473242AF80C166EAC7CC4D1C14BBC2CEA5589D007F064AEF -->
