HtmlRenderSurface
OfficeIMO.Html
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.
Returned or exposed by 3
- Property HtmlRenderHitTestResult.Surface
- Method HtmlRenderResult.GetSurface
- Property HtmlRenderResult.OutputSurfaces
Methods
public OfficeDrawing CreateDrawing() #Creates a detached Drawing preview of this surface.
Returns
OfficeDrawingpublic OfficeDrawing CreateDrawing(CancellationToken cancellationToken) #Creates a detached Drawing preview with cooperative cancellation.
Parameters
- cancellationToken System.Threading.CancellationToken
Returns
OfficeDrawingpublic 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
- options OfficeIMO.Html.HtmlRenderHitTestOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
HtmlRenderHitTestReportpublic 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
- y double
- options OfficeIMO.Html.HtmlRenderHitTestOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
HtmlRenderHitTestReportpublic HtmlRenderHitTestResult? HitTestTopmost(HtmlRenderPoint point, HtmlRenderHitTestOptions? options = null, CancellationToken cancellationToken = default) #Returns the topmost matching visual, or null.
Parameters
- point OfficeIMO.Html.HtmlRenderPoint
- options OfficeIMO.Html.HtmlRenderHitTestOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
HtmlRenderHitTestResult?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
- sourcePoint OfficeIMO.Html.HtmlRenderSourcePoint?
Returns
boolpublic bool TryMapToSource(double x, double y, out HtmlRenderSourcePoint? sourcePoint) #Maps finite output coordinates to the source page or source-canvas slice.
Parameters
- x double
- y double
- sourcePoint OfficeIMO.Html.HtmlRenderSourcePoint?
Returns
boolInherited Methods
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.