Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, PowerShell module, CLI, Studio and browser tools 609 stars

Talk and help

DiscordQuestions, ideas and show and tell Report an issueBugs and feature requests SponsorFund ongoing development

Mode

Background

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Search the whole siteOpen search page →
Documentation Search all OfficeIMO/

API Reference

Class

HtmlRenderEngine

Edit on GitHub
Namespace OfficeIMO.Html
Assembly OfficeIMO.Html
Source revision c8404474f9f2 with working tree changes
Source HtmlRenderEngine.cs:21
Modifiers static

First-party browser-free HTML layout entry point shared by image and PDF adapters.

Inheritance

  • Object
  • HtmlRenderEngine

Methods

public static HtmlRenderResult Execute(HtmlConversionDocument document, HtmlRenderRequest request, CancellationToken cancellationToken = default) #
HtmlRenderEngine.cs:40
Returns: HtmlRenderResult

Resolves an explicit render request into a backend-neutral display list. The intended output adapter cannot change the request's CSS, layout, pagination, or page-set axes.

Parameters

document OfficeIMO.Html.HtmlConversionDocument requiredposition: 0
request OfficeIMO.Html.HtmlRenderRequest requiredposition: 1
cancellationToken System.Threading.CancellationToken = default optionalposition: 2
public static async Task<HtmlRenderResult> ExecuteAsync(HtmlConversionDocument document, HtmlRenderRequest request, CancellationToken cancellationToken = default) #
Returns: Task<HtmlRenderResult>

Asynchronously resolves resources and prepares an explicit render request as one retained backend-neutral result.

Parameters

document OfficeIMO.Html.HtmlConversionDocument requiredposition: 0
request OfficeIMO.Html.HtmlRenderRequest requiredposition: 1
cancellationToken System.Threading.CancellationToken = default optionalposition: 2
public static HtmlRenderDocument Render(HtmlConversionDocument document, HtmlRenderOptions? options = null) #
HtmlRenderEngine.cs:21
Returns: HtmlRenderDocument

Renders a parsed HTML source into a backend-neutral continuous or paged visual document.

Parameters

document OfficeIMO.Html.HtmlConversionDocument requiredposition: 0
options OfficeIMO.Html.HtmlRenderOptions? = null optionalposition: 1
public static async Task<HtmlRenderDocument> RenderAsync(HtmlConversionDocument document, HtmlRenderOptions? options = null, CancellationToken cancellationToken = default) #
Returns: Task<HtmlRenderDocument>

Renders a parsed HTML source while asynchronously resolving policy-approved external resources through the configured resolver.

Parameters

document OfficeIMO.Html.HtmlConversionDocument requiredposition: 0
options OfficeIMO.Html.HtmlRenderOptions? = null optionalposition: 1
cancellationToken System.Threading.CancellationToken = default optionalposition: 2