WordprocessingGroup Class

Definition

Namespace:

DocumentFormat.OpenXml.Office2010.Word.DrawingGroup

Assembly:

DocumentFormat.OpenXml.dll

Package:

DocumentFormat.OpenXml v3.0.1

Defines the WordprocessingGroup Class.

This class is available in Office 2010 and above.

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

public class WordprocessingGroup : DocumentFormat.OpenXml.Office2010.Word.DrawingGroup.WordprocessingGroupType

type WordprocessingGroup = class
    inherit WordprocessingGroupType

Public Class WordprocessingGroup
Inherits WordprocessingGroupType

Inheritance

Object

OpenXmlElement

OpenXmlCompositeElement

WordprocessingGroupType

WordprocessingGroup

Remarks

2.3.30 wgp

Target namespace: http://schemas.microsoft.com/office/word/2010/wordprocessingGroup

Referenced by: CT_WordprocessingCanvas

A CT_WordprocessingGroup element that specifies a group in WordprocessingML. See 2.2.7 for more details about how this element is integrated with the Open XML file formats as specified in [ISO/IEC-29500-1].

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

<xsd:element name="wgp" type="CT_WordprocessingGroup"/>

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

2.5.78 CT_WordprocessingGroup

Target namespace: http://schemas.microsoft.com/office/word/2010/wordprocessingGroup

Referenced by: CT_WordprocessingGroup, wgp, CT_WordprocessingCanvas

This complex type defines the data that represents a group of graphical objects in WordprocessingML.

Child Elements:

cNvPr: A CT_NonVisualDrawingProps element ([ISO/IEC-29500-1] section A.4.1) that specifies the non-visual properties of the current CT_WordprocessingGroup. This element MUST NOT be present when the CT_WordprocessingGroup is contained directly by a graphicData (Graphic Object Data) element as specified in [ISO/IEC-29500-1] section 20.1.2.2.17. This element MUST be present when the CT_WordprocessingGroup is not contained directly by a graphicData element as specified in [ISO/IEC-29500-1] section 20.1.2.2.17.

cNvGrpSpPr: A CT_NonVisualGroupDrawingShapeProps element ([ISO/IEC-29500-1] section A.4.1) that specifies the non-visual group properties of the current CT_WordprocessingGroup.

grpSpPr: A CT_GroupShapeProperties element ([ISO/IEC-29500-1] section A.4.1) that specifies the properties that are common across all shapes in the current CT_WordprocessingGroup. If there are any conflicting properties between the group shape properties and shape properties, the individual shape properties SHOULD<141> take precedence.

wps:wsp: A CT_WordprocessingShape element that specifies a shape that is a child of the current CT_WordprocessingGroup.

grpSp: A CT_WordprocessingGroup element that specifies a group that is a child of the current CT_WordprocessingGroup.

graphicFrame: A CT_GraphicFrame element that specifies a graphical object that is a child of the current CT_WordprocessingGroup.<142>

pic:pic: A CT_Picture element ([ISO/IEC-29500-1] section A.4.2) that specifies a picture that is a child of the current CT_WordprocessingGroup.

w14:contentPart: A CT_WordContentPart element that specifies a content part that is a child of the current CT_WordprocessingGroup.

extLst: A CT_OfficeArtExtensionList element ([ISO/IEC-29500-1] section A.4.1) to hold future extensions to the parent element of this extLst element.

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

<xsd:complexType name="CT_WordprocessingGroup">

<xsd:sequence minOccurs="1" maxOccurs="1">

<xsd:element name="cNvPr" type="a:CT_NonVisualDrawingProps" minOccurs="0" maxOccurs="1"/>

<xsd:element name="cNvGrpSpPr" type="a:CT_NonVisualGroupDrawingShapeProps" minOccurs="1" maxOccurs="1"/>

<xsd:element name="grpSpPr" type="a:CT_GroupShapeProperties" minOccurs="1" maxOccurs="1"/>

<xsd:choice minOccurs="0" maxOccurs="unbounded">

<xsd:element ref="wps:wsp"/>

<xsd:element name="grpSp" type="CT_WordprocessingGroup"/>

<xsd:element name="graphicFrame" type="CT_GraphicFrame"/>

<xsd:element ref="pic:pic"/>

<xsd:element ref="w14:contentPart"/>

</xsd:choice>

<xsd:element name="extLst" type="a:CT_OfficeArtExtensionList" minOccurs="0" maxOccurs="1"/>

</xsd:sequence>

</xsd:complexType>

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

Constructors

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

Properties

ChildElements	Gets all the child nodes of the current element. (Inherited from OpenXmlElement)
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)
GroupShapeProperties	GroupShapeProperties. Represents the following element tag in the schema: wpg:grpSpPr. (Inherited from WordprocessingGroupType)
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)
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)
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)
NonVisualDrawingProperties	NonVisualDrawingProperties. Represents the following element tag in the schema: wpg:cNvPr. (Inherited from WordprocessingGroupType)
NonVisualGroupDrawingShapeProperties	NonVisualGroupDrawingShapeProperties. Represents the following element tag in the schema: wpg:cNvGrpSpPr. (Inherited from WordprocessingGroupType)
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)
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)