Export (0) Print
Expand All

XElement Class

Represents an XML element.

Namespace:  System.Xml.Linq
Assembly:  System.Xml.Linq (in System.Xml.Linq.dll)

'Declaration
Public Class XElement _
	Inherits XContainer _
	Implements IXmlSerializable

The XElement type exposes the following members.

  NameDescription
Public methodSupported by the XNA FrameworkXElement(XElement)Initializes a new instance of the XElement class from another XElement object.
Public methodSupported by the XNA FrameworkXElement(XName)Initializes a new instance of the XElement class with the specified name.
Public methodSupported by the XNA FrameworkXElement(XStreamingElement)Initializes a new instance of the XElement class from an XStreamingElement object.
Public methodSupported by the XNA FrameworkXElement(XName, Object)Initializes a new instance of the XElement class with the specified name and content.
Public methodSupported by the XNA FrameworkXElement(XName, Object())Initializes a new instance of the XElement class with the specified name and content.
Top

  NameDescription
Public propertySupported by the XNA FrameworkBaseUriGets the base URI for this XObject. (Inherited from XObject.)
Public propertySupported by the XNA FrameworkDocumentGets the XDocument for this XObject. (Inherited from XObject.)
Public propertyStatic memberSupported by the XNA FrameworkEmptySequenceGets an empty collection of elements.
Public propertySupported by the XNA FrameworkFirstAttributeGets the first attribute of this element.
Public propertySupported by the XNA FrameworkFirstNodeGet the first child node of this node. (Inherited from XContainer.)
Public propertySupported by the XNA FrameworkHasAttributesGets a value indicating whether this element as at least one attribute.
Public propertySupported by the XNA FrameworkHasElementsGets a value indicating whether this element has at least one child element.
Public propertySupported by the XNA FrameworkIsEmptyGets a value indicating whether this element contains no content.
Public propertySupported by the XNA FrameworkLastAttributeGets the last attribute of this element.
Public propertySupported by the XNA FrameworkLastNodeGet the last child node of this node. (Inherited from XContainer.)
Public propertySupported by the XNA FrameworkNameGets or sets the name of this element.
Public propertySupported by the XNA FrameworkNextNodeGets the next sibling node of this node. (Inherited from XNode.)
Public propertySupported by the XNA FrameworkNodeTypeGets the node type for this node. (Overrides XObject.NodeType.)
Public propertySupported by the XNA FrameworkParentGets the parent XElement of this XObject. (Inherited from XObject.)
Public propertySupported by the XNA FrameworkPreviousNodeGets the previous sibling node of this node. (Inherited from XNode.)
Public propertySupported by the XNA FrameworkValueGets or sets the concatenated text contents of this element.
Top

  NameDescription
