GroupBox Class

Defines the GroupBox Class.This class is only available in Office2010.When the object is serialized out as xml, its qualified name is mso14:groupBox.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlCompositeElement
      DocumentFormat.OpenXml.Office2010.CustomUI.GroupBox

Namespace:  DocumentFormat.OpenXml.Office2010.CustomUI
Assembly:  DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)

Syntax

'Declaration
<ChildElementInfoAttribute(GetType(BackstageEditBox), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(RadioGroup), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(BackstageComboBox), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(Hyperlink), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(BackstageLabelControl), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(GroupBox), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(LayoutContainer), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(ImageControl), FileFormatVersions.Office2010)> _
<OfficeAvailabilityAttribute(FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(BackstageDropDown), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(BackstageGroupButton), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(BackstageCheckBox), FileFormatVersions.Office2010)> _
Public Class GroupBox _
    Inherits OpenXmlCompositeElement
'Usage
Dim instance As GroupBox
[ChildElementInfoAttribute(typeof(BackstageEditBox), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(RadioGroup), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(BackstageComboBox), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(Hyperlink), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(BackstageLabelControl), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(GroupBox), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(LayoutContainer), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(ImageControl), FileFormatVersions.Office2010)]
[OfficeAvailabilityAttribute(FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(BackstageDropDown), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(BackstageGroupButton), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(BackstageCheckBox), FileFormatVersions.Office2010)]
public class GroupBox : OpenXmlCompositeElement

Remarks

The following table lists the possible child types:

  • BackstageGroupButton <mso14:button>

  • BackstageCheckBox <mso14:checkBox>

  • BackstageEditBox <mso14:editBox>

  • BackstageDropDown <mso14:dropDown>

  • RadioGroup <mso14:radioGroup>

  • BackstageComboBox <mso14:comboBox>

  • Hyperlink <mso14:hyperlink>

  • BackstageLabelControl <mso14:labelControl>

  • GroupBox <mso14:groupBox>

  • LayoutContainer <mso14:layoutContainer>

  • ImageControl <mso14:imageControl>

2.3.77 CT_GroupBox

Target namespace: https://schemas.microsoft.com/office/2007/10/customui

Referenced by: CT_Form, CT_GroupBox, CT_LayoutContainer

Specifies a grouping container which visually groups child controls together

Child Elements:

button : A CT_OutSpaceSlabButton element.

checkBox : A CT_OutSpaceCheckBox element.

editBox : A CT_OutSpaceEditBox element.

dropDown : A CT_OutSpaceDropDown element.

radioGroup : A CT_RadioGroup element.

comboBox : A CT_OutSpaceComboBox element.

hyperlink : A CT_Hyperlink element.

labelControl : A CT_OutSpaceLabelControl element.

groupBox : A CT_GroupBox element.

layoutContainer : A CT_LayoutContainer element.

imageControl : A CT_ImageControl 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.

expand : An ST_Expand attribute that specifies how this control expands within its container. If this attribute is omitted, the control does not expand.

layout : An ST_Layout attribute that specifies how the child controls of this control are laid out. If this attribute is omitted, the child controls are laid out horizontally.

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.

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

<xsd:complexType name="CT_GroupBox">

<xsd:sequence>

<xsd:group ref="EG_FormControls" minOccurs="0" maxOccurs="1000"/>

</xsd:sequence>

<xsd:attributeGroup ref="AG_IDAttributes"/>

<xsd:attributeGroup ref="AG_LayoutAttributes"/>

<xsd:attributeGroup ref="AG_Label"/>

</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.

See Also

Reference

GroupBox Members

DocumentFormat.OpenXml.Office2010.CustomUI Namespace