API Reference
HtmlRenderSurfaceResult
One output surface retained by a resolved HTML render request.
Inheritance
- Object
- HtmlRenderSurfaceResult
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 HtmlRenderResult.Surfaces
- Property HtmlRenderSurface.Descriptor
Methods
public Boolean TryMapToSource(HtmlRenderPoint outputPoint, out HtmlRenderSourcePoint sourcePoint) #BooleanMaps an output point to the contributing source page or canvas slice.
Parameters
- outputPoint OfficeIMO.Html.HtmlRenderPoint
- sourcePoint OfficeIMO.Html.HtmlRenderSourcePoint@
public Boolean TryMapToSource(Double outputX, Double outputY, out HtmlRenderSourcePoint sourcePoint) #BooleanMaps finite output coordinates to the contributing source page or canvas slice.
Parameters
- outputX System.Double
- outputY System.Double
- sourcePoint OfficeIMO.Html.HtmlRenderSourcePoint@
Inherited Methods
Properties
public Int32 OutputIndex { get; } #Zero-based position in the resolved output set.
public Int32 SourcePageNumber { get; } #One-based page number in the preselection render.
public Double Width { get; } #Surface width in CSS pixels.
public Double Height { get; } #Surface height in CSS pixels.
public Double SourceOffsetX { get; } #Horizontal offset into the original completed layout.
public Double SourceOffsetY { get; } #Vertical offset into the original completed layout.
public Boolean IsClipped { get; } #Whether this surface clips a viewport, page slice, or stitched source page.
public IReadOnlyList<HtmlRenderSourcePlacement> SourcePlacements { get; } #Every source page or slice contributing to this output surface.
public HtmlRenderRectangle Bounds { get; } #Complete output-surface rectangle.