DocumentView

Description

sealed class Tinman.Engine.GUI.Components.DocumentView

Derived from

Component abstract

Renders a styled text document.

The following default Layout settings are defined for DocumentView objects:

Public / Constants

Class

public static readonly attribute Class → (StyleClass)

The style class for DocumentView.

Public / Constructors

Document​View

public constructor DocumentView → ()

Creates a new instance of DocumentView.

Public / Methods

Scroll​To​Anchor

public method ScrollToAnchor → (1)

anchorName in : string

The anchor name (see AnchorNode.Name).

returns → bool

true if the anchor is visible in the document view,
false if the anchor has not been found.

Scrolls to the given document anchor, if necessary.

Public / Attributes

Callback

public attribute Callback → (get,set)

value : IDocumentViewCallback

The callback object or null.

The callback to use.

When the callback is null, nothing will happen when links are clicked and images will be displayed using a placeholder, instead of the actual image content.

Document

public attribute Document → (get,set)

value : IDocumentNode

[not-null]
The text content.

The text content.