API Reference

Class

HtmlRenderOptions

Namespace OfficeIMO.Html
Assembly OfficeIMO.Html
Base OfficeImageExportOptions

Shared layout and safety options used by HTML image and PDF rendering.

Inheritance

  • OfficeImageExportOptions
  • HtmlRenderOptions

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

Accepted by parameters

Constructors

public HtmlRenderOptions() #

Creates the default continuous render configuration.

Methods

public virtual HtmlRenderOptions Clone() #
Returns: HtmlRenderOptions

Creates an independent options snapshot.

Properties

public HtmlRenderMode Mode { get; set; } #

Continuous or paged layout mode.

public Double ViewportWidth { get; set; } #

Viewport width for continuous rendering, in CSS pixels.

public Nullable<Double> ViewportHeight { get; set; } #

Optional minimum continuous-surface height, in CSS pixels.

public OfficePageSize PageSize { get; set; } #

Physical page size used by paged rendering.

public Boolean HonorCssPageRules { get; set; } #

When true, generic print @page size and margin declarations override the paged defaults.

public HtmlRenderMargins Margins { get; set; } #

Page or continuous-surface margins measured in CSS pixels.

public String DefaultFontFamily { get; set; } #

Default font family used when CSS does not select one.

public Double DefaultFontSize { get; set; } #

Default CSS font size in pixels.

public Double DefaultLineHeight { get; set; } #

Default line-height multiplier.

public Uri BaseUri { get; set; } #

Optional base URI used to resolve links and resource references.

public HtmlUrlPolicy UrlPolicy { get; set; } #

URL policy applied before links or resources enter the rendered result.

public HtmlUrlPolicy ResourceUrlPolicy { get; set; } #

Optional separate policy for images, stylesheets, fonts, and other render resources. When omitted, UrlPolicy is used. This lets package or application resolvers authorize a resource origin without authorizing the same scheme for emitted hyperlinks.

public HtmlRenderResourceResolver ResourceResolver { get; set; } #

Optional application-supplied asynchronous resolver for policy-approved external resources.

public TimeSpan ResourceTimeout { get; set; } #

Maximum time allowed for one resolver invocation.

public Int32 MaxConcurrentResourceLoads { get; set; } #

Maximum asynchronous resolver invocations allowed to run concurrently.

public Int64 MaxResourceBytes { get; set; } #

Maximum bytes accepted from one resolved resource.

public Int64 MaxTotalResourceBytes { get; set; } #

Maximum total bytes accepted from external resources in one render operation.

public Int32 MaxResourceCount { get; set; } #

Maximum number of external resources accepted in one render operation.

public Int32 MaxResourceRequests { get; set; } #

Maximum resolver invocations attempted in one render operation, including misses and failures.

public Int32 MaxStylesheetImportDepth { get; set; } #

Maximum recursive @import depth accepted for external stylesheets.

public Int32 MaxSurfaceWidth { get; set; } #

Maximum width of any generated image surface in output pixels.

public Int32 MaxSurfaceHeight { get; set; } #

Maximum height of any generated image surface in output pixels.

public Int32 MaxPageCount { get; set; } #

Maximum page count accepted from one paged render operation.

public Int32 MaxLayoutDepth { get; set; } #

Maximum element nesting depth processed by the layout engine.

public Int32 MaxInputCharacters { get; set; } #

Maximum UTF-16 characters accepted in the source HTML string. The default leaves enough room for the default total resource budget when resources are embedded as base64 data URIs.

public Int32 MaxHtmlNodes { get; set; } #

Maximum DOM nodes accepted after parsing and before style or layout work begins.

public Int32 MaxBackgroundImageTiles { get; set; } #

Maximum total repeated background-image tiles accepted in one render operation.

public Int32 MaxBackgroundImageLayers { get; set; } #

Maximum background-image layers accepted on one element.

public Int32 MaxBoxShadowLayers { get; set; } #

Maximum CSS box-shadow layers accepted on one element.

public Int32 MaxGradientStops { get; set; } #

Maximum color stops accepted in one CSS gradient.

public Int32 MaxGridTracks { get; set; } #

Maximum explicit or implicit tracks accepted on either grid axis.

public Int32 MaxColumnCount { get; set; } #

Maximum generated columns accepted in one multi-column formatting context.

public HtmlCssMediaContext MediaContext { get; } #

Gets the CSS media context selected by the current render mode.

public Double PageWidth { get; } #

Gets the paged surface width in CSS pixels.

public Double PageHeight { get; } #

Gets the paged surface height in CSS pixels.

Fields

public const Double CssPixelsPerInch #

CSS reference pixel density used for physical page conversion.

Value: 96