Hyperlink Class

Hyperlink.When the object is serialized out as xml, its qualified name is x:hyperlink.

Inheritance Hierarchy

Namespace: DocumentFormat.OpenXml.Spreadsheet
Assembly: DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)

'Declaration
Public Class Hyperlink _
    Inherits OpenXmlLeafElement
'Usage
Dim instance As Hyperlink

public class Hyperlink : OpenXmlLeafElement

[ISO/IEC 29500-1 1st Edition]

18.3.1.47 hyperlink (Hyperlink)

A single hyperlink

Parent Elements
hyperlinks (§18.3.1.48)

Attributes	Description
display (Display String)	Display string, if different from string in string table. This is a property on the hyperlink object, but does not need to appear in the spreadsheet application UI. The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).
id (Relationship Id) Namespace: .../officeDocument/2006/relationships	Relationship Id in this sheet's relationships part, expressing the target location of the resource. The possible values for this attribute are defined by the ST_RelationshipId simple type (§22.8.2.1).
location (Location)	Location within target. If target is a workbook (or this workbook) this shall refer to a sheet and cell or a defined name. Can also be an HTML anchor if target is HTML file. The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).
ref (Reference)	Cell location of hyperlink on worksheet. The possible values for this attribute are defined by the ST_Ref simple type (§18.18.62).
tooltip (Tool Tip)	This is additional text to help the user understand more about the hyperlink. [Example: This can be displayed as hover text when the mouse is over the link. end example] The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).

[Note: The W3C XML Schema definition of this element’s content model (CT_Hyperlink) is located in §A.2. end note]

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.