RadioGroup Class

Definition

Namespace:

DocumentFormat.OpenXml.Office2010.CustomUI

Assembly:

DocumentFormat.OpenXml.dll

Package:

DocumentFormat.OpenXml v3.0.1

Defines the RadioGroup Class.

This class is available in Office 2010 and above.

When the object is serialized out as xml, it's qualified name is mso14:radioGroup.

public class RadioGroup : DocumentFormat.OpenXml.OpenXmlCompositeElement

type RadioGroup = class
    inherit OpenXmlCompositeElement

Public Class RadioGroup
Inherits OpenXmlCompositeElement

Inheritance

Object

OpenXmlElement

OpenXmlCompositeElement

RadioGroup

Remarks

2.3.63 CT_RadioGroup

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

Referenced by: CT_GroupControls, CT_GroupBox, CT_LayoutContainer

Specifies a group of radio buttons.

Child Elements:

radioButton: A CT_BackstageItem element, as specified in section 2.3.12.

Attributes:

id: An ST_UniqueID attribute, as specified in section 2.4.22, 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.17, 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.19, 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.8, 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.

onAction: An ST_Delegate attribute, as specified in section 2.4.7, that specifies the name of a callback function that is called when this control is invoked by the user.

keytip: An ST_Keytip attribute, as specified in section 2.4.14, 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.

getSelectedItemIndex: An ST_Delegate attribute, as specified in section 2.4.7, that specifies the name of a callback function that is called to determine which radio button is selected, identified by index. If this attribute is omitted, the first radio button is selected by default.

getItemCount: An ST_Delegate attribute that specifies the name of a callback function that is called to determine the number of radio buttons in this group. If this attribute is omitted, the control displays the radio buttons which are specified as child elements. If this attribute is omitted and no child elements are specified, the radio group is empty. If both this attribute and child elements are specified, the child elements are ignored.

getItemLabel: An ST_Delegate attribute that specifies the name of a callback function that is called to determine the label of a radio button, identified by index. If this attribute is omitted, dynamically created radio buttons will not display labels.

getItemID: An ST_Delegate attribute that specifies the name of a callback function that is called to determine the identifier of a radio button, identified by index. If this attribute is omitted, dynamically created radio buttons will have blank identifiers.

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

<xsd:complexType name="CT_RadioGroup">

<xsd:sequence>

<xsd:element name="radioButton" type="CT_BackstageItem" minOccurs="0" maxOccurs="1000"/>

</xsd:sequence>

<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_Action"/>

<xsd:attributeGroup ref="AG_Keytip"/>

<xsd:attribute name="getSelectedItemIndex" type="ST_Delegate" use="optional"/>

<xsd:attribute name="getItemCount" type="ST_Delegate" use="optional"/>

<xsd:attribute name="getItemLabel" type="ST_Delegate" use="optional"/>

<xsd:attribute name="getItemID" type="ST_Delegate" use="optional"/>

</xsd:complexType>

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

Constructors

RadioGroup()	Initializes a new instance of the RadioGroup class.
RadioGroup(IEnumerable<OpenXmlElement>)	Initializes a new instance of the RadioGroup class with the specified child elements.
RadioGroup(OpenXmlElement[])	Initializes a new instance of the RadioGroup class with the specified child elements.
RadioGroup(String)	Initializes a new instance of the RadioGroup class from outer XML.

Properties

AlignLabel	alignLabel, this property is only available in Office 2010 and later. Represents the following attribute in the schema: alignLabel
ChildElements	Gets all the child nodes of the current element. (Inherited from OpenXmlElement)
Enabled	enabled, this property is only available in Office 2010 and later. Represents the following attribute in the schema: enabled
Expand	expand, this property is only available in Office 2010 and later. Represents the following attribute in the schema: expand
ExtendedAttributes	Gets all extended attributes (attributes not defined in the schema) of the current element. (Inherited from OpenXmlElement)
Features	Gets a IFeatureCollection for the current element. This feature collection will be read-only, but will inherit features from its parent part and package if available. (Inherited from OpenXmlElement)
FirstChild	Gets the first child of the current OpenXmlElement element. (Inherited from OpenXmlCompositeElement)
GetEnabled	getEnabled, this property is only available in Office 2010 and later. Represents the following attribute in the schema: getEnabled
GetItemCount	getItemCount, this property is only available in Office 2010 and later. Represents the following attribute in the schema: getItemCount
GetItemID	getItemID, this property is only available in Office 2010 and later. Represents the following attribute in the schema: getItemID
GetItemLabel	getItemLabel, this property is only available in Office 2010 and later. Represents the following attribute in the schema: getItemLabel
GetKeytip	getKeytip, this property is only available in Office 2010 and later. Represents the following attribute in the schema: getKeytip
GetLabel	getLabel, this property is only available in Office 2010 and later. Represents the following attribute in the schema: getLabel
GetSelectedItemIndex	getSelectedItemIndex, this property is only available in Office 2010 and later. Represents the following attribute in the schema: getSelectedItemIndex
GetVisible	getVisible, this property is only available in Office 2010 and later. Represents the following attribute in the schema: getVisible
HasAttributes	Gets a value indicating whether the current element has any attributes. (Inherited from OpenXmlElement)
HasChildren	Gets a value that indicates whether the current element has any child elements. (Inherited from OpenXmlCompositeElement)
Id	id, this property is only available in Office 2010 and later. Represents the following attribute in the schema: id
InnerText	Gets or sets the concatenated values of the current node and all of its children. (Inherited from OpenXmlCompositeElement)
InnerXml	Gets or sets the markup that represents only the child nodes of the current node. (Inherited from OpenXmlCompositeElement)
Keytip	keytip, this property is only available in Office 2010 and later. Represents the following attribute in the schema: keytip
Label	label, this property is only available in Office 2010 and later. Represents the following attribute in the schema: label
LastChild	Gets the last child of the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no such OpenXmlElement element. (Inherited from OpenXmlCompositeElement)
LocalName	Gets the local name of the current element. (Inherited from OpenXmlElement)
MCAttributes	Gets or sets the markup compatibility attributes. Returns null if no markup compatibility attributes are defined for the current element. (Inherited from OpenXmlElement)
NamespaceDeclarations	Gets all the namespace declarations defined in the current element. Returns an empty enumerator if there is no namespace declaration. (Inherited from OpenXmlElement)
NamespaceUri	Gets the namespace URI of the current element. (Inherited from OpenXmlElement)
OnAction	onAction, this property is only available in Office 2010 and later. Represents the following attribute in the schema: onAction
OpenXmlElementContext	Gets the OpenXmlElementContext of the current element. (Inherited from OpenXmlElement)
OuterXml	Gets the markup that represents the current element and all of its child elements. (Inherited from OpenXmlElement)
Parent	Gets the parent element of the current element. (Inherited from OpenXmlElement)
Prefix	Gets the namespace prefix of current element. (Inherited from OpenXmlElement)
QualifiedId	idQ, this property is only available in Office 2010 and later. Represents the following attribute in the schema: idQ
Tag	tag, this property is only available in Office 2010 and later. Represents the following attribute in the schema: tag
Visible	visible, this property is only available in Office 2010 and later. Represents the following attribute in the schema: visible
XmlQualifiedName	Gets the qualified name of the current element. (Inherited from OpenXmlElement)
XName	Gets the qualified name of the current element. (Inherited from OpenXmlElement)

Methods

AddAnnotation(Object)	Adds an object to the current OpenXmlElement element's list of annotations. (Inherited from OpenXmlElement)
AddChild(OpenXmlElement, Boolean)	Adds the specified element to the element if it is a known child. This adds the element in the correct location according to the schema. (Inherited from OpenXmlCompositeElement)
AddNamespaceDeclaration(String, String)	Adds a namespace declaration to the current node. (Inherited from OpenXmlElement)
Ancestors()	Enumerates all of the current element's ancestors. (Inherited from OpenXmlElement)
Ancestors<T>()	Enumerates only the current element's ancestors that have the specified type. (Inherited from OpenXmlElement)
Annotation(Type)	Get the first annotation object of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
Annotation<T>()	Get the first annotation object of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
Annotations(Type)	Gets a collection of annotations with the specified type for the current OpenXmlElement element. (Inherited from OpenXmlElement)
Annotations<T>()	Gets a collection of annotations with the specified type for the current OpenXmlElement element. (Inherited from OpenXmlElement)
Append(IEnumerable<OpenXmlElement>)	Appends each element from a list of elements to the end of the current element's list of child elements. (Inherited from OpenXmlElement)
Append(OpenXmlElement[])	Appends each element from an array of elements to the end of the current element's list of child elements. (Inherited from OpenXmlElement)
AppendChild<T>(T)	Appends the specified element to the end of the current element's list of child nodes. (Inherited from OpenXmlCompositeElement)
ClearAllAttributes()	Clears all of the attributes, including both known attributes and extended attributes. (Inherited from OpenXmlElement)
Clone()	Creates a duplicate of the current node. (Inherited from OpenXmlElement)
CloneNode(Boolean)	Creates a duplicate of this node.
Descendants()	Enumerates all of the current element's descendants. (Inherited from OpenXmlElement)
Descendants<T>()	Enumerate all of the current element's descendants of type T. (Inherited from OpenXmlElement)
Elements()	Enumerates all of the current element's children. (Inherited from OpenXmlElement)
Elements<T>()	Enumerates only the current element's children that have the specified type. (Inherited from OpenXmlElement)
ElementsAfter()	Enumerates all of the sibling elements that follow the current element and have the same parent as the current element. (Inherited from OpenXmlElement)
ElementsBefore()	Enumerates all of the sibling elements that precede the current element and have the same parent as the current element. (Inherited from OpenXmlElement)
GetAttribute(String, String)	Gets an Open XML attribute with the specified tag name and namespace URI. (Inherited from OpenXmlElement)
GetAttributes()	Gets a list that contains a copy of all the attributes. (Inherited from OpenXmlElement)
GetEnumerator()	Returns an enumerator that iterates through the child collection. (Inherited from OpenXmlElement)
GetFirstChild<T>()	Finds the first child element in type T. (Inherited from OpenXmlElement)
InsertAfter<T>(T, OpenXmlElement)	Inserts the specified element immediately after the specified reference element. (Inherited from OpenXmlCompositeElement)
InsertAfterSelf<T>(T)	Inserts the specified element immediately after the current element. (Inherited from OpenXmlElement)
InsertAt<T>(T, Int32)	Inserts the specified element at the specified index of the current element's children. (Inherited from OpenXmlCompositeElement)
InsertBefore<T>(T, OpenXmlElement)	Inserts the specified element immediately before the specified reference element. (Inherited from OpenXmlCompositeElement)
InsertBeforeSelf<T>(T)	Inserts the specified element immediately before the current element. (Inherited from OpenXmlElement)
IsAfter(OpenXmlElement)	Determines if the current element appears after a specified element in document order. (Inherited from OpenXmlElement)
IsBefore(OpenXmlElement)	Determines if the current element appears before a specified element in document order. (Inherited from OpenXmlElement)
LookupNamespace(String)	Resolves the namespace prefix in the context of the current node. (Inherited from OpenXmlElement)
LookupPrefix(String)	Finds the corresponding prefix for a namespace uri in the current element scope. (Inherited from OpenXmlElement)
NextSibling()	Gets the OpenXmlElement element that immediately follows the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no next OpenXmlElement element. (Inherited from OpenXmlElement)
NextSibling<T>()	Gets the OpenXmlElement element with the specified type that follows the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no next OpenXmlElement. (Inherited from OpenXmlElement)
PrependChild<T>(T)	Inserts the specified element at the beginning of the current element's list of child nodes. (Inherited from OpenXmlCompositeElement)
PreviousSibling()	Gets the OpenXmlElement element that immediately precedes the current OpenXmlElement element. Returns null (Nothing in Visual Basic ) if there is no preceding OpenXmlElement element. (Inherited from OpenXmlElement)
PreviousSibling<T>()	Gets the OpenXmlElement element with the specified type that precedes the current OpenXmlElement. Returns null (Nothing in Visual Basic) if there is no preceding OpenXmlElement element. (Inherited from OpenXmlElement)
Remove()	Removes the current element from its parent. (Inherited from OpenXmlElement)
RemoveAllChildren()	Removes all of the current element's child elements. (Inherited from OpenXmlCompositeElement)
RemoveAllChildren<T>()	Remove all of the current element's child elements that are of type T. (Inherited from OpenXmlElement)
RemoveAnnotations(Type)	Removes the annotations of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
RemoveAnnotations<T>()	Removes the annotations with the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
RemoveAttribute(String, String)	Removes the attribute from the current element. (Inherited from OpenXmlElement)
RemoveChild<T>(T)	Removes the specified child element. (Inherited from OpenXmlCompositeElement)
RemoveNamespaceDeclaration(String)	Removes the namespace declaration for the specified prefix. Removes nothing if there is no prefix. (Inherited from OpenXmlElement)
ReplaceChild<T>(OpenXmlElement, T)	Replaces one of the current element's child elements with another OpenXmlElement element. (Inherited from OpenXmlCompositeElement)
SetAttribute(OpenXmlAttribute)	Sets an attribute to the specified element. If the attribute is a known attribute, the value of the attribute is set. If the attribute is an extended attribute, the 'openxmlAttribute' is added to the extended attributes list. (Inherited from OpenXmlElement)
SetAttributes(IEnumerable<OpenXmlAttribute>)	Sets a number of attributes to the element. If an attribute is a known attribute, the value of the attribute is set. If an attribute is an extended attribute, the 'openxmlAttribute' is added to the extended attributes list. (Inherited from OpenXmlElement)
WriteTo(XmlWriter)	Saves the current node to the specified XmlWriter. (Inherited from OpenXmlElement)

Explicit Interface Implementations

IEnumerable.GetEnumerator()	(Inherited from OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	Returns an enumerator that iterates through the child collection. (Inherited from OpenXmlElement)