Xml​Element Xml​Element Xml​Element Class

Definition

Encapsulates information specific to XML Element nodes.

public sealed class XmlElement : IXmlElement, IXmlNode, IXmlNodeSelector, IXmlNodeSerializerpublic sealed class XmlElement : IXmlElement, IXmlNode, IXmlNodeSelector, IXmlNodeSerializerPublic NotInheritable Class XmlElement Implements IXmlElement, IXmlNode, IXmlNodeSelector, IXmlNodeSerializer
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Properties

Attributes Attributes Attributes

Gets the list of attributes of this node.

public XmlNamedNodeMap Attributes { get; }public XmlNamedNodeMap Attributes { get; }Public ReadOnly Property Attributes As XmlNamedNodeMap
Value
XmlNamedNodeMap XmlNamedNodeMap XmlNamedNodeMap

The attributes for this node.

Attributes

Remarks

This property returns a XmlNamedNodeMap for the nodes that can return attributes. These are the Element, Entity, and Notation nodes. This property is NULL for all other node types. For the valid node types, the XmlNamedNodeMap is always returned; when there are no attributes on the element, the list length is set to zero.

The following table describes the attributes for the node types.

NodeTypeAttributes
ElementIXmlNamedNodeMap
AttributeNULL
TextNULL
CDATASectionNULL
EntityReferenceNULL
EntityNULL
ProcessingInstructionNULL
CommentNULL
DocumentNULL
DocumentTypeNULL
DocumentFragmentNULL
NotationNULL

ChildNodes ChildNodes ChildNodes

Gets a list of children in the current node.

public XmlNodeList ChildNodes { get; }public XmlNodeList ChildNodes { get; }Public ReadOnly Property ChildNodes As XmlNodeList
Value
XmlNodeList XmlNodeList XmlNodeList

The list of child nodes.

Attributes

FirstChild FirstChild FirstChild

Gets the first child node.

public IXmlNode FirstChild { get; }public IXmlNode FirstChild { get; }Public ReadOnly Property FirstChild As IXmlNode
Value
IXmlNode IXmlNode IXmlNode

The first child node. This property returns NULL if there are no children.

Attributes

InnerText InnerText InnerText

Gets the text from inside the XML.

public string InnerText { get; set; }public string InnerText { get; set; }Public ReadWrite Property InnerText As string
Value
string string string

The text from inside the XML. Returns an empty string if there is no text.

Attributes

LastChild LastChild LastChild

Gets the last child node.

public IXmlNode LastChild { get; }public IXmlNode LastChild { get; }Public ReadOnly Property LastChild As IXmlNode
Value
IXmlNode IXmlNode IXmlNode

The last child node. This property is NULL if there are no children.

Attributes

LocalName LocalName LocalName

Gets the local name, which is the local part of a qualified name. This is called the local part in Namespaces in XML.

public object LocalName { get; }public object LocalName { get; }Public ReadOnly Property LocalName As object
Value
object object object

The local name.

Attributes

NamespaceUri NamespaceUri NamespaceUri

Returns the Uniform Resource Identifier (URI) for the namespace.

public object NamespaceUri { get; }public object NamespaceUri { get; }Public ReadOnly Property NamespaceUri As object
Value
object object object

The Uri for the namespace. This refers to the "uuu" portion of the namespace declaration xmlns:nnn="uuu".

Attributes

NextSibling NextSibling NextSibling

Gets the next sibling of the node in the parent's child list.

public IXmlNode NextSibling { get; }public IXmlNode NextSibling { get; }Public ReadOnly Property NextSibling As IXmlNode
Value
IXmlNode IXmlNode IXmlNode

The right sibling of this node.

Attributes

NodeName NodeName NodeName

Returns the qualified name for attribute, document type, element, entity, or notation nodes. Returns a fixed string for all other node types.

public string NodeName { get; }public string NodeName { get; }Public ReadOnly Property NodeName As string
Value
string string string

The qualified node name, which varies depending on the node type.

Attributes

Remarks

This value depends on the NodeType property. The following table describes this dependency.

