Click or drag to resize

Hyperlink Class

Represents an Inline that can be used to create a link to an external resource or to a Bookmark inside a document.
Inheritance Hierarchy

Namespace:  GemBox.Document
Assembly:  GemBox.Document (in GemBox.Document.dll) Version:
public sealed class Hyperlink : Inline, 

The Hyperlink type exposes the following members.

Public propertyAddress
Gets or sets the hyperlink address.
Public propertyContent
Gets the content of the current Element.
(Inherited from Element.)
Public propertyDisplayInlines
Gets the hyperlink display Inlines.
Public propertyDocument
Gets the owner document.
(Inherited from Element.)
Public propertyElementType
Gets the ElementType of this Element instance.
(Overrides ElementElementType.)
Public propertyIsBookmarkLink
Gets or sets a value indicating whether this Hyperlink instance is bookmark link.
Public propertyParent
Gets the parent of this Element instance.
(Inherited from Element.)
Public propertyParentCollection
Gets the InlineCollection that contains this Inline instance.
(Inherited from Inline.)
Public propertyScreenTip
Gets or sets the screen tip.
Public propertyTargetFrame
Gets or sets the target frame.
Public methodClone
Clones this Hyperlink instance, and optionally clones it's display elements.
Public methodStatic memberCreateHyperlinkStyledRun
Creates the hyperlink-styled Run.
Public methodGetChildElements(Boolean)
Gets the child elements.
(Inherited from Element.)
Public methodGetChildElements(Boolean, ElementType)
Gets the child elements filtered by ElementType.
(Inherited from Element.)
Explicit Interface Implementations

Hyperlink is an Inline element. For more information about GemBox.Document Content Model, see content model.

Hyperlink can contain any other Inline element except Hyperlink in its Hyperlink.DisplayInlines content property.

For an example how to create a Hyperlink to a Bookmark, see Bookmarks and Hyperlinks example.

Hyperlinks exported to XPS file format do not provide navigational capabilities.

See Also