Public methodSupported by the XNA FrameworkAdd(Object)Adds the specified content as children of this XContainer. (Inherited from XContainer.)
Public methodSupported by the XNA FrameworkAdd(Object())Adds the specified content as children of this XContainer. (Inherited from XContainer.)
Public methodSupported by the XNA FrameworkAddAfterSelf(Object)Adds the specified content immediately after this node. (Inherited from XNode.)
Public methodSupported by the XNA FrameworkAddAfterSelf(Object())Adds the specified content immediately after this node. (Inherited from XNode.)
Public methodSupported by the XNA FrameworkAddAnnotationAdds an object to the annotation list of this XObject. (Inherited from XObject.)
Public methodSupported by the XNA FrameworkAddBeforeSelf(Object)Adds the specified content immediately before this node. (Inherited from XNode.)
Public methodSupported by the XNA FrameworkAddBeforeSelf(Object())Adds the specified content immediately before this node. (Inherited from XNode.)
Public methodSupported by the XNA FrameworkAddFirst(Object)Adds the specified content as the first children of this document or element. (Inherited from XContainer.)
Public methodSupported by the XNA FrameworkAddFirst(Object())Adds the specified content as the first children of this document or element. (Inherited from XContainer.)
Public methodSupported by the XNA FrameworkAncestorsReturns a collection of the ancestor elements of this node. (Inherited from XNode.)
Public methodSupported by the XNA FrameworkAncestors(XName)Returns a filtered collection of the ancestor elements of this node. Only elements that have a matching XName are included in the collection. (Inherited from XNode.)
Public methodSupported by the XNA FrameworkAncestorsAndSelfReturns a collection of elements that contain this element, and the ancestors of this element.
Public methodSupported by the XNA FrameworkAncestorsAndSelf(XName)Returns a filtered collection of elements that contain this element, and the ancestors of this element. Only elements that have a matching XName are included in the collection.
Public methodSupported by the XNA FrameworkAnnotation(Type)Gets the first annotation object of the specified type from this XObject. (Inherited from XObject.)
Public methodSupported by the XNA FrameworkAnnotation(Of T)Get the first annotation object of the specified type from this XObject. (Inherited from XObject.)
Public methodSupported by the XNA FrameworkAnnotations(Type)Gets a collection of annotations of the specified type for this XObject. (Inherited from XObject.)
Public methodSupported by the XNA FrameworkAnnotations(Of T)Gets a collection of annotations of the specified type for this XObject. (Inherited from XObject.)
Public methodSupported by the XNA FrameworkAttributeReturns the XAttribute of this XElement that has the specified XName.
Public methodSupported by the XNA FrameworkAttributesReturns a collection of attributes of this element.
Public methodSupported by the XNA FrameworkAttributes(XName)Returns a filtered collection of attributes of this element. Only elements that have a matching XName are included in the collection.
Public methodSupported by the XNA FrameworkCreateReaderCreates an XmlReader for this node. (Inherited from XNode.)
Public methodCreateReader(ReaderOptions)Creates an XmlReader with the options specified by the readerOptions parameter. (Inherited from XNode.)
Public methodSupported by the XNA FrameworkCreateWriterCreates an XmlWriter that can be used to add nodes to the XContainer. (Inherited from XContainer.)
Public methodSupported by the XNA FrameworkDescendantNodesReturns a collection of the descendant nodes for this document or element, in document order. (Inherited from XContainer.)
Public methodSupported by the XNA FrameworkDescendantNodesAndSelfReturns a collection of nodes that contain this element, and all descendant nodes of this element, in document order.
Public methodSupported by the XNA FrameworkDescendantsReturns a collection of the descendant elements for this document or element, in document order. (Inherited from XContainer.)
Public methodSupported by the XNA FrameworkDescendants(XName)Returns a filtered collection of the descendant elements for this document or element, in document order. Only elements that have a matching XName are included in the collection. (Inherited from XContainer.)
Public methodSupported by the XNA FrameworkDescendantsAndSelfReturns a collection of elements that contain this element, and all descendant elements of this element, in document order.
Public methodSupported by the XNA FrameworkDescendantsAndSelf(XName)Returns a filtered collection of elements that contain this element, and all descendant elements of this element, in document order. Only elements that have a matching XName are included in the collection.
Public methodSupported by the XNA FrameworkElementGets the first (in document order) child element with the specified XName. (Inherited from XContainer.)
Public methodSupported by the XNA FrameworkElementsReturns a collection of the child elements of this element or document, in document order. (Inherited from XContainer.)
Public methodSupported by the XNA FrameworkElements(XName)Returns a filtered collection of the child elements of this element or document, in document order. Only elements that have a matching XName are included in the collection. (Inherited from XContainer.)
Public methodSupported by the XNA FrameworkElementsAfterSelfReturns a collection of the sibling elements after this node, in document order. (Inherited from XNode.)
Public methodSupported by the XNA FrameworkElementsAfterSelf(XName)Returns a filtered collection of the sibling elements after this node, in document order. Only elements that have a matching XName are included in the collection. (Inherited from XNode.)
Public methodSupported by the XNA FrameworkElementsBeforeSelfReturns a collection of the sibling elements before this node, in document order. (Inherited from XNode.)
Public methodSupported by the XNA FrameworkElementsBeforeSelf(XName)Returns a filtered collection of the sibling elements before this node, in document order. Only elements that have a matching XName are included in the collection. (Inherited from XNode.)
Public methodSupported by the XNA FrameworkEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodSupported by the XNA FrameworkFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodSupported by the XNA FrameworkGetDefaultNamespaceGets the default XNamespace of this XElement.
Public methodSupported by the XNA FrameworkGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodSupported by the XNA FrameworkGetNamespaceOfPrefixGets the namespace associated with a particular prefix for this XElement.
Public methodSupported by the XNA FrameworkGetPrefixOfNamespaceGets the prefix associated with a namespace for this XElement.
Public methodSupported by the XNA FrameworkGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodSupported by the XNA FrameworkIsAfterDetermines if the current node appears after a specified node in terms of document order. (Inherited from XNode.)
Public methodSupported by the XNA FrameworkIsBeforeDetermines if the current node appears before a specified node in terms of document order. (Inherited from XNode.)
Public methodStatic memberLoad(Stream)Creates a new XElement instance by using the specified stream.
Public methodStatic memberSupported by the XNA FrameworkLoad(String)Loads an XElement from a file.
Public methodStatic memberSupported by the XNA FrameworkLoad(TextReader)Loads an XElement from a TextReader.
Public methodStatic memberSupported by the XNA FrameworkLoad(XmlReader)Loads an XElement from an XmlReader.
Public methodStatic memberLoad(Stream, LoadOptions)Creates a new XElement instance by using the specified stream, optionally preserving white space, setting the base URI, and retaining line information.
Public methodStatic memberSupported by the XNA FrameworkLoad(String, LoadOptions)Loads an XElement from a file, optionally preserving white space, setting the base URI, and retaining line information.
Public methodStatic memberSupported by the XNA FrameworkLoad(TextReader, LoadOptions)Loads an XElement from a TextReader, optionally preserving white space and retaining line information.
Public methodStatic memberSupported by the XNA FrameworkLoad(XmlReader, LoadOptions)Loads an XElement from an XmlReader, optionally preserving white space, setting the base URI, and retaining line information.
Protected methodSupported by the XNA FrameworkMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodSupported by the XNA FrameworkNodesReturns a collection of the child nodes of this element or document, in document order. (Inherited from XContainer.)
Public methodSupported by the XNA FrameworkNodesAfterSelfReturns a collection of the sibling nodes after this node, in document order. (Inherited from XNode.)
Public methodSupported by the XNA FrameworkNodesBeforeSelfReturns a collection of the sibling nodes before this node, in document order. (Inherited from XNode.)
Public methodStatic memberSupported by the XNA FrameworkParse(String)Load an XElement from a string that contains XML.
Public methodStatic memberSupported by the XNA FrameworkParse(String, LoadOptions)Load an XElement from a string that contains XML, optionally preserving white space and retaining line information.
Public methodSupported by the XNA FrameworkRemoveRemoves this node from its parent. (Inherited from XNode.)
Public methodSupported by the XNA FrameworkRemoveAllRemoves nodes and attributes from this XElement.
Public methodSupported by the XNA FrameworkRemoveAnnotations(Type)Removes the annotations of the specified type from this XObject. (Inherited from XObject.)
Public methodSupported by the XNA FrameworkRemoveAnnotations(Of T)Removes the annotations of the specified type from this XObject. (Inherited from XObject.)
Public methodSupported by the XNA FrameworkRemoveAttributesRemoves the attributes of this XElement.
Public methodSupported by the XNA FrameworkRemoveNodesRemoves the child nodes from this document or element. (Inherited from XContainer.)
Public methodSupported by the XNA FrameworkReplaceAll(Object)Replaces the child nodes and the attributes of this element with the specified content.
Public methodSupported by the XNA FrameworkReplaceAll(Object())Replaces the child nodes and the attributes of this element with the specified content.
Public methodSupported by the XNA FrameworkReplaceAttributes(Object)Replaces the attributes of this element with the specified content.
Public methodSupported by the XNA FrameworkReplaceAttributes(Object())Replaces the attributes of this element with the specified content.
Public methodSupported by the XNA FrameworkReplaceNodes(Object)Replaces the children nodes of this document or element with the specified content. (Inherited from XContainer.)
Public methodSupported by the XNA FrameworkReplaceNodes(Object())Replaces the children nodes of this document or element with the specified content. (Inherited from XContainer.)
Public methodSupported by the XNA FrameworkReplaceWith(Object)Replaces this node with the specified content. (Inherited from XNode.)
Public methodSupported by the XNA FrameworkReplaceWith(Object())Replaces this node with the specified content. (Inherited from XNode.)
Public methodSave(Stream)Outputs this XElement to the specified Stream.
Public methodSupported by the XNA FrameworkSave(String)Serialize this element to a file.
Public methodSupported by the XNA FrameworkSave(TextWriter)Serialize this element to a TextWriter.
Public methodSupported by the XNA FrameworkSave(XmlWriter)Serialize this element to an XmlWriter.
Public methodSave(Stream, SaveOptions)Outputs this XElement to the specified Stream, optionally specifying formatting behavior.
Public methodSupported by the XNA FrameworkSave(String, SaveOptions)Serialize this element to a file, optionally disabling formatting.
Public methodSupported by the XNA FrameworkSave(TextWriter, SaveOptions)Serialize this element to a TextWriter, optionally disabling formatting.
Public methodSupported by the XNA FrameworkSetAttributeValueSets the value of an attribute, adds an attribute, or removes an attribute.
Public methodSupported by the XNA FrameworkSetElementValueSets the value of a child element, adds a child element, or removes a child element.
Public methodSupported by the XNA FrameworkSetValueSets the value of this element.
Public methodSupported by the XNA FrameworkToStringReturns the indented XML for this node. (Inherited from XNode.)
Public methodSupported by the XNA FrameworkToString(SaveOptions)Returns the XML for this node, optionally disabling formatting. (Inherited from XNode.)
Public methodSupported by the XNA FrameworkWriteToWrite this element to an XmlWriter. (Overrides XNode.WriteTo(XmlWriter).)
Top

  NameDescription
