Click or drag to resize

Hyperlink Class

Represents a document hyperlink.
Inheritance Hierarchy
SystemObject
  OpenDiscoverSDK.Interfaces.ContentHyperlink

Namespace: OpenDiscoverSDK.Interfaces.Content
Assembly: OpenDiscoverSDK.Interfaces (in OpenDiscoverSDK.Interfaces.dll) Version: 2025.4.4.0 (2025.4.4)
Syntax
C#
Copy
[DataContractAttribute]
public class Hyperlink

The Hyperlink type exposes the following members.

Constructors
 NameDescription
Public methodHyperlinkInitializes a new instance of the Hyperlink class
Top
Properties
 NameDescription
Public propertyDownload 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.
Public propertyIsExternalLink

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.

Public propertyPing Typically used for monitoring/tracking - specifies a list of URLs to be notified if the user follows the hyperlink.
Public propertyRefLang Specifies the language of the linked document.
Public propertyRelationship The 'rel' attribute specifies the relationship between the current document and the linked document.
Public propertyTarget The target attribute specifies where to open the linked document.
Public propertyText Hyperlink inner text.
Public propertyType The type attribute specifies the internet media type (formerly known as MIME type) of the linked document (e.g., "text/html").
Public propertyUrl Specifies the URL ("href" attribute) of the page the link goes to.
Top
Methods
 NameDescription
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
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.

See Also