OpenXmlElement Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Represents a base class that all elements in an Office Open XML document derive from.
public abstract class OpenXmlElement : ICloneable, System.Collections.Generic.IEnumerable<DocumentFormat.OpenXml.OpenXmlElement>public abstract class OpenXmlElement : System.Collections.Generic.IEnumerable<DocumentFormat.OpenXml.OpenXmlElement>type OpenXmlElement = class
interface seq<OpenXmlElement>
interface IEnumerable
interface ICloneabletype OpenXmlElement = class
interface seq<OpenXmlElement>
interface IEnumerablePublic MustInherit Class OpenXmlElement
Implements ICloneable, IEnumerable(Of OpenXmlElement)Public MustInherit Class OpenXmlElement
Implements IEnumerable(Of OpenXmlElement)- Inheritance
-
OpenXmlElement
- Derived
- Implements
Remarks
Annotations will not be cloned when calling Clone() and CloneNode(Boolean).
Constructors
| OpenXmlElement() |
Initializes a new instance of the OpenXmlElement class. |
| OpenXmlElement(String) |
Initializes a new instance of the OpenXmlElement class using the supplied outer XML of the element. |
Properties
| 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. |
Methods
| AddAnnotation(Object) |
Adds an object to the current OpenXmlElement element's list of annotations. |
| AddNamespaceDeclaration(String, String) |
Adds a namespace declaration to the current node. |
| Ancestors() |
Enumerates all of the current element's ancestors. |
| Ancestors<T>() |
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. |
| Annotation<T>() |
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. |
| Annotations<T>() |
Gets a collection of annotations with the specified type for the current OpenXmlElement element. |
| Append(IEnumerable<OpenXmlElement>) |
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. |
| AppendChild<T>(T) |
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(Boolean) |
When overridden in a derived class, creates a duplicate of the node. |
| Descendants() |
Enumerates all of the current element's descendants. |
| Descendants<T>() |
Enumerate all of the current element's descendants of type T. |
| Elements() |
Enumerates all of the current element's children. |
| Elements<T>() |
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. |
| GetAttribute(String, String) |
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. |
| GetFirstChild<T>() |
Finds the first child element in type T. |
| InsertAfter<T>(T, OpenXmlElement) |
Inserts the specified element immediately after the specified reference element. |
| InsertAfterSelf<T>(T) |
Inserts the specified element immediately after the current element. |
| InsertAt<T>(T, Int32) |
Inserts the specified element at the specified index in the current element's list of child elements. |
| InsertBefore<T>(T, OpenXmlElement) |
Inserts the specified element immediately before the specified reference element. |
| InsertBeforeSelf<T>(T) |
Inserts the specified element immediately before the current element. |
| IsAfter(OpenXmlElement) |
Determines if the current element appears after a specified element in document order. |
| IsBefore(OpenXmlElement) |
Determines if the current element appears before a specified element in document order. |
| LookupNamespace(String) |
Resolves the namespace prefix in the context of the current node. |
| LookupPrefix(String) |
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. |
| 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. |
| PrependChild<T>(T) |
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. |
| 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. |
| Remove() |
Removes the current element from its parent. |
| RemoveAllChildren() |
Removes all of the current element's child elements. |
| RemoveAllChildren<T>() |
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. |
| RemoveAnnotations<T>() |
Removes the annotations with the specified type from the current OpenXmlElement element. |
| RemoveAttribute(String, String) |
Removes the attribute from the current element. |
| RemoveChild<T>(T) |
Removes the specified child element from the current element's list of child elements. |
| RemoveNamespaceDeclaration(String) |
Removes the namespace declaration for the specified prefix. Removes nothing if there is no prefix. |
| ReplaceChild<T>(OpenXmlElement, T) |
Replaces a child element with another child element in the current element's list of child elements. |
| 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. |
| 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. |
| WriteTo(XmlWriter) |
Saves the current node to the specified XmlWriter. |
Explicit Interface Implementations
| IEnumerable.GetEnumerator() | |
| IEnumerable<OpenXmlElement>.GetEnumerator() |
Returns an enumerator that iterates through the child collection. |
Applies to
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for