Hyperlink Class

Represents a document hyperlink.

Definition

Namespace: OpenDiscoverSDK.Interfaces.Content
Assembly: OpenDiscoverSDK.Interfaces (in OpenDiscoverSDK.Interfaces.dll) Version: 2026.2.6.0 (2026.02.06)
C#
[DataContractAttribute]
public class Hyperlink
Inheritance
Object    Hyperlink

Remarks

At this time, document hyperlinks are only supported for HTML, Microsoft Office Word, PowerPoint, and Excel 2007 and higher, and Open Document formats.

For the supported formats other than HTML dodcuments, only external document hyperlinks are extracted, i.e., hyperlinks that link to other parts of the document are not extracted. For HTML documents all hyperlinks that have at least one supported hyperlink attribute set to a non-empty value are extracted.

Constructors

HyperlinkInitializes a new instance of the Hyperlink class

Properties

Download The download attribute specifies that the target will be downloaded when a user clicks on the hyperlink and this attribute value is the name of the downloaded file.
IsExternalLink

If the document is an HTML document, then value is only true if hyperlink is a "link" HTML element and specifies a link between the document and an external resource, and false if hyperlink is an "a" HTML element.

For all other non-HTML file formats this specifies if hyperlink is an external document link.

Ping Typically used for monitoring/tracking - specifies a list of URLs to be notified if the user follows the hyperlink.
RefLang Specifies the language of the linked document.
Relationship The 'rel' attribute specifies the relationship between the current document and the linked document.
Target The target attribute specifies where to open the linked document.
Text Hyperlink inner text.
Type The type attribute specifies the internet media type (formerly known as MIME type) of the linked document (e.g., "text/html").
Url Specifies the URL ("href" attribute) of the page the link goes to.

Methods

EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
ToStringReturns a string that represents the current object.
(Inherited from Object)

See Also