Class ReportRegionMap

Namespace

DocWright.Reporting.Viewer

Assembly

DocWright.Reporting.Viewer.dll

Everything a viewer needs to bind behaviour to an ReportHtmlProjection: every item's rectangle and element id, what clicking it does, which textbox is a toggle or offers a sort, where each text run's characters are in its textbox's value, and the report's bookmarks and document map.

public sealed class ReportRegionMap

Inheritance

object

ReportRegionMap

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

The map exists so a viewer never has to read the markup back. Scraping the HTML for positions couples a product's behaviour to this package's element names and makes every change to the markup a breaking change; reading the same facts from data does not. Everything here is also derivable from ReportPageModel — the map is the projection's view of it, with the element ids the markup actually used.

ToJson() writes it as JSON, deterministically: the same page model produces the same bytes on every run, on every runtime and under every culture.

Properties

Bookmarks

Gets the report's bookmarks, as Bookmarks gives them.

DocumentMap

Gets the report's document map, as DocumentMap gives it.

Language

Gets the report's language, or null when the definition stated none.

Pages

Gets the pages, in the order the projection wrote them.

Methods

ToJson()

Returns the map as JSON.