2.3.51 CT_Hyperlink

Target namespace: http://schemas.microsoft.com/office/2009/07/customui

Referenced by: CT_GroupControls, CT_GroupBox, CT_LayoutContainer

Specifies a hyperlink control.

Attributes:

id: An ST_UniqueID attribute, as specified in section 2.4.27, that specifies the identifier of a custom control. All custom controls MUST have unique identifiers. 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, as specified in section 2.4.22, 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.

tag: An ST_String attribute, as specified in section 2.4.24, that specifies an arbitrary string that 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, as specified in section 2.4.2, 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, as specified in section 2.4.13, that specifies how this control expands within its container. If this attribute is omitted, the control does not expand.

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 that 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 attribute is specified, the control defaults to being visible.

getVisible: An ST_Delegate attribute that specifies the name of a callback function that 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 attribute is specified, the control defaults to being visible.

keytip: An ST_Keytip attribute, as specified in section 2.4.19, that specifies a string that is displayed as the KeyTip for this control. The keytip and getKeytip attributes are mutually exclusive. They MUST NOT be used together. If neither attribute is specified, a KeyTip is not displayed.

getKeytip: An ST_Delegate attribute that specifies the name of a callback function that 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 attribute is specified, a KeyTip is not displayed.

label: An ST_String attribute that specifies a string that 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, a label is not displayed.

getLabel: An ST_Delegate attribute that specifies the name of a callback function that 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, a label is not displayed.

onAction: An ST_Delegate attribute, as specified in section 2.4.12, that specifies the name of a callback function that is called when this control is invoked by the user.

image: An ST_Uri attribute, as specified in section 2.4.28, that specifies the relationship identifier of an image file that 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, an icon is not displayed.

imageMso: An ST_ID attribute, as specified in section 2.4.17, that specifies the identifier of a built-in image that 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, an icon is not displayed.

getImage: An ST_Delegate attribute, as specified in section 2.4.12, that specifies the name of a callback function that 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, an icon is not displayed.

screentip: An ST_String attribute, as specified in section 2.4.24, that specifies a string that is displayed as the tooltip for this control. The screentip and getScreentip attributes are mutually exclusive. They MUST NOT be used together. If neither attribute is specified, a tooltip is not displayed.

getScreentip: An ST_Delegate attribute that specifies the name of a callback function that is called to determine the tooltip of this control. The screentip and getScreentip attributes are mutually exclusive. They MUST NOT be used together. If neither attribute is specified, a tooltip is not displayed.

supertip: An ST_String attribute that specifies a string that is displayed as the Enhanced ScreenTip of this control. The supertip and getSupertip attributes are mutually exclusive. They MUST NOT be used together. If neither attribute is specified, an Enhanced ScreenTip is not displayed.

getSupertip: An ST_Delegate attribute that specifies the name of a callback function that is called to determine the Enhanced ScreenTip of this control. The supertip and getSupertip attributes are mutually exclusive. They MUST NOT be used together. If neither attribute is specified, an Enhanced ScreenTip is not displayed.

target: An ST_String attribute, as specified in section 2.4.24, 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 is specified, the hyperlink control does not perform any action when invoked.

getTarget: An ST_Delegate attribute, as specified in section 2.4.12, that specifies the name of a callback function that 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 is specified, the hyperlink control does not perform any action when invoked.

The following W3C XML Schema ([XMLSCHEMA1/2] section 2.1) fragment specifies the contents of this complex type.

 <xsd:complexType name="CT_Hyperlink">
   <xsd:attributeGroup ref="AG_IDCustom"/>
   <xsd:attributeGroup ref="AG_AlignAttributes"/>
   <xsd:attributeGroup ref="AG_Expand"/>
   <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:attributeGroup ref="AG_Screentip"/>
   <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/2] section 2.1).