2.3.72 CT_SplitButtonRestricted

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

Referenced by: CT_SplitButtonRegular, CT_SplitButtonWithTitle

Abstract base type that restricts several attributes from being specified on split button controls. The restricted attributes are instead provided by the primary button within the split button 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.

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.

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.

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.

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.

showLabel: A Boolean attribute that specifies whether the label for this control will be displayed. The showLabel and getShowLabel attributes are mutually exclusive. They MUST NOT be used together. If neither attribute is specified, the label of the control will be displayed.

getShowLabel: An ST_Delegate attribute that specifies the name of a callback function that is called to determine whether to display the label of this control. The showLabel and getShowLabel attributes are mutually exclusive. They MUST NOT be used together. If neither attribute is specified, the label of the control will be displayed.

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

 <xsd:complexType name="CT_SplitButtonRestricted">
   <xsd:complexContent>
     <xsd:restriction base="CT_SplitButtonBase">
       <xsd:attribute name="label" use="prohibited"/>
       <xsd:attribute name="getLabel" use="prohibited"/>
       <xsd:attribute name="screentip" use="prohibited"/>
       <xsd:attribute name="getScreentip" use="prohibited"/>
       <xsd:attribute name="supertip" use="prohibited"/>
       <xsd:attribute name="getSupertip" use="prohibited"/>
       <xsd:attribute name="image" use="prohibited"/>
       <xsd:attribute name="imageMso" use="prohibited"/>
       <xsd:attribute name="getImage" use="prohibited"/>
       <xsd:attribute name="showImage" use="prohibited"/>
       <xsd:attribute name="getShowImage" use="prohibited"/>
     </xsd:restriction>
   </xsd:complexContent>
 </xsd:complexType>

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