Group Class
Defines the Group Class.This class is only available in Office2010.When the object is serialized out as xml, its qualified name is mso14:group.
Inheritance Hierarchy
System.Object
DocumentFormat.OpenXml.OpenXmlElement
DocumentFormat.OpenXml.OpenXmlCompositeElement
DocumentFormat.OpenXml.Office2010.CustomUI.Group
Namespace: DocumentFormat.OpenXml.Office2010.CustomUI
Assembly: DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)
Syntax
'Declaration
<ChildElementInfoAttribute(GetType(ComboBox), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(DropDownRegular), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(Gallery), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(Menu), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(DynamicMenu), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(SplitButton), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(Box), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(ButtonGroup), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(Separator), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(DialogBoxLauncher), FileFormatVersions.Office2010)> _
<OfficeAvailabilityAttribute(FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(LabelControl), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(Button), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(ToggleButton), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(CheckBox), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(EditBox), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(ControlClone), FileFormatVersions.Office2010)> _
Public Class Group _
Inherits OpenXmlCompositeElement
'Usage
Dim instance As Group
[ChildElementInfoAttribute(typeof(ComboBox), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(DropDownRegular), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(Gallery), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(Menu), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(DynamicMenu), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(SplitButton), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(Box), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(ButtonGroup), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(Separator), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(DialogBoxLauncher), FileFormatVersions.Office2010)]
[OfficeAvailabilityAttribute(FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(LabelControl), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(Button), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(ToggleButton), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(CheckBox), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(EditBox), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(ControlClone), FileFormatVersions.Office2010)]
public class Group : OpenXmlCompositeElement
Remarks
The following table lists the possible child types:
ControlClone <mso14:control>
LabelControl <mso14:labelControl>
Button <mso14:button>
ToggleButton <mso14:toggleButton>
CheckBox <mso14:checkBox>
EditBox <mso14:editBox>
ComboBox <mso14:comboBox>
DropDownRegular <mso14:dropDown>
Gallery <mso14:gallery>
Menu <mso14:menu>
DynamicMenu <mso14:dynamicMenu>
SplitButton <mso14:splitButton>
Box <mso14:box>
ButtonGroup <mso14:buttonGroup>
Separator <mso14:separator>
DialogBoxLauncher <mso14:dialogBoxLauncher>
2.3.37 CT_Group
Target namespace: https://schemas.microsoft.com/office/2007/10/customui
Referenced by: CT_Tab
Specifies a grouping of controls within a Ribbon tab.
Child Elements:
control : A CT_ControlClone element.
labelControl : A CT_LabelControl element.
button : A CT_Button element.
toggleButton : A CT_ToggleButton element.
checkBox : A CT_CheckBox element.
editBox : A CT_EditBox element.
comboBox : A CT_ComboBox element.
dropDown : A CT_DropDownRegular element.
gallery : A CT_Gallery element.
menu : A CT_Menu element.
dynamicMenu : A CT_DynamicMenu element.
splitButton : A CT_SplitButton element.
box : A CT_Box element.
buttonGroup : A CT_ButtonGroup element.
separator : A CT_Separator element.
dialogBoxLauncher : A CT_DialogLauncher element.
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.
label : An ST_String attribute that specifies a string which 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, then a label is not displayed.
getLabel : An ST_Delegate attribute that specifies the name of a callback function which 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, then a label is not displayed.
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.
insertAfterMso : An ST_ID attribute that specifies the identifier of a built-in control which this control will be inserted after. The insertAfterMso, insertAfterQ, insertBeforeMso and insertBeforeQ attributes are mutually exclusive. They MUST NOT be used together. If none of these attributes are 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 which this control will be inserted before. The insertAfterMso, insertAfterQ, insertBeforeMso and insertBeforeQ attributes are mutually exclusive. They MUST NOT be used together. If none of these attributes are 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 that specifies the qualified identifier of a control which this control will be inserted after. The insertAfterMso, insertAfterQ, insertBeforeMso and insertBeforeQ attributes are mutually exclusive. They MUST NOT be used together. If none of these attributes are 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 which this control will be inserted before. The insertAfterMso, insertAfterQ, insertBeforeMso and insertBeforeQ attributes are mutually exclusive. They MUST NOT be used together. If none of these attributes are 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 that specifies a string which 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 then a tooltip is not displayed.
getScreentip : An ST_Delegate attribute that specifies the name of a callback function which 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 then a tooltip is not displayed.
supertip : An ST_String attribute that specifies a string which 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 then a Enhanced ScreenTip is not displayed.
getSupertip : An ST_Delegate attribute that specifies the name of a callback function which 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 then 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 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.
keytip : An ST_Keytip attribute that specifies a string which is displayed as the KeyTip for this control. The keytip and getKeytip attributes are mutually exclusive. They MUST NOT be used together. If neither of these attributes are specified, a KeyTip is not displayed.
getKeytip : An ST_Delegate attribute that specifies the name of a callback function which 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 of these attributes are 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] 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] 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.