2.3.23 CT_Box
Target namespace: http://schemas.microsoft.com/office/2009/07/customui
Referenced by: CT_Group
Specifies a grouping container control that aligns child controls horizontally or vertically.
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.
buttonGroup: A CT_ButtonGroup element, as specified in section 2.3.25.
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.
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.
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.
boxStyle: An ST_BoxStyle attribute, as specified in section 2.4.3, that specifies the alignment direction of the child controls. If this attribute is omitted, the child controls are laid out horizontally.
The following W3C XML Schema ([XMLSCHEMA1/2] section 2.1) fragment specifies the contents of this complex type.
-
<xsd:complexType name="CT_Box"> <xsd:group ref="EG_Controls" minOccurs="0" maxOccurs="1000"/> <xsd:attributeGroup ref="AG_IDCustom"/> <xsd:attributeGroup ref="AG_Visible"/> <xsd:attributeGroup ref="AG_PositionAttributes"/> <xsd:attribute name="boxStyle" type="ST_BoxStyle" use="optional"/> </xsd:complexType>
See section 5.1 for the full W3C XML Schema ([XMLSCHEMA1/2] section 2.1).