Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

HtmlRenderSurface

OfficeIMO.Html

Namespace
OfficeIMO.Html
Assembly
OfficeIMO.Html
Source revision
3b680b1b6fb1 with working tree changes
Modifiers
sealed

Immutable executable view over one retained HTML output surface. Preview, geometry, automation, and encoder consumers share this view and its source mapping.

Inheritance

  • object
  • HtmlRenderSurface

Usage

Explore 3 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.

Methods

CreateDrawing 2 overloads
public OfficeDrawing CreateDrawing() #

Creates a detached Drawing preview of this surface.

Returns

OfficeDrawing
public OfficeDrawing CreateDrawing(CancellationToken cancellationToken) #

Creates a detached Drawing preview with cooperative cancellation.

Parameters

cancellationToken System.Threading.CancellationToken required

Returns

OfficeDrawing
HitTest 2 overloads
public HtmlRenderHitTestReport HitTest(HtmlRenderPoint point, HtmlRenderHitTestOptions? options = null, CancellationToken cancellationToken = default) #

Runs a bounded, topmost-first hit test against the retained scene.

Parameters

point OfficeIMO.Html.HtmlRenderPoint required
options OfficeIMO.Html.HtmlRenderHitTestOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional
public HtmlRenderHitTestReport HitTest(double x, double y, HtmlRenderHitTestOptions? options = null, CancellationToken cancellationToken = default) #

Runs a bounded, topmost-first hit test at finite surface coordinates.

Parameters

x double required
y double required
options OfficeIMO.Html.HtmlRenderHitTestOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional
public HtmlRenderHitTestResult? HitTestTopmost(HtmlRenderPoint point, HtmlRenderHitTestOptions? options = null, CancellationToken cancellationToken = default) #

Returns the topmost matching visual, or null.

Parameters

point OfficeIMO.Html.HtmlRenderPoint required
options OfficeIMO.Html.HtmlRenderHitTestOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional
TryMapToSource 2 overloads
public bool TryMapToSource(HtmlRenderPoint outputPoint, out HtmlRenderSourcePoint? sourcePoint) #

Maps an output point to the source page or source-canvas slice.

Parameters

outputPoint OfficeIMO.Html.HtmlRenderPoint required
sourcePoint OfficeIMO.Html.HtmlRenderSourcePoint? required

Returns

bool
public bool TryMapToSource(double x, double y, out HtmlRenderSourcePoint? sourcePoint) #

Maps finite output coordinates to the source page or source-canvas slice.

Parameters

x double required
y double required
sourcePoint OfficeIMO.Html.HtmlRenderSourcePoint? required

Returns

bool

Properties

public int OutputIndex { get; } #

Zero-based position in the resolved output set.

public HtmlRenderPage Page { get; } #

Retained backend-neutral page and display list.

public HtmlRenderSurfaceResult Descriptor { get; } #

Output geometry, clipping, and source-placement descriptor.

public HtmlRenderRectangle Bounds { get; } #

Complete output-surface rectangle.

public double RequestedScale { get; } #

Requested output scale before bounded encoder reduction.

public OfficeColor BackgroundColor { get; } #

Requested preview and image background.