NodeTypeNodeName
ElementtagName
Attributename of attribute
Text#text
CDATASection#cdata-section
EntityReferencename of entity referenced
Entityentity name
ProcessingInstructiontarget
Comment#comment
Document#document
DocumentTypedocument type name
DocumentFragment#document-fragment
Notationnotation name

NodeType NodeType NodeType

Gets the XML Document Object Model (DOM) node type, which determines valid values and whether the node can have child nodes.

public NodeType NodeType { get; }public NodeType NodeType { get; }Public ReadOnly Property NodeType As NodeType
Value
NodeType NodeType NodeType

The node type.

Attributes

NodeValue NodeValue NodeValue

Gets or sets the text associated with the node.

public object NodeValue { get; set; }public object NodeValue { get; set; }Public ReadWrite Property NodeValue As object
Value
object object object

The text associated with the node.

Attributes

Remarks

This value depends on the NodeType property. The following table describes this dependency.

NodeTypeNodeValue
ElementNull
AttributeValue of attribute
TextContent of the text node
CDATASectionContent of the CDATA Section
EntityReferenceNULL
EntityNULL
ProcessingInstructionEntire content excluding the target
CommentContent of the comment
DocumentNULL
DocumentTypeNULL
DocumentFragmentNULL
NotationNULL

OwnerDocument OwnerDocument OwnerDocument

Returns the root of the document that contains the node.

public XmlDocument OwnerDocument { get; }public XmlDocument OwnerDocument { get; }Public ReadOnly Property OwnerDocument As XmlDocument
Value
XmlDocument XmlDocument XmlDocument

The parent document that represents the root of the document.

Attributes

ParentNode ParentNode ParentNode

Gets the parent node of the node instance.

public IXmlNode ParentNode { get; }public IXmlNode ParentNode { get; }Public ReadOnly Property ParentNode As IXmlNode
Value
IXmlNode IXmlNode IXmlNode

The parent node.

Attributes

Prefix Prefix Prefix

Gets or sets the namespace prefix.

public object Prefix { get; set; }public object Prefix { get; set; }Public ReadWrite Property Prefix As object
Value
object object object

The namespace prefix specified on the element, attribute, or entity reference. For example, for the element <xxx:yyy>, this property returns xxx. It returns an empty string, "", if no prefix is specified.

Attributes

PreviousSibling PreviousSibling PreviousSibling

Gets the previous sibling of the node in the parent's child list.

public IXmlNode PreviousSibling { get; }public IXmlNode PreviousSibling { get; }Public ReadOnly Property PreviousSibling As IXmlNode
Value
IXmlNode IXmlNode IXmlNode

The left sibling of this node.

Attributes

TagName TagName TagName

Gets the element name.

public string TagName { get; }public string TagName { get; }Public ReadOnly Property TagName As string
Value
string string string

The tag for this element.

Attributes

Methods

AppendChild(IXmlNode) AppendChild(IXmlNode) AppendChild(IXmlNode)

Appends a new child node as the last child of the node.

public IXmlNode AppendChild(IXmlNode newChild)public IXmlNode AppendChild(IXmlNode newChild)Public Function AppendChild(newChild As IXmlNode) As IXmlNode
Parameters
newChild
IXmlNode IXmlNode IXmlNode

The new child node to be appended to the end of the list of children of this node.

Returns

The new child node successfully appended to the list. If null, no object is created.

Attributes

CloneNode(Boolean) CloneNode(Boolean) CloneNode(Boolean)

Clones a new node.

public IXmlNode CloneNode(Boolean deep)public IXmlNode CloneNode(Boolean deep)Public Function CloneNode(deep As Boolean) As IXmlNode
Parameters
deep
System.Boolean System.Boolean System.Boolean

A flag that indicates whether to recursively clone all nodes that are descendants of this node. If true, this method creates a clone of the complete tree below this node. If false, this method clones this node and its attributes only.

Returns

The newly created clone node.

Attributes

GetAttribute(String) GetAttribute(String) GetAttribute(String)

Returns the value of the attribute.

public string GetAttribute(String attributeName)public string GetAttribute(String attributeName)Public Function GetAttribute(attributeName As String) As string
Parameters
attributeName
System.String System.String System.String

The name of the required attribute.

Returns
string string string

The string value of the attribute.

