Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

HtmlRenderRequest

OfficeIMO.Html

Namespace
OfficeIMO.Html
Assembly
OfficeIMO.Html
Source revision
3b680b1b6fb1 with working tree changes
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

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.

Accepted by parameters 3

Methods

public static HtmlRenderRequest Create(HtmlRenderIntentProfile profile, HtmlRenderEncoder encoder = DisplayList, HtmlRenderOptions? options = null, HtmlRenderDocumentState documentState = StaticSource) #

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
public HtmlRenderRequest WithAxes(HtmlCssMediaContext cssMedia, HtmlRenderLayoutSurface surface, HtmlRenderPaginationPolicy pagination) #

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
public HtmlRenderRequest WithCssMedia(HtmlCssMediaContext cssMedia) #

Returns a copy selecting CSS media independently from layout geometry.

Parameters

cssMedia OfficeIMO.Html.HtmlCssMediaContext required
public HtmlRenderRequest WithDocumentState(HtmlRenderDocumentState state) #

Returns a copy selecting another immutable document-state provenance.

Parameters

state OfficeIMO.Html.HtmlRenderDocumentState required
public HtmlRenderRequest WithEncoder(HtmlRenderEncoder encoder) #

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

Parameters

encoder OfficeIMO.Html.HtmlRenderEncoder required
public HtmlRenderRequest WithLayout(HtmlRenderLayoutSurface surface, HtmlRenderPaginationPolicy pagination) #

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

Parameters

surface OfficeIMO.Html.HtmlRenderLayoutSurface required
pagination OfficeIMO.Html.HtmlRenderPaginationPolicy required
public HtmlRenderRequest WithLayoutSurface(HtmlRenderLayoutSurface surface) #

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

Parameters

surface OfficeIMO.Html.HtmlRenderLayoutSurface required
public HtmlRenderRequest WithOptions(HtmlRenderOptions options) #

Returns a copy using a new independent options snapshot.

Parameters

options OfficeIMO.Html.HtmlRenderOptions required
public HtmlRenderRequest WithPageSet(HtmlRenderPageSet pageSet) #

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

Parameters

pageSet OfficeIMO.Html.HtmlRenderPageSet required
public HtmlRenderRequest WithPagination(HtmlRenderPaginationPolicy pagination) #

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

Parameters

pagination OfficeIMO.Html.HtmlRenderPaginationPolicy required

Properties

public HtmlRenderIntentProfile Profile { get; } #

Named versioned profile whose defaults created this request.

public string ProfileId { get; } #

Stable versioned profile identifier.

public bool MatchesNamedProfile { get; } #

Whether the effective axes still exactly match the named profile.

public HtmlCapabilityCoverage Coverage { get; } #

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

public HtmlRenderDocumentState DocumentState { get; } #

Provenance of the immutable document supplied to the operation.

public HtmlCssMediaContext CssMedia { get; } #

CSS media type, independent from pagination and output format.

public HtmlRenderLayoutSurface Surface { get; } #

Geometry model used to contain the layout.

public HtmlRenderPaginationPolicy Pagination { get; } #

How the layout becomes one or more surfaces.

public HtmlRenderEncoder Encoder { get; } #

Output adapter intended to consume the retained result.

public HtmlRenderPageSet PageSet { get; } #

Explicit page selection and composition policy.

public HtmlRenderOptions Options { get; } #

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