2.3.47 CT_Group

  • Article

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

Referenced by: CT_Tab

Specifies a grouping of controls within a ribbon tab.

Child Elements:

control: A CT_ControlClone element, as specified in section 2.3.36.

labelControl: A CT_LabelControl element, as specified in section 2.3.54.

button: A CT_Button element, as specified in section 2.3.24.

toggleButton: A CT_ToggleButton element, as specified in section 2.3.83.

checkBox: A CT_CheckBox element, as specified in section 2.3.27.

editBox: A CT_EditBox element, as specified in section 2.3.44.

comboBox: A CT_ComboBox element, as specified in section 2.3.28.

dropDown: A CT_DropDownRegular element, as specified in section 2.3.41.

gallery: A CT_Gallery element, as specified in section 2.3.45.

menu: A CT_Menu element, as specified in section 2.3.56.

dynamicMenu: A CT_DynamicMenu element, as specified in section 2.3.42.

splitButton: A CT_SplitButton element, as specified in section 2.3.69.

box: A CT_Box element.

buttonGroup: A CT_ButtonGroup element, as specified in section 2.3.25.

separator: A CT_Separator element, as specified in section 2.3.67.

dialogBoxLauncher: A CT_DialogLauncher element, as specified in section 2.3.40.

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.

idMso: An ST_ID attribute, as specified in section 2.4.17, 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.

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.

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.

insertAfterMso: An ST_ID attribute that specifies the identifier of a built-in control after which this control will be inserted. The insertAfterMso, insertAfterQ, insertBeforeMso, and insertBeforeQ attributes are mutually exclusive. They MUST NOT be used together. If none of these attributes is specified, the controls will be appended to the existing set of controls, in the order they are defined in the XML.

insertBeforeMso: An ST_ID attribute that specifies the identifier of a built-in control before which this control will be inserted. The insertAfterMso, insertAfterQ, insertBeforeMso, and insertBeforeQ attributes are mutually exclusive. They MUST NOT be used together. If none of these attributes is specified, the controls will be appended to the existing set of controls, in the order they are defined in the XML.

insertAfterQ: An ST_QID attribute, as specified in section 2.4.22, that specifies the qualified identifier of a control after which this control will be inserted. The insertAfterMso, insertAfterQ, insertBeforeMso, and insertBeforeQ attributes are mutually exclusive. They MUST NOT be used together. If none of these attributes is specified, the controls will be appended to the existing set of controls, in the order they are defined in the XML.

insertBeforeQ: An ST_QID attribute that specifies the qualified identifier of a control before which this control will be inserted. The insertAfterMso, insertAfterQ, insertBeforeMso, and insertBeforeQ attributes are mutually exclusive. They MUST NOT be used together. If none of these attributes is specified, the controls will be appended to the existing set of controls, in the order they are defined in the XML.

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.

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.

autoScale: A Boolean attribute that specifies whether the contents of this group control automatically resize as the size of the containing window changes. If this attribute is omitted, the contents of this group control will not automatically resize.

centerVertically: A Boolean attribute that specifies whether the contents of this group control are centered vertically within the container. If this attribute is omitted, the contents of this group control will be top-aligned rather than vertically centered.

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

 <xsd:complexType name="CT_Group">
   <xsd:sequence>
     <xsd:sequence>
       <xsd:choice minOccurs="0" maxOccurs="1000">
         <xsd:group ref="EG_Controls"/>
         <xsd:element name="separator" type="CT_Separator"/>
       </xsd:choice>
     </xsd:sequence>
     <xsd:element name="dialogBoxLauncher" type="CT_DialogLauncher" minOccurs="0" maxOccurs="1"/>
   </xsd:sequence>
   <xsd:attributeGroup ref="AG_IDAttributes"/>
   <xsd:attributeGroup ref="AG_Label"/>
   <xsd:attributeGroup ref="AG_Image"/>
   <xsd:attributeGroup ref="AG_PositionAttributes"/>
   <xsd:attributeGroup ref="AG_Screentip"/>
   <xsd:attributeGroup ref="AG_Visible"/>
   <xsd:attributeGroup ref="AG_Keytip"/>
   <xsd:attribute name="autoScale" type="xsd:boolean" use="optional"/>
   <xsd:attribute name="centerVertically" type="xsd:boolean" use="optional"/>
 </xsd:complexType>

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