Attributes

GetAttributeNode(String) GetAttributeNode(String) GetAttributeNode(String)

Returns the attribute node.

public XmlAttribute GetAttributeNode(String attributeName)public XmlAttribute GetAttributeNode(String attributeName)Public Function GetAttributeNode(attributeName As String) As XmlAttribute
Parameters
attributeName
System.String System.String System.String

The name of the required attribute.

Returns

The returned attribute pointer.

Attributes

GetAttributeNodeNS(Object, String) GetAttributeNodeNS(Object, String) GetAttributeNodeNS(Object, String)

Returns the specified attribute from the specified namespace.

public XmlAttribute GetAttributeNodeNS(Object namespaceUri, String localName)public XmlAttribute GetAttributeNodeNS(Object namespaceUri, String localName)Public Function GetAttributeNodeNS(namespaceUri As Object, localName As String) As XmlAttribute
Parameters
namespaceUri
System.Object System.Object System.Object

The namespace of the attribute to get.

localName
System.String System.String System.String

The name of the attribute without the namespace prefix.

Returns

The returned attribute pointer.

Attributes

GetAttributeNS(Object, String) GetAttributeNS(Object, String) GetAttributeNS(Object, String)

Returns the value of the attribute.

public string GetAttributeNS(Object namespaceUri, String localName)public string GetAttributeNS(Object namespaceUri, String localName)Public Function GetAttributeNS(namespaceUri As Object, localName As String) As string
Parameters
namespaceUri
System.Object System.Object System.Object

The namespace of the attribute to get.

localName
System.String System.String System.String

The name of the attribute without the namespace prefix.

Returns
string string string

The string value of the attribute.

Attributes

GetElementsByTagName(String) GetElementsByTagName(String) GetElementsByTagName(String)

Returns a list of all descendant elements that match the supplied name.

public XmlNodeList GetElementsByTagName(String tagName)public XmlNodeList GetElementsByTagName(String tagName)Public Function GetElementsByTagName(tagName As String) As XmlNodeList
Parameters
tagName
System.String System.String System.String

The tag of the required elements.

Returns

The required elements. The list can be empty.

Attributes

GetXml() GetXml() GetXml()

Returns the XML representation of the node and all its descendants.

public string GetXml()public string GetXml()Public Function GetXml() As string
Returns
string string string

The XML representation of the node and all its descendants.

Attributes

HasChildNodes() HasChildNodes() HasChildNodes()

Determines whether a node has children.

public bool HasChildNodes()public bool HasChildNodes()Public Function HasChildNodes() As bool
Returns
bool bool bool

True if this node has children; otherwise false.

Attributes

InsertBefore(IXmlNode, IXmlNode) InsertBefore(IXmlNode, IXmlNode) InsertBefore(IXmlNode, IXmlNode)

Inserts a child node to the left of the specified node, or at the end of the list.

public IXmlNode InsertBefore(IXmlNode newChild, IXmlNode referenceChild)public IXmlNode InsertBefore(IXmlNode newChild, IXmlNode referenceChild)Public Function InsertBefore(newChild As IXmlNode, referenceChild As IXmlNode) As IXmlNode
Parameters
newChild
IXmlNode IXmlNode IXmlNode

The address of the new node to be inserted. The node passed here must be a valid child of the current XML DOM document node. For example, if the current node is an attribute, you cannot pass another attribute in the newChild parameter, because an attribute cannot have an attribute as a child. If newChild is a DOCUMENT_FRAGMENT node type, all its children are inserted in order before referenceChild.

If newChild is already in the tree, it is first removed before it is reinserted before the referenceChild node. Read-only nodes, such as NODE_DOCUMENT_TYPE and NODE_ENTITY nodes, cannot be passed in the newChild parameter.

referenceChild
IXmlNode IXmlNode IXmlNode

The reference node. The node specified is where the newChild node is to be inserted to the left as the preceding sibling in the child list. The node passed here must be a either a child node of the current node or null. If the value is null, the newChild node is inserted at the end of the child list. If the referenceChild node is not a child of the current node, an error is returned.

Returns

On success, the child node that was inserted. If null, no object is created.

Attributes

Normalize() Normalize() Normalize()

Normalizes all descendant elements by combining two or more adjacent text nodes into one unified text node.

public void Normalize()public void Normalize()Public Function Normalize() As void
Attributes

RemoveAttribute(String) RemoveAttribute(String) RemoveAttribute(String)

Removes or replaces the named attribute.

public void RemoveAttribute(String attributeName)public void RemoveAttribute(String attributeName)Public Function RemoveAttribute(attributeName As String) As void
Parameters
attributeName
System.String System.String System.String

The name of the attribute to be removed.

Attributes

RemoveAttributeNode(XmlAttribute) RemoveAttributeNode(XmlAttribute) RemoveAttributeNode(XmlAttribute)

Removes the specified attribute from this element.

public XmlAttribute RemoveAttributeNode(XmlAttribute attributeNode)public XmlAttribute RemoveAttributeNode(XmlAttribute attributeNode)Public Function RemoveAttributeNode(attributeNode As XmlAttribute) As XmlAttribute
Parameters
attributeNode
XmlAttribute XmlAttribute XmlAttribute

The attribute to be removed.

Returns

The removed attribute, if any.

Attributes

RemoveAttributeNS(Object, String) RemoveAttributeNS(Object, String) RemoveAttributeNS(Object, String)

Removes the specified attribute from this element in the specified namespace.

public void RemoveAttributeNS(Object namespaceUri, String localName)public void RemoveAttributeNS(Object namespaceUri, String localName)Public Function RemoveAttributeNS(namespaceUri As Object, localName As String) As void
Parameters
namespaceUri
System.Object System.Object System.Object

The namespace of attribute to be removed.

localName
System.String System.String System.String

The name of the attribute without the namespace prefix.

Attributes

RemoveChild(IXmlNode) RemoveChild(IXmlNode) RemoveChild(IXmlNode)

Removes the specified child node from the list of children and returns it.

public IXmlNode RemoveChild(IXmlNode childNode)public IXmlNode RemoveChild(IXmlNode childNode)Public Function RemoveChild(childNode As IXmlNode) As IXmlNode
Parameters
childNode
IXmlNode IXmlNode IXmlNode

The child node to be removed from the list of children of this node.

Returns

The removed child node. If null, the childNode object is not removed.

Attributes

ReplaceChild(IXmlNode, IXmlNode) ReplaceChild(IXmlNode, IXmlNode) ReplaceChild(IXmlNode, IXmlNode)

Replaces the specified old child node with the supplied new child node.

public IXmlNode ReplaceChild(IXmlNode newChild, IXmlNode referenceChild)public IXmlNode ReplaceChild(IXmlNode newChild, IXmlNode referenceChild)Public Function ReplaceChild(newChild As IXmlNode, referenceChild As IXmlNode) As IXmlNode
Parameters
newChild
IXmlNode IXmlNode IXmlNode

The new child that is to replace the old child. If null, the referenceChild parameter is removed without a replacement.

referenceChild
IXmlNode IXmlNode IXmlNode

The old child that is to be replaced by the new child.

Returns

The old child that is replaced. If null, no object is created.

Attributes

SelectNodes(String) SelectNodes(String) SelectNodes(String)

Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an XmlNodeList.

public XmlNodeList SelectNodes(String xpath)public XmlNodeList SelectNodes(String xpath)Public Function SelectNodes(xpath As String) As XmlNodeList
Parameters
xpath
System.String System.String System.String

Specifies an XPath expression.

Returns

The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, this method returns an empty collection.

Attributes

SelectNodesNS(String, Object) SelectNodesNS(String, Object) SelectNodesNS(String, Object)

Applies the specified pattern-matching operation to this node's context and returns the list of matching nodes as an XmlNodeList.

public XmlNodeList SelectNodesNS(String xpath, Object namespaces)public XmlNodeList SelectNodesNS(String xpath, Object namespaces)Public Function SelectNodesNS(xpath As String, namespaces As Object) As XmlNodeList
Parameters
xpath
System.String System.String System.String

Specifies an XPath expression.

namespaces
System.Object System.Object System.Object

Contains a string that specifies namespaces for use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well.

Returns

The collection of nodes selected by applying the given pattern-matching operation. If no nodes are selected, returns an empty collection.

Attributes

Remarks

Prefixes in the query are resolved using the specified namespace declarations.

SelectSingleNode(String) SelectSingleNode(String) SelectSingleNode(String)

Applies the specified pattern-matching operation to this node's context and returns the first matching node.

public IXmlNode SelectSingleNode(String xpath)public IXmlNode SelectSingleNode(String xpath)Public Function SelectSingleNode(xpath As String) As IXmlNode
Parameters
xpath
System.String System.String System.String

Specifies an XPath expression.

Returns

The first node that matches the given pattern-matching operation. If no nodes match the expression, the method returns a null value.

Attributes

SelectSingleNodeNS(String, Object) SelectSingleNodeNS(String, Object) SelectSingleNodeNS(String, Object)

Applies the specified pattern-matching operation to this node's context and returns the first matching node.

public IXmlNode SelectSingleNodeNS(String xpath, Object namespaces)public IXmlNode SelectSingleNodeNS(String xpath, Object namespaces)Public Function SelectSingleNodeNS(xpath As String, namespaces As Object) As IXmlNode
Parameters
xpath
System.String System.String System.String

Specifies an XPath expression.

namespaces
System.Object System.Object System.Object

Contains a string that specifies the namespaces to use in XPath expressions when it is necessary to define new namespaces externally. Namespaces are defined in the XML style, as a space-separated list of namespace declaration attributes. You can use this property to set the default namespace as well.

Returns

The first node that matches the given pattern-matching operation. If no nodes match the expression, this method returns a null value.

Attributes

Remarks

Prefixes in the query are resolved using the specified namespace declarations.

SetAttribute(String, String) SetAttribute(String, String) SetAttribute(String, String)

Sets the value of the named attribute.

public void SetAttribute(String attributeName, String attributeValue)public void SetAttribute(String attributeName, String attributeValue)Public Function SetAttribute(attributeName As String, attributeValue As String) As void
Parameters
attributeName
System.String System.String System.String

The name of the required attribute.

attributeValue
System.String System.String System.String

The new value for the attribute.

Attributes

SetAttributeNode(XmlAttribute) SetAttributeNode(XmlAttribute) SetAttributeNode(XmlAttribute)

Sets or updates the supplied attribute node on this element.

public XmlAttribute SetAttributeNode(XmlAttribute newAttribute)public XmlAttribute SetAttributeNode(XmlAttribute newAttribute)Public Function SetAttributeNode(newAttribute As XmlAttribute) As XmlAttribute
Parameters
newAttribute
XmlAttribute XmlAttribute XmlAttribute

A pointer to the new attribute.

Returns

The returned pointer to the previous attribute (if any) with the same name.

Attributes

SetAttributeNodeNS(XmlAttribute) SetAttributeNodeNS(XmlAttribute) SetAttributeNodeNS(XmlAttribute)

Sets or updates the supplied attribute node on this element. If you are not using any namespaces, then use the SetAttributeNode method.

public XmlAttribute SetAttributeNodeNS(XmlAttribute newAttribute)public XmlAttribute SetAttributeNodeNS(XmlAttribute newAttribute)Public Function SetAttributeNodeNS(newAttribute As XmlAttribute) As XmlAttribute
Parameters
newAttribute
XmlAttribute XmlAttribute XmlAttribute

The node to add to the collection.

Note

You set the namespace when you create the node using the CreateAttributeNS method.

Returns

The attribute successfully added to the collection. If Null, no object is created.

Attributes

SetAttributeNS(Object, String, String) SetAttributeNS(Object, String, String) SetAttributeNS(Object, String, String)

Sets the value of the named attribute in the given namespace.

public void SetAttributeNS(Object namespaceUri, String qualifiedName, String value)public void SetAttributeNS(Object namespaceUri, String qualifiedName, String value)Public Function SetAttributeNS(namespaceUri As Object, qualifiedName As String, value As String) As void
Parameters
namespaceUri
System.Object System.Object System.Object

The namespace of the attribute being set.

qualifiedName
System.String System.String System.String

The name of the attribute being set.

value
System.String System.String System.String

The new value for the attribute.

Attributes