API Reference
HtmlRenderRequest
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
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Method HtmlRenderRequest.Create
- Method HtmlRenderRequest.WithAxes
- Method HtmlRenderRequest.WithCssMedia
- Method HtmlRenderRequest.WithDocumentState
- Method HtmlRenderRequest.WithEncoder
- Method HtmlRenderRequest.WithLayout
- Method HtmlRenderRequest.WithLayoutSurface
- Method HtmlRenderRequest.WithOptions
- Method HtmlRenderRequest.WithPageSet
- Method HtmlRenderRequest.WithPagination
- Property HtmlRenderResult.Request
- Method HtmlSiteBundle.CreateRenderRequest
Accepted by parameters
- Extension method HtmlConversionDocument.RenderImages
- Extension method HtmlConversionDocument.RenderImagesAsync
- Method HtmlImageExportExtensions.RenderImages
- Method HtmlImageExportExtensions.RenderImagesAsync
- Method HtmlRenderEngine.Execute
- Method HtmlRenderEngine.ExecuteAsync
- Method HtmlSiteBundle.CreateRenderRequest
Methods
public static HtmlRenderRequest Create(HtmlRenderIntentProfile profile, HtmlRenderEncoder encoder = DisplayList, HtmlRenderOptions options = null, HtmlRenderDocumentState documentState = StaticSource) #HtmlRenderRequestCreates a request from one built-in profile and its declared defaults.
Parameters
- profile OfficeIMO.Html.HtmlRenderIntentProfile
- encoder OfficeIMO.Html.HtmlRenderEncoder = DisplayList
- options OfficeIMO.Html.HtmlRenderOptions = null
- documentState OfficeIMO.Html.HtmlRenderDocumentState = StaticSource
public HtmlRenderRequest WithAxes(HtmlCssMediaContext cssMedia, HtmlRenderLayoutSurface surface, HtmlRenderPaginationPolicy pagination) #HtmlRenderRequestReturns a copy changing CSS media, surface, and pagination atomically.
Parameters
- cssMedia OfficeIMO.Html.HtmlCssMediaContext
- surface OfficeIMO.Html.HtmlRenderLayoutSurface
- pagination OfficeIMO.Html.HtmlRenderPaginationPolicy
public HtmlRenderRequest WithCssMedia(HtmlCssMediaContext cssMedia) #HtmlRenderRequestReturns a copy selecting CSS media independently from layout geometry.
Parameters
- cssMedia OfficeIMO.Html.HtmlCssMediaContext
public HtmlRenderRequest WithDocumentState(HtmlRenderDocumentState state) #HtmlRenderRequestReturns a copy selecting another immutable document-state provenance.
Parameters
- state OfficeIMO.Html.HtmlRenderDocumentState
public HtmlRenderRequest WithEncoder(HtmlRenderEncoder encoder) #HtmlRenderRequestReturns a copy selecting another output encoder without changing layout intent.
Parameters
- encoder OfficeIMO.Html.HtmlRenderEncoder
public HtmlRenderRequest WithLayout(HtmlRenderLayoutSurface surface, HtmlRenderPaginationPolicy pagination) #HtmlRenderRequestReturns a copy changing the coupled surface and pagination geometry atomically.
Parameters
- surface OfficeIMO.Html.HtmlRenderLayoutSurface
- pagination OfficeIMO.Html.HtmlRenderPaginationPolicy
public HtmlRenderRequest WithLayoutSurface(HtmlRenderLayoutSurface surface) #HtmlRenderRequestReturns a copy selecting a layout surface independently from CSS media.
Parameters
- surface OfficeIMO.Html.HtmlRenderLayoutSurface
public HtmlRenderRequest WithOptions(HtmlRenderOptions options) #HtmlRenderRequestReturns a copy using a new independent options snapshot.
Parameters
- options OfficeIMO.Html.HtmlRenderOptions
public HtmlRenderRequest WithPageSet(HtmlRenderPageSet pageSet) #HtmlRenderRequestReturns a copy selecting another page-set behavior without rerouting layout intent.
Parameters
- pageSet OfficeIMO.Html.HtmlRenderPageSet
public HtmlRenderRequest WithPagination(HtmlRenderPaginationPolicy pagination) #HtmlRenderRequestReturns a copy selecting a pagination policy independently from CSS media.
Parameters
- pagination OfficeIMO.Html.HtmlRenderPaginationPolicy
Inherited Methods
Properties
public HtmlRenderIntentProfile Profile { get; } #Named versioned profile whose defaults created this request.
public String ProfileId { get; } #Stable versioned profile identifier.
public Boolean 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.