API Reference
HtmlRenderSurface
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
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Property HtmlRenderHitTestResult.Surface
- Method HtmlRenderResult.GetSurface
- Property HtmlRenderResult.OutputSurfaces
Methods
public OfficeDrawing CreateDrawing() #OfficeDrawingCreates a detached Drawing preview of this surface.
public OfficeDrawing CreateDrawing(CancellationToken cancellationToken) #OfficeDrawingCreates a detached Drawing preview with cooperative cancellation.
Parameters
- cancellationToken System.Threading.CancellationToken
public HtmlRenderHitTestReport HitTest(HtmlRenderPoint point, HtmlRenderHitTestOptions options = null, CancellationToken cancellationToken = default) #HtmlRenderHitTestReportRuns 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
public HtmlRenderHitTestReport HitTest(Double x, Double y, HtmlRenderHitTestOptions options = null, CancellationToken cancellationToken = default) #HtmlRenderHitTestReportRuns a bounded, topmost-first hit test at finite surface coordinates.
Parameters
- x System.Double
- y System.Double
- options OfficeIMO.Html.HtmlRenderHitTestOptions = null
- cancellationToken System.Threading.CancellationToken = default
public HtmlRenderHitTestResult HitTestTopmost(HtmlRenderPoint point, HtmlRenderHitTestOptions options = null, CancellationToken cancellationToken = default) #HtmlRenderHitTestResultReturns the topmost matching visual, or null.
Parameters
- point OfficeIMO.Html.HtmlRenderPoint
- options OfficeIMO.Html.HtmlRenderHitTestOptions = null
- cancellationToken System.Threading.CancellationToken = default
public Boolean TryMapToSource(HtmlRenderPoint outputPoint, out HtmlRenderSourcePoint sourcePoint) #BooleanMaps an output point to the source page or source-canvas slice.
Parameters
- outputPoint OfficeIMO.Html.HtmlRenderPoint
- sourcePoint OfficeIMO.Html.HtmlRenderSourcePoint@
public Boolean TryMapToSource(Double x, Double y, out HtmlRenderSourcePoint sourcePoint) #BooleanMaps finite output coordinates to the source page or source-canvas slice.
Parameters
- x System.Double
- y System.Double
- sourcePoint OfficeIMO.Html.HtmlRenderSourcePoint@
Inherited Methods
Properties
public Int32 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.