2.3.52 CT_ImageControl

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

Referenced by: CT_GroupBox, CT_LayoutContainer, CT_GroupControls

Specifies a control that displays an image.

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.

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.

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.

altText: An ST_LongString attribute, as specified in section 2.4.21, that specifies a string that is displayed as the alternative text of this control. The altText and getAltText attributes are mutually exclusive. They MUST NOT be used together. If neither attribute is specified, alternative text is not displayed.

getAltText: 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 alternative text of this control. The altText and getAltText attributes are mutually exclusive. They MUST NOT be used together. If neither attribute is specified, alternative text is not displayed.

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

 <xsd:complexType name="CT_ImageControl">
   <xsd:attributeGroup ref="AG_IDCustom"/>
   <xsd:attributeGroup ref="AG_Enabled"/>
   <xsd:attributeGroup ref="AG_Visible"/>
   <xsd:attributeGroup ref="AG_Image"/>
   <xsd:attributeGroup ref="AG_AltText"/>
 </xsd:complexType>

See section 5.1 for the full W3C XML Schema ([XMLSCHEMA1/2] section 2.1).