OpenXmlElement Class

Represents a base class that all elements in an Office Open XML document derive from.

Inheritance Hierarchy

SystemObject
  DocumentFormat.OpenXmlOpenXmlElement
    DocumentFormat.OpenXmlOpenXmlCompositeElement
    DocumentFormat.OpenXmlOpenXmlLeafElement
    DocumentFormat.OpenXmlOpenXmlMiscNode

Namespace: DocumentFormat.OpenXml
Assembly: DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll) Version: 2.20.0+Branch.release-v2.20.0.Sha.a873d3fbff9bffe179fea62486da950adf5be65d.a873d3fbff9bffe179fea62486da950adf5be65d

Syntax

C++

Copy

public abstract class OpenXmlElement : IEnumerable<OpenXmlElement>, 
	IEnumerable, ICloneable

Public MustInherit Class OpenXmlElement
	Implements IEnumerable(Of OpenXmlElement), IEnumerable, 
	ICloneable

public ref class OpenXmlElement abstract : IEnumerable<OpenXmlElement^>, 
	IEnumerable, ICloneable

[<AbstractClassAttribute>]
type OpenXmlElement = 
    class
        interface IEnumerable<OpenXmlElement>
        interface IEnumerable
        interface ICloneable
    end

The OpenXmlElement type exposes the following members.

Properties

	Name	Description
	ChildElements	Gets all the child nodes of the current element.
	ExtendedAttributes	Gets all extended attributes (attributes not defined in the schema) of the current element.
	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.
	FirstChild	Gets the first child of the OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no such OpenXmlElement element.
	HasAttributes	Gets a value indicating whether the current element has any attributes.
	HasChildren	Gets a value indicating whether the current element has any child elements.
	InnerText	Gets or sets the concatenated values of the node and all of its children.
	InnerXml	Gets or sets the markup that represents only the child elements of the current element.
	LastChild	Gets the last child of the OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no such OpenXmlElement element.
	LocalName	Gets the local name of the current element.
	MCAttributes	Gets or sets the markup compatibility attributes. Returns null if no markup compatibility attributes are defined for the current element.
	NamespaceDeclarations	Gets all the namespace declarations defined in the current element. Returns an empty enumerator if there is no namespace declaration.
	NamespaceUri	Gets the namespace URI of the current element.
	OpenXmlElementContext	Gets the OpenXmlElementContext of the current element.
	OuterXml	Gets the markup that represents the current element and all of its child elements.
	Parent	Gets the parent element of the current element.
	Prefix	Gets the namespace prefix of current element.
	XmlQualifiedName	Gets the qualified name of the current element.
	XName	Gets the qualified name of the current element.

Top

Methods

	Name	Description
	AddAnnotation	Adds an object to the current OpenXmlElement element's list of annotations.
	AddNamespaceDeclaration	Adds a namespace declaration to the current node.
	Ancestors	Enumerates all of the current element's ancestors.
	AncestorsT	Enumerates only the current element's ancestors that have the specified type.
	Annotation(Type)	Get the first annotation object of the specified type from the current OpenXmlElement element.
	AnnotationT	Get the first annotation object of the specified type from the current OpenXmlElement element.
	Annotations(Type)	Gets a collection of annotations with the specified type for the current OpenXmlElement element.
	AnnotationsT	Gets a collection of annotations with the specified type for the current OpenXmlElement element.
	Append(IEnumerableOpenXmlElement)	Appends each element from a list of elements to the end of the current element's list of child elements.
	Append(OpenXmlElement)	Appends each element from an array of elements to the end of the current element's list of child elements.
	AppendChildT	Appends the specified element to the end of the current element's list of child nodes.
	ClearAllAttributes	Clears all of the attributes, including both known attributes and extended attributes.
	Clone	Creates a duplicate of the current node.
	CloneNode	When overridden in a derived class, creates a duplicate of the node.
	Descendants	Enumerates all of the current element's descendants.
	DescendantsT	Enumerate all of the current element's descendants of type T.
	Elements	Enumerates all of the current element's children.
	ElementsT	Enumerates only the current element's children that have the specified type.
	ElementsAfter	Enumerates all of the sibling elements that follow the current element and have the same parent as the current element.
	ElementsBefore	Enumerates all of the sibling elements that precede the current element and have the same parent as the current element.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	GetAttribute	Gets an Open XML attribute with the specified tag name and namespace URI.
	GetAttributes	Gets a list that contains a copy of all the attributes.
	GetEnumerator	Returns an enumerator that iterates through the child collection.
	GetFirstChildT	Finds the first child element in type T.
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	InsertAfterT	Inserts the specified element immediately after the specified reference element.
	InsertAfterSelfT	Inserts the specified element immediately after the current element.
	InsertAtT	Inserts the specified element at the specified index in the current element's list of child elements.
	InsertBeforeT	Inserts the specified element immediately before the specified reference element.
	InsertBeforeSelfT	Inserts the specified element immediately before the current element.
	IsAfter	Determines if the current element appears after a specified element in document order.
	IsBefore	Determines if the current element appears before a specified element in document order.
	LookupNamespace	Resolves the namespace prefix in the context of the current node.
	LookupPrefix	Finds the corresponding prefix for a namespace uri in the current element scope.
	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.
	NextSiblingT	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.
	PrependChildT	Inserts the specified element at the beginning of the current element's list of child elements.
	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.
	PreviousSiblingT	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.
	Remove	Removes the current element from its parent.
	RemoveAllChildren	Removes all of the current element's child elements.
	RemoveAllChildrenT	Remove all of the current element's child elements that are of type T.
	RemoveAnnotations(Type)	Removes the annotations of the specified type from the current OpenXmlElement element.
	RemoveAnnotationsT	Removes the annotations with the specified type from the current OpenXmlElement element.
	RemoveAttribute	Removes the attribute from the current element.
	RemoveChildT	Removes the specified child element from the current element's list of child elements.
	RemoveNamespaceDeclaration	Removes the namespace declaration for the specified prefix. Removes nothing if there is no prefix.
	ReplaceChildT	Replaces a child element with another child element in the current element's list of child elements.
	SetAttribute	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.
	SetAttributes	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.
	ToString	Returns a string that represents the current object. (Inherited from Object)
	WriteTo	Saves the current node to the specified XmlWriter.

Top

Remarks

Annotations will not be cloned when calling Clone and CloneNode(Boolean).

Reference

DocumentFormat.OpenXml Namespace