ImageControl Class

Defines the ImageControl Class.This class is only available in Office2010.When the object is serialized out as xml, its qualified name is mso14:imageControl.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlLeafElement
      DocumentFormat.OpenXml.Office2010.CustomUI.ImageControl

Namespace:  DocumentFormat.OpenXml.Office2010.CustomUI
Assembly:  DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)

Syntax

'Declaration
<OfficeAvailabilityAttribute(FileFormatVersions.Office2010)> _
Public Class ImageControl _
    Inherits OpenXmlLeafElement
'Usage
Dim instance As ImageControl
[OfficeAvailabilityAttribute(FileFormatVersions.Office2010)]
public class ImageControl : OpenXmlLeafElement

Remarks

2.3.68 CT_ImageControl

Target namespace: https://schemas.microsoft.com/office/2007/10/customui

Referenced by: CT_GroupBox, CT_LayoutContainer, CT_Form

Specifies a control which displays an image.

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.

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.

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.

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

<xsd:complexType name="CT_ImageControl">

<xsd:attributeGroup ref="AG_IDAttributes"/>

<xsd:attributeGroup ref="AG_Enabled"/>

<xsd:attributeGroup ref="AG_Visible"/>

<xsd:attributeGroup ref="AG_Image"/>

</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.

See Also

Reference

ImageControl Members

DocumentFormat.OpenXml.Office2010.CustomUI Namespace