Hyperlink Class
Defines the Hyperlink Class.This class is only available in Office2010.When the object is serialized out as xml, its qualified name is mso14:hyperlink.
Inheritance Hierarchy
System.Object
DocumentFormat.OpenXml.OpenXmlElement
DocumentFormat.OpenXml.OpenXmlLeafElement
DocumentFormat.OpenXml.Office2010.CustomUI.Hyperlink
Namespace: DocumentFormat.OpenXml.Office2010.CustomUI
Assembly: DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)
Syntax
'Declaration
<OfficeAvailabilityAttribute(FileFormatVersions.Office2010)> _
Public Class Hyperlink _
Inherits OpenXmlLeafElement
'Usage
Dim instance As Hyperlink
[OfficeAvailabilityAttribute(FileFormatVersions.Office2010)]
public class Hyperlink : OpenXmlLeafElement
Remarks
2.3.61 CT_Hyperlink
Target namespace: https://schemas.microsoft.com/office/2007/10/customui
Referenced by: CT_Form, CT_GroupBox, CT_LayoutContainer
Specifies a hyperlink control.
Attributes:
id : An ST_UniqueID attribute that specifies the identifier of a custom control. All custom controls MUST have unique IDs. The id, idQ and idMso attributes are mutually exclusive. Exactly one of these attributes MUST be specified on all controls.
idQ : An ST_QID attribute that specifies the qualified identifier of a control. This attribute is used to reference controls or containers created by other Custom UI documents. The id, idQ and idMso attributes are mutually exclusive. Exactly one of these attributes MUST be specified on all controls.
idMso : An ST_ID attribute that specifies the identifier of a built-in control. The id, idQ and idMso attributes are mutually exclusive. Exactly one of these attributes MUST be specified.
tag : An ST_String attribute that specifies an arbitrary string which provides additional information about this control during callback function calls. If this attribute is omitted, the value defaults to an empty string.
alignLabel : An ST_AlignLabel attribute that specifies how the label of this control is aligned relative to the control. If this attribute is omitted, the label defaults to the top left alignment.
expand : An ST_Expand attribute that specifies how this control expands within its container. If this attribute is omitted, the control does not expand.
layout : An ST_Layout attribute that specifies how the child controls of this control are laid out. If this attribute is omitted, the child controls are laid out horizontally.
enabled : A boolean attribute that specifies the enabled state of this control. The enabled and getEnabled attributes are mutually exclusive. They MUST NOT be used together. If neither attribute is specified, the control defaults to being enabled.
getEnabled : An ST_Delegate attribute that specifies the name of a callback function which is called to determine the enabled state of this control. The enabled and getEnabled attributes are mutually exclusive. They MUST NOT be used together. If neither attribute is specified, the control defaults to being enabled.
visible : A boolean attribute that specifies the visibility state of this control. The visible and getVisible attributes are mutually exclusive. They MUST NOT be used together. If neither of these attributes are specified, then the control defaults to being visible.
getVisible : An ST_Delegate attribute that specifies the name of a callback function which is called to determine the visibility state of this control. The visible and getVisible attributes are mutually exclusive. They MUST NOT be used together. If neither of these attributes are specified, the control defaults to being visible.
keytip : An ST_Keytip attribute that specifies a string which is displayed as the KeyTip for this control. The keytip and getKeytip attributes are mutually exclusive. They MUST NOT be used together. If neither of these attributes are specified, a KeyTip is not displayed.
getKeytip : An ST_Delegate attribute that specifies the name of a callback function which is called to determine the KeyTip for this control. The keytip and getKeytip attributes are mutually exclusive. They MUST NOT be used together. If neither of these attributes are specified, a KeyTip is not displayed.
label : An ST_String attribute that specifies a string which is displayed as the label of this control. The label and getLabel attributes are mutually exclusive. They MUST NOT be used together. If neither attribute is specified, then a label is not displayed.
getLabel : An ST_Delegate attribute that specifies the name of a callback function which is called to determine the label of this control. The label and getLabel attributes are mutually exclusive. They MUST NOT be used together. If neither attribute is specified, then a label is not displayed.
onAction : An ST_Delegate attribute that specifies the name of a callback function which is called when this control is invoked by the user.
image : An ST_Uri attribute that specifies the relationship identifier of an image file which is used as the icon for this control. The image, getImage and imageMso attributes are mutually exclusive. They MUST NOT be used together. If none of these attributes are specified, then an icon is not displayed.
imageMso : An ST_ID attribute that specifies the identifier of a built-in image which is used as the icon for this control. The image, getImage and imageMso attributes are mutually exclusive. They MUST NOT be used together. If none of these attributes are specified, then an icon is not displayed.
getImage : An ST_Delegate attribute that specifies the name of a callback function which is called to determine the icon of this control. The image, getImage and imageMso attributes are mutually exclusive. They MUST NOT be used together. If none of these attributes are specified, then an icon is not displayed.
target : An ST_String attribute that specifies the URL for this hyperlink control. The target, getTarget, and onAction attributes are mutually exclusive. They MUST NOT be used together. If none of these attributes are specified, the hyperlink control does not perform any action when invoked.
getTarget : An ST_Delegate attribute that specifies the name of a callback function which is called to determine the target URL for this hyperlink control. The target, getTarget, and onAction attributes are mutually exclusive. They MUST NOT be used together. If none of these attributes are specified, the hyperlink control does not perform any action when invoked.
The following W3C XML Schema ([XMLSCHEMA1] section 2.1) fragment specifies the contents of this complex type.
<xsd:complexType name="CT_Hyperlink">
<xsd:attributeGroup ref="AG_IDAttributes"/>
<xsd:attributeGroup ref="AG_AlignAttributes"/>
<xsd:attributeGroup ref="AG_LayoutAttributes"/>
<xsd:attributeGroup ref="AG_Enabled"/>
<xsd:attributeGroup ref="AG_Visible"/>
<xsd:attributeGroup ref="AG_Keytip"/>
<xsd:attributeGroup ref="AG_Label"/>
<xsd:attributeGroup ref="AG_Action"/>
<xsd:attributeGroup ref="AG_Image"/>
<xsd:attribute name="target" type="ST_String" use="optional"/>
<xsd:attribute name="getTarget" type="ST_Delegate" use="optional"/>
</xsd:complexType>
See section 5.1 for the full W3C XML Schema ([XMLSCHEMA1] section 2.1).
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.