2.3.7 CT_BackstageEditBox

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

Referenced by: CT_GroupControls, CT_GroupBox, CT_LayoutContainer

Specifies a Backstage edit box 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.

alignLabel: An ST_alignLabel attribute, as specified in section 2.4.2, that specifies how the label of this control is aligned relative to the control. If this attribute is omitted, the label defaults to the top left alignment.

expand: An ST_expand attribute, as specified in section 2.4.13, that specifies how this control expands within its container. If this attribute is omitted, the control does not expand.

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.

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.

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.

getText: 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 text in this control. If this attribute is omitted, the control defaults to being empty.

onChange: An ST_Delegate attribute that specifies the name of a callback function that is called when the text in this control changes.

maxLength: An ST_StringLength attribute, as specified in section 2.4.25, that specifies the maximum length, in characters, of strings allowed in this control. If this attribute is omitted, the length of the input string is limited only by application-specific constraints.

sizeString: An ST_String attribute, as specified in section 2.4.24, that specifies a string for which the length is used to determine the size of the text input area of this control. If this attribute is omitted, the size of the control is determined by the application.

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

 <xsd:complexType name="CT_BackstageEditBox">
   <xsd:attributeGroup ref="AG_IDCustom"/>
   <xsd:attributeGroup ref="AG_AlignAttributes"/>
   <xsd:attributeGroup ref="AG_Expand"/>
   <xsd:attributeGroup ref="AG_Enabled"/>
   <xsd:attributeGroup ref="AG_Label"/>
   <xsd:attributeGroup ref="AG_Visible"/>
   <xsd:attributeGroup ref="AG_Keytip"/>
   <xsd:attribute name="getText" type="ST_Delegate" use="optional"/>
   <xsd:attribute name="onChange" type="ST_Delegate" use="optional"/>
   <xsd:attribute name="maxLength" type="ST_StringLength" use="optional"/>
   <xsd:attribute name="sizeString" type="ST_String" use="optional"/>
 </xsd:complexType>

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