Represents a doclink in a rich text item.

Note This class is new with Release 6.5.

Containment

Contained by: RichTextItem, RichTextNavigator

Contains: RichTextStyle

Properties

DBReplicaID through getDBReplicaID and setDBReplicaID

DisplayComment through getDisplayComment and setDisplayComment

DocUnID through getDocUnID and setDocUnID

HotSpotText through getHotSpotText and setHotSpotText

HotSpotTextStyle through getHotSpotTextStyle

ServerHint through getServerHint and setServerHint

ViewUnID through getViewUnID and setViewUnID

Methods

recycle

remove

setHotSpotTextStyle

Access

To access a RichTextDoclink object, use the RichTextNavigator methods in conjunction with the type RTELEM_TYPE_DOCLINK.

Usage

Hotspot text representing a doclink can be retrieved by navigating to the doclink, enclosing it in a RichTextRange, and retrieving the associated text with TextRun. If the doclink is not a hotspot, no text is present.

Example
See Also

Working with doclinks in Java classes

Glossary