Public eventSupported by the XNA FrameworkChangedRaised when this XObject or any of its descendants have changed. (Inherited from XObject.)
Public eventSupported by the XNA FrameworkChangingRaised when this XObject or any of its descendants are about to change. (Inherited from XObject.)
Top

  NameDescription
Public operatorStatic memberSupported by the XNA FrameworkNarrowing(XElement to Decimal)Cast the value of this XElement to a Decimal.
Public operatorStatic memberSupported by the XNA FrameworkNarrowing(XElement to Nullable(Of Decimal))Cast the value of this XElement to a Nullable(Of T) of Decimal.
Public operatorStatic memberSupported by the XNA FrameworkNarrowing(XElement to DateTime)Cast the value of this XElement to a DateTime.
Public operatorStatic memberSupported by the XNA FrameworkNarrowing(XElement to Nullable(Of Single))Cast the value of this XElement to a Nullable(Of T) of Single.
Public operatorStatic memberSupported by the XNA FrameworkNarrowing(XElement to Double)Cast the value of this XElement to a Double.
Public operatorStatic memberSupported by the XNA FrameworkNarrowing(XElement to Nullable(Of Double))Cast the value of this XElement to a Nullable(Of T) of Double.
Public operatorStatic memberSupported by the XNA FrameworkNarrowing(XElement to Nullable(Of DateTime))Cast the value of this XElement to a Nullable(Of T) of DateTime.
Public operatorStatic memberSupported by the XNA FrameworkNarrowing(XElement to Nullable(Of TimeSpan))Cast the value of this XElement to a Nullable(Of T) of TimeSpan.
Public operatorStatic memberSupported by the XNA FrameworkNarrowing(XElement to Guid)Cast the value of this XElement to a Guid.
Public operatorStatic memberSupported by the XNA FrameworkNarrowing(XElement to Nullable(Of Guid))Cast the value of this XElement to a Nullable(Of T) of Guid.
Public operatorStatic memberNarrowing(XElement to DateTimeOffset)Cast the value of this XAttribute to a DateTimeOffset.
Public operatorStatic memberNarrowing(XElement to Nullable(Of DateTimeOffset))Cast the value of this XElement to a Nullable(Of T) of DateTimeOffset.
Public operatorStatic memberSupported by the XNA FrameworkNarrowing(XElement to TimeSpan)Cast the value of this XElement to a TimeSpan.
Public operatorStatic memberSupported by the XNA FrameworkNarrowing(XElement to Int32)Cast the value of this XElement to an Int32.
Public operatorStatic memberSupported by the XNA FrameworkNarrowing(XElement to Nullable(Of Int32))Cast the value of this XElement to a Nullable(Of T) of Int32.
Public operatorStatic memberSupported by the XNA FrameworkNarrowing(XElement to UInt32)Cast the value of this XElement to a UInt32.
Public operatorStatic memberSupported by the XNA FrameworkNarrowing(XElement to String)Cast the value of this XElement to a String.
Public operatorStatic memberSupported by the XNA FrameworkNarrowing(XElement to Boolean)Cast the value of this XElement to a Boolean.
Public operatorStatic memberSupported by the XNA FrameworkNarrowing(XElement to Nullable(Of Boolean))Cast the value of this XElement to a Nullable(Of T) of Boolean.
Public operatorStatic memberSupported by the XNA FrameworkNarrowing(XElement to UInt64)Cast the value of this XElement to a UInt64.
Public operatorStatic memberSupported by the XNA FrameworkNarrowing(XElement to Nullable(Of UInt64))Cast the value of this XElement to a Nullable(Of T) of UInt64.
Public operatorStatic memberSupported by the XNA FrameworkNarrowing(XElement to Single)Cast the value of this XElement to a Single.
Public operatorStatic memberSupported by the XNA FrameworkNarrowing(XElement to Nullable(Of UInt32))Cast the value of this XElement to a Nullable(Of T) of UInt32.
Public operatorStatic memberSupported by the XNA FrameworkNarrowing(XElement to Int64)Cast the value of this XElement to an Int64.
Public operatorStatic memberSupported by the XNA FrameworkNarrowing(XElement to Nullable(Of Int64))Cast the value of this XElement to a Nullable(Of T) of Int64.
Top

  NameDescription
Public Extension MethodCreateNavigatorOverloaded. Creates an XPathNavigator for an XNode. (Defined by Extensions.)
Public Extension MethodCreateNavigator(XmlNameTable)Overloaded. Creates an XPathNavigator for an XNode. The XmlNameTable enables more efficient XPath expression processing. (Defined by Extensions.)
Public Extension MethodGetSchemaInfoGets the post-schema-validation infoset (PSVI) of a validated element. (Defined by Extensions.)
Public Extension MethodValidate(XmlSchemaObject, XmlSchemaSet, ValidationEventHandler)Overloaded. This method validates that an XElement sub-tree conforms to a specified XmlSchemaObject and an XmlSchemaSet. (Defined by Extensions.)
Public Extension MethodValidate(XmlSchemaObject, XmlSchemaSet, ValidationEventHandler, Boolean)Overloaded. Validates that an XElement sub-tree conforms to a specified XmlSchemaObject and an XmlSchemaSet, optionally populating the XML tree with the post-schema-validation infoset (PSVI). (Defined by Extensions.)
Public Extension MethodXPathEvaluate(String)Overloaded. Evaluates an XPath expression. (Defined by Extensions.)
Public Extension MethodXPathEvaluate(String, IXmlNamespaceResolver)Overloaded. Evaluates an XPath expression, resolving namespace prefixes using the specified IXmlNamespaceResolver. (Defined by Extensions.)
Public Extension MethodXPathSelectElement(String)Overloaded. Selects an XElement using a XPath expression. (Defined by Extensions.)
Public Extension MethodXPathSelectElement(String, IXmlNamespaceResolver)Overloaded. Selects an XElement using a XPath expression, resolving namespace prefixes using the specified IXmlNamespaceResolver. (Defined by Extensions.)
Public Extension MethodXPathSelectElements(String)Overloaded. Selects a collection of elements using an XPath expression. (Defined by Extensions.)
Public Extension MethodXPathSelectElements(String, IXmlNamespaceResolver)Overloaded. Selects a collection of elements using an XPath expression, resolving namespace prefixes using the specified IXmlNamespaceResolver. (Defined by Extensions.)
Top

  NameDescription
Explicit interface implemetationPrivate methodSupported by the XNA FrameworkIXmlLineInfo.HasLineInfoGets a value indicating whether or not this XObject has line information. (Inherited from XObject.)
Explicit interface implemetationPrivate propertySupported by the XNA FrameworkIXmlLineInfo.LineNumberGets the line number that the underlying XmlReader reported for this XObject. (Inherited from XObject.)
Explicit interface implemetationPrivate propertySupported by the XNA FrameworkIXmlLineInfo.LinePositionGets the line position that the underlying XmlReader reported for this XObject. (Inherited from XObject.)
Explicit interface implemetationPrivate methodSupported by the XNA FrameworkIXmlSerializable.GetSchemaGets an XML schema definition that describes the XML representation of this object.
Explicit interface implemetationPrivate methodSupported by the XNA FrameworkIXmlSerializable.ReadXmlGenerates an object from its XML representation.
Explicit interface implemetationPrivate methodSupported by the XNA FrameworkIXmlSerializable.WriteXmlConverts an object into its XML representation.
Top

This class represents an XML element, the fundamental XML construct.

An element has an XName, optionally one or more attributes, and can optionally contain content (for more information, see Nodes).

An XElement can contain the following types of content:

For details about the valid content of an XElement, see Valid Content of XElement and XDocument Objects.

XElement derives from XContainer, which derives from XNode.

Some XElement methods can be used from XAML. For more information, see LINQ to XML Dynamic Properties.

The following example creates an XML tree. The content of the new element comes from a LINQ query.

Dim xmlTree1 As XElement = _
        <Root>
            <Child1>1</Child1>
            <Child2>2</Child2>
            <Child3>3</Child3>
            <Child4>4</Child4>
            <Child5>5</Child5>
            <Child6>6</Child6>
        </Root>

Dim xmlTree2 As XElement = _ 
    <Root>
        <%= From el In xmlTree1.Elements() _
            Where el.Value >= 3 And el.Value <= 5 _
            Select el %>
    </Root>

Console.WriteLine(xmlTree2)

This example produces the following output:

<Root>
  <Child3>3</Child3>
  <Child4>4</Child4>
  <Child5>5</Child5>
</Root>

The following is the same example, but in this case the XML is in a namespace. For more information, see Working with XML Namespaces.

Imports <xmlns="http://www.adventure-works.com">

Module Module1
    Sub Main()
        Dim xmlTree1 As XElement = _
            <Root>
                <Child1>1</Child1>
                <Child2>2</Child2>
                <Child3>3</Child3>
                <Child4>4</Child4>
                <Child5>5</Child5>
                <Child6>6</Child6>
            </Root>

        Dim xmlTree2 As XElement = _ 
            <Root>
                <%= From el In xmlTree1.Elements() _
                    Where el.Value >= 3 And el.Value <= 5 _
                    Select el %>
            </Root>

        Console.WriteLine(xmlTree2)
    End SUb
End Module

This example produces the following output:

<Root xmlns="http://www.adventure-works.com">
  <Child3>3</Child3>
  <Child4>4</Child4>
  <Child5>5</Child5>
</Root>

.NET Framework

Supported in: 4, 3.5

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Community Additions

ADD
Show:
© 2014 Microsoft