Group Class

Definition

Namespace:

DocumentFormat.OpenXml.Vml

Assembly:

DocumentFormat.OpenXml.dll

Package:

DocumentFormat.OpenXml v3.0.1

Shape Group.

This class is available in Office 2007 and above.

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

public class Group : DocumentFormat.OpenXml.OpenXmlCompositeElement

type Group = class
    inherit OpenXmlCompositeElement

Public Class Group
Inherits OpenXmlCompositeElement

Inheritance

Object

OpenXmlElement

OpenXmlCompositeElement

Group

Remarks

[ISO/IEC 29500-1 1st Edition]

group (Shape Group)

This element is used to collect shapes and groups so they can be positioned and transformed as a single unit. A group contains group, shapetype, shape, pre-defined shape - arc, curve, image, line, oval, polyline, rect, roundrect - and lock elements.

[Example: The following example defines a few basic parts of a flying saucer graphic. The group consists of five shapes. Each shape's position is determined within the coordinate space of the group, which is defined by the group's attributes.

<v:group id="saucer"  
  style='position:relative;left:200;top:200;width:50;height:50'  
  coordorigin="0,0" coordsize="6000,6000">  
  <v:shape id="body"  
    style='position:relative;left:234.75pt;top:208.875pt;  
    width:235.25pt;height:128.875pt' coordsize="3765,2060"    path="m1285,251l1126,469,580,1009,,1285,25,1412,93,1547,194,1673,  
    1017,2026,2312,2060,3209,1756,3765,1388,3278,680,3059,319,2976,,  
    1285,251,1285,251xe"  
    fillcolor="#bcbcd6" stroked="f">  
    <v:path arrowok="t"/>  
  </v:shape>  
  <v:shape id="canopy"  
    style='position:relative;left:314.625pt;top:140.5pt;  
    width:104pt;height:102pt' coordsize="1663,1633"     path="m0,1355l177,1498,353,1582,840,1633,1378,1498,1663,1295,  
    1545,456,1260,10,1025,,656,260,253,874,,1355,,1355xe"  
    fillcolor="#99ebff" stroked="f">  
    <v:path arrowok="t"/>  
  </v:shape>  
  <v:shape id="light1"  
    style='position:relative;left:408.625pt;top:268.75pt;  
    width:24.25pt;height:27.375pt' coordsize="388,437"  
    path="m209,0l34,101,,302,125,437,329,327,388,152,209,,209,0xe"  
    fillcolor="#fff27f" stroked="f">  
    <v:path arrowok="t"/>  
  </v:shape>  
  <v:shape id="light2"  
    style='position:relative;left:356.625pt;top:279.25pt;  
    width:28.875pt;height:30pt' coordsize="462,479"  
    path="m135,0l0,186,59,422,344,479,462,228,135,,135,0xe"  
    fillcolor="#fff27f" stroked="f">  
    <v:path arrowok="t"/>  
  </v:shape>  
  <v:shape id="light3"    style='position:relative;left:302.625pt;top:274pt;  
    width:23pt;height:23.625pt' coordsize="369,378"  
    path="m0,59l226,,369,186,243,378,32,363,,59,,59xe"  
    fillcolor="#fff27f" stroked="f">  
    <v:path arrowok="t"/>  
  </v:shape>  
</v:group>  

4f4af764-0935-4e1a-a194-00c22c243688

end example]

Parent Elements
background (Part 1, §17.2.1); group (§14.1.2.7); object (Part 1, §17.3.3.19); pict (§9.2.2.2); pict (§9.5.1)

Child Elements	Subclause
anchorlock (Anchor Location Is Locked)	§14.3.2.1
arc (Arc Segment)	§14.1.2.1
borderbottom (Bottom Border)	§14.3.2.2
borderleft (Left Border)	§14.3.2.3
borderright (Right Border)	§14.3.2.4
bordertop (Top Border)	§14.3.2.5
callout (Callout)	§14.2.2.2
ClientData (Attached Object Data)	§14.4.2.12
clippath (Shape Clipping Path)	§14.2.2.3
curve (Bezier Curve)	§14.1.2.3
diagram (VML Diagram)	§14.2.2.8
extrusion (3D Extrusion)	§14.2.2.11
fill (Shape Fill Properties)	§14.1.2.5
formulas (Set of Formulas)	§14.1.2.6
group (Shape Group)	§14.1.2.7
handles (Set of Handles)	§14.1.2.9
image (Image File)	§14.1.2.10
imagedata (Image Data)	§14.1.2.11
line (Line)	§14.1.2.12
lock (Shape Protections)	§14.2.2.18
oval (Oval)	§14.1.2.13
path (Shape Path)	§14.1.2.14
polyline (Multiple Path Line)	§14.1.2.15
rect (Rectangle)	§14.1.2.16
roundrect (Rounded Rectangle)	§14.1.2.17
shadow (Shadow Effect)	§14.1.2.18
shape (Shape Definition)	§14.1.2.19
shapetype (Shape Template)	§14.1.2.20
signatureline (Digital Signature Line)	§14.2.2.30
skew (Skew Transform)	§14.2.2.31
stroke (Line Stroke Settings)	§14.1.2.21
textbox (Text Box)	§14.1.2.22
textdata (VML Diagram Text)	§14.5.2.2
textpath (Text Layout Path)	§14.1.2.23
wrap (Text Wrapping)	§14.3.2.6

[Note: The W3C XML Schema definition of this element’s content model (CT_Group) is located in §A.6.1. end note]

� ISO/IEC29500: 2008.

Constructors

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

Properties

AllowInCell	allowincell Represents the following attribute in the schema: o:allowincell
AllowOverlap	allowoverlap Represents the following attribute in the schema: o:allowoverlap
Alternate	Alternate Text Represents the following attribute in the schema: alt
Bullet	bullet Represents the following attribute in the schema: o:bullet
Button	button Represents the following attribute in the schema: o:button
ChildElements	Gets all the child nodes of the current element. (Inherited from OpenXmlElement)
Class	CSS Reference Represents the following attribute in the schema: class
CoordinateOrigin	Coordinate Space Origin Represents the following attribute in the schema: coordorigin
CoordinateSize	Coordinate Space Size Represents the following attribute in the schema: coordsize
DiagramLayout	dgmlayout Represents the following attribute in the schema: o:dgmlayout
DiagramLayoutMostRecentUsed	dgmlayoutmru Represents the following attribute in the schema: o:dgmlayoutmru
DiagramNodeKind	dgmnodekind Represents the following attribute in the schema: o:dgmnodekind
DoubleClickNotify	doubleclicknotify Represents the following attribute in the schema: o:doubleclicknotify
EditAs	Group Diagram Type Represents the following attribute in the schema: editas
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)
Gfxdata	Encoded Package Represents the following attribute in the schema: o:gfxdata
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)
Horizontal	hr Represents the following attribute in the schema: o:hr
HorizontalAlignment	hralign Represents the following attribute in the schema: o:hralign
HorizontalNoShade	hrnoshade Represents the following attribute in the schema: o:hrnoshade
HorizontalPercentage	hrpct Represents the following attribute in the schema: o:hrpct
HorizontalStandard	hrstd Represents the following attribute in the schema: o:hrstd
Href	Hyperlink Target Represents the following attribute in the schema: href
Id	Unique Identifier 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)
InsetMode	insetmode Represents the following attribute in the schema: o:insetmode
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)
Oned	oned Represents the following attribute in the schema: o:oned
OpenXmlElementContext	Gets the OpenXmlElementContext of the current element. (Inherited from OpenXmlElement)
OptionalString	spid Represents the following attribute in the schema: o:spid
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)
Print	Print Toggle Represents the following attribute in the schema: print
RegroupId	regroupid Represents the following attribute in the schema: o:regroupid
Style	Shape Styling Properties Represents the following attribute in the schema: style
TableLimits	Table Row Height Limits Represents the following attribute in the schema: o:tablelimits
TableProperties	Table Properties Represents the following attribute in the schema: o:tableproperties
Target	Hyperlink Display Target Represents the following attribute in the schema: target
Title	Shape Title Represents the following attribute in the schema: title
UserDrawn	userdrawn Represents the following attribute in the schema: o:userdrawn
UserHidden	userhidden Represents the following attribute in the schema: o:userhidden
WrapCoordinates	Shape Bounding Polygon Represents the following attribute in the schema: wrapcoords
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)