XElement Class

 

Represents an XML element. See XElement Class Overview and the Remarks section on this page for usage information and examples.

To browse the .NET Framework source code for this type, see the Reference Source.

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

System.Object
  System.Xml.Linq.XObject
    System.Xml.Linq.XNode
      System.Xml.Linq.XContainer
        System.Xml.Linq.XElement

type XElement = 
    class
        inherit XContainer
        interface IXmlSerializable
    end

NameDescription
System_CAPS_pubmethodXElement(XElement)

Initializes a new instance of the XElement class from another XElement object.

System_CAPS_pubmethodXElement(XName)

Initializes a new instance of the XElement class with the specified name.

System_CAPS_pubmethodXElement(XName, Object)

Initializes a new instance of the XElement class with the specified name and content.

System_CAPS_pubmethodXElement(XName, Object[])

Initializes a new instance of the XElement class with the specified name and content.

System_CAPS_pubmethodXElement(XStreamingElement)

Initializes a new instance of the XElement class from an XStreamingElement object.

NameDescription
System_CAPS_pubpropertyBaseUri

Gets the base URI for this XObject.(Inherited from XObject.)

System_CAPS_pubpropertyDocument

Gets the XDocument for this XObject.(Inherited from XObject.)

System_CAPS_pubpropertySystem_CAPS_staticEmptySequence

Gets an empty collection of elements.

System_CAPS_pubpropertyFirstAttribute

Gets the first attribute of this element.

System_CAPS_pubpropertyFirstNode

Get the first child node of this node.(Inherited from XContainer.)

System_CAPS_pubpropertyHasAttributes

Gets a value indicating whether this element has at least one attribute.

System_CAPS_pubpropertyHasElements

Gets a value indicating whether this element has at least one child element.

System_CAPS_pubpropertyIsEmpty

Gets a value indicating whether this element contains no content.

System_CAPS_pubpropertyLastAttribute

Gets the last attribute of this element.

System_CAPS_pubpropertyLastNode

Get the last child node of this node.(Inherited from XContainer.)

System_CAPS_pubpropertyName

Gets or sets the name of this element.

System_CAPS_pubpropertyNextNode

Gets the next sibling node of this node.(Inherited from XNode.)

System_CAPS_pubpropertyNodeType

Gets the node type for this node.(Overrides XObject.NodeType.)

System_CAPS_pubpropertyParent

Gets the parent XElement of this XObject.(Inherited from XObject.)

System_CAPS_pubpropertyPreviousNode

Gets the previous sibling node of this node.(Inherited from XNode.)

System_CAPS_pubpropertyValue

Gets or sets the concatenated text contents of this element.

NameDescription
System_CAPS_pubmethodAdd(Object)

Adds the specified content as children of this XContainer.(Inherited from XContainer.)

System_CAPS_pubmethodAdd(Object[])

Adds the specified content as children of this XContainer.(Inherited from XContainer.)

System_CAPS_pubmethodAddAfterSelf(Object)

Adds the specified content immediately after this node.(Inherited from XNode.)

System_CAPS_pubmethodAddAfterSelf(Object[])

Adds the specified content immediately after this node.(Inherited from XNode.)

System_CAPS_pubmethodAddAnnotation(Object)

Adds an object to the annotation list of this XObject.(Inherited from XObject.)

System_CAPS_pubmethodAddBeforeSelf(Object)

Adds the specified content immediately before this node.(Inherited from XNode.)

System_CAPS_pubmethodAddBeforeSelf(Object[])

Adds the specified content immediately before this node.(Inherited from XNode.)

System_CAPS_pubmethodAddFirst(Object)

Adds the specified content as the first children of this document or element.(Inherited from XContainer.)

System_CAPS_pubmethodAddFirst(Object[])

Adds the specified content as the first children of this document or element.(Inherited from XContainer.)

System_CAPS_pubmethodAncestors()

Returns a collection of the ancestor elements of this node.(Inherited from XNode.)

System_CAPS_pubmethodAncestors(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.)

System_CAPS_pubmethodAncestorsAndSelf()

Returns a collection of elements that contain this element, and the ancestors of this element.

System_CAPS_pubmethodAncestorsAndSelf(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.

System_CAPS_pubmethodAnnotation(Type)

Gets the first annotation object of the specified type from this XObject.(Inherited from XObject.)

System_CAPS_pubmethodAnnotation<'T>()

Get the first annotation object of the specified type from this XObject. (Inherited from XObject.)

System_CAPS_pubmethodAnnotations(Type)

Gets a collection of annotations of the specified type for this XObject.(Inherited from XObject.)

System_CAPS_pubmethodAnnotations<'T>()

Gets a collection of annotations of the specified type for this XObject.(Inherited from XObject.)

System_CAPS_pubmethodAttribute(XName)

Returns the XAttribute of this XElement that has the specified XName.

System_CAPS_pubmethodAttributes()

Returns a collection of attributes of this element.

System_CAPS_pubmethodAttributes(XName)

Returns a filtered collection of attributes of this element. Only elements that have a matching XName are included in the collection.

System_CAPS_pubmethodCreateReader()

Creates an XmlReader for this node.(Inherited from XNode.)

System_CAPS_pubmethodCreateReader(ReaderOptions)

Creates an XmlReader with the options specified by the readerOptions parameter.(Inherited from XNode.)

System_CAPS_pubmethodCreateWriter()

Creates an XmlWriter that can be used to add nodes to the XContainer.(Inherited from XContainer.)

System_CAPS_pubmethodDescendantNodes()

Returns a collection of the descendant nodes for this document or element, in document order.(Inherited from XContainer.)

System_CAPS_pubmethodDescendantNodesAndSelf()

Returns a collection of nodes that contain this element, and all descendant nodes of this element, in document order.

System_CAPS_pubmethodDescendants()

Returns a collection of the descendant elements for this document or element, in document order.(Inherited from XContainer.)

System_CAPS_pubmethodDescendants(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.)

System_CAPS_pubmethodDescendantsAndSelf()

Returns a collection of elements that contain this element, and all descendant elements of this element, in document order.

System_CAPS_pubmethodDescendantsAndSelf(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.

System_CAPS_pubmethodElement(XName)

Gets the first (in document order) child element with the specified XName.(Inherited from XContainer.)

System_CAPS_pubmethodElements()

Returns a collection of the child elements of this element or document, in document order.(Inherited from XContainer.)

System_CAPS_pubmethodElements(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.)

System_CAPS_pubmethodElementsAfterSelf()

Returns a collection of the sibling elements after this node, in document order.(Inherited from XNode.)

System_CAPS_pubmethodElementsAfterSelf(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.)

System_CAPS_pubmethodElementsBeforeSelf()

Returns a collection of the sibling elements before this node, in document order.(Inherited from XNode.)

System_CAPS_pubmethodElementsBeforeSelf(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.)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetDefaultNamespace()

Gets the default XNamespace of this XElement.

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetNamespaceOfPrefix(String)

Gets the namespace associated with a particular prefix for this XElement.

System_CAPS_pubmethodGetPrefixOfNamespace(XNamespace)

Gets the prefix associated with a namespace for this XElement.

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodIsAfter(XNode)

Determines if the current node appears after a specified node in terms of document order.(Inherited from XNode.)

System_CAPS_pubmethodIsBefore(XNode)

Determines if the current node appears before a specified node in terms of document order.(Inherited from XNode.)

System_CAPS_pubmethodSystem_CAPS_staticLoad(Stream)

Creates a new XElement instance by using the specified stream.

System_CAPS_pubmethodSystem_CAPS_staticLoad(Stream, LoadOptions)

Creates a new XElement instance by using the specified stream, optionally preserving white space, setting the base URI, and retaining line information.

System_CAPS_pubmethodSystem_CAPS_staticLoad(String)

Loads an XElement from a file.

System_CAPS_pubmethodSystem_CAPS_staticLoad(String, LoadOptions)

Loads an XElement from a file, optionally preserving white space, setting the base URI, and retaining line information.

System_CAPS_pubmethodSystem_CAPS_staticLoad(TextReader)

Loads an XElement from a TextReader.

System_CAPS_pubmethodSystem_CAPS_staticLoad(TextReader, LoadOptions)

Loads an XElement from a TextReader, optionally preserving white space and retaining line information.

System_CAPS_pubmethodSystem_CAPS_staticLoad(XmlReader)

Loads an XElement from an XmlReader.

System_CAPS_pubmethodSystem_CAPS_staticLoad(XmlReader, LoadOptions)

Loads an XElement from an XmlReader, optionally preserving white space, setting the base URI, and retaining line information.

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodNodes()

Returns a collection of the child nodes of this element or document, in document order.(Inherited from XContainer.)

System_CAPS_pubmethodNodesAfterSelf()

Returns a collection of the sibling nodes after this node, in document order.(Inherited from XNode.)

System_CAPS_pubmethodNodesBeforeSelf()

Returns a collection of the sibling nodes before this node, in document order.(Inherited from XNode.)

System_CAPS_pubmethodSystem_CAPS_staticParse(String)

Load an XElement from a string that contains XML.

System_CAPS_pubmethodSystem_CAPS_staticParse(String, LoadOptions)

Load an XElement from a string that contains XML, optionally preserving white space and retaining line information.

System_CAPS_pubmethodRemove()

Removes this node from its parent.(Inherited from XNode.)

System_CAPS_pubmethodRemoveAll()

Removes nodes and attributes from this XElement.

System_CAPS_pubmethodRemoveAnnotations(Type)

Removes the annotations of the specified type from this XObject.(Inherited from XObject.)

System_CAPS_pubmethodRemoveAnnotations<'T>()

Removes the annotations of the specified type from this XObject.(Inherited from XObject.)

System_CAPS_pubmethodRemoveAttributes()

Removes the attributes of this XElement.

System_CAPS_pubmethodRemoveNodes()

Removes the child nodes from this document or element.(Inherited from XContainer.)

System_CAPS_pubmethodReplaceAll(Object)

Replaces the child nodes and the attributes of this element with the specified content.

System_CAPS_pubmethodReplaceAll(Object[])

Replaces the child nodes and the attributes of this element with the specified content.

System_CAPS_pubmethodReplaceAttributes(Object)

Replaces the attributes of this element with the specified content.

System_CAPS_pubmethodReplaceAttributes(Object[])

Replaces the attributes of this element with the specified content.

System_CAPS_pubmethodReplaceNodes(Object)

Replaces the children nodes of this document or element with the specified content.(Inherited from XContainer.)

System_CAPS_pubmethodReplaceNodes(Object[])

Replaces the children nodes of this document or element with the specified content.(Inherited from XContainer.)

System_CAPS_pubmethodReplaceWith(Object)

Replaces this node with the specified content.(Inherited from XNode.)

System_CAPS_pubmethodReplaceWith(Object[])

Replaces this node with the specified content.(Inherited from XNode.)

System_CAPS_pubmethodSave(Stream)

Outputs this XElement to the specified Stream.

System_CAPS_pubmethodSave(Stream, SaveOptions)

Outputs this XElement to the specified Stream, optionally specifying formatting behavior.

System_CAPS_pubmethodSave(String)

Serialize this element to a file.

System_CAPS_pubmethodSave(String, SaveOptions)

Serialize this element to a file, optionally disabling formatting.

System_CAPS_pubmethodSave(TextWriter)

Serialize this element to a TextWriter.

System_CAPS_pubmethodSave(TextWriter, SaveOptions)

Serialize this element to a TextWriter, optionally disabling formatting.

System_CAPS_pubmethodSave(XmlWriter)

Serialize this element to an XmlWriter.

System_CAPS_pubmethodSetAttributeValue(XName, Object)

Sets the value of an attribute, adds an attribute, or removes an attribute.

System_CAPS_pubmethodSetElementValue(XName, Object)

Sets the value of a child element, adds a child element, or removes a child element.

System_CAPS_pubmethodSetValue(Object)

Sets the value of this element.

System_CAPS_pubmethodToString()

Returns the indented XML for this node.(Inherited from XNode.)

System_CAPS_pubmethodToString(SaveOptions)

Returns the XML for this node, optionally disabling formatting.(Inherited from XNode.)

System_CAPS_pubmethodWriteTo(XmlWriter)

Write this element to an XmlWriter.(Overrides XNode.WriteTo(XmlWriter).)

NameDescription
System_CAPS_pubeventChanged

Raised when this XObject or any of its descendants have changed.(Inherited from XObject.)

System_CAPS_pubeventChanging

Raised when this XObject or any of its descendants are about to change.(Inherited from XObject.)

NameDescription
System_CAPS_puboperatorSystem_CAPS_staticExplicit(XElement to Boolean)

Cast the value of this XElement to a Boolean.

System_CAPS_puboperatorSystem_CAPS_staticExplicit(XElement to DateTime)

Cast the value of this XElement to a DateTime.

System_CAPS_puboperatorSystem_CAPS_staticExplicit(XElement to DateTimeOffset)

Cast the value of this XAttribute to a DateTimeOffset.

System_CAPS_puboperatorSystem_CAPS_staticExplicit(XElement to Decimal)

Cast the value of this XElement to a Decimal.

System_CAPS_puboperatorSystem_CAPS_staticExplicit(XElement to Double)

Cast the value of this XElement to a Double.

System_CAPS_puboperatorSystem_CAPS_staticExplicit(XElement to Guid)

Cast the value of this XElement to a Guid.

System_CAPS_puboperatorSystem_CAPS_staticExplicit(XElement to Int32)

Cast the value of this XElement to an Int32.

System_CAPS_puboperatorSystem_CAPS_staticExplicit(XElement to Int64)

Cast the value of this XElement to an Int64.

System_CAPS_puboperatorSystem_CAPS_staticExplicit(XElement to Nullable<Boolean>)

Cast the value of this XElement to a Nullable<'T> of Boolean.

System_CAPS_puboperatorSystem_CAPS_staticExplicit(XElement to Nullable<DateTime>)

Cast the value of this XElement to a Nullable<'T> of DateTime.

System_CAPS_puboperatorSystem_CAPS_staticExplicit(XElement to Nullable<DateTimeOffset>)

Cast the value of this XElement to a Nullable<'T> of DateTimeOffset.

System_CAPS_puboperatorSystem_CAPS_staticExplicit(XElement to Nullable<Decimal>)

Cast the value of this XElement to a Nullable<'T> of Decimal.

System_CAPS_puboperatorSystem_CAPS_staticExplicit(XElement to Nullable<Double>)

Cast the value of this XElement to a Nullable<'T> of Double.

System_CAPS_puboperatorSystem_CAPS_staticExplicit(XElement to Nullable<Guid>)

Cast the value of this XElement to a Nullable<'T> of Guid.

System_CAPS_puboperatorSystem_CAPS_staticExplicit(XElement to Nullable<Int32>)

Cast the value of this XElement to a Nullable<'T> of Int32.

System_CAPS_puboperatorSystem_CAPS_staticExplicit(XElement to Nullable<Int64>)

Cast the value of this XElement to a Nullable<'T> of Int64.

System_CAPS_puboperatorSystem_CAPS_staticExplicit(XElement to Nullable<Single>)

Cast the value of this XElement to a Nullable<'T> of Single.

System_CAPS_puboperatorSystem_CAPS_staticExplicit(XElement to Nullable<TimeSpan>)

Cast the value of this XElement to a Nullable<'T> of TimeSpan.

System_CAPS_puboperatorSystem_CAPS_staticExplicit(XElement to Nullable<UInt32>)

Cast the value of this XElement to a Nullable<'T> of UInt32.

System_CAPS_puboperatorSystem_CAPS_staticExplicit(XElement to Nullable<UInt64>)

Cast the value of this XElement to a Nullable<'T> of UInt64.

System_CAPS_puboperatorSystem_CAPS_staticExplicit(XElement to Single)

Cast the value of this XElement to a Single.

System_CAPS_puboperatorSystem_CAPS_staticExplicit(XElement to String)

Cast the value of this XElement to a String.

System_CAPS_puboperatorSystem_CAPS_staticExplicit(XElement to TimeSpan)

Cast the value of this XElement to a TimeSpan.

System_CAPS_puboperatorSystem_CAPS_staticExplicit(XElement to UInt32)

Cast the value of this XElement to a UInt32.

System_CAPS_puboperatorSystem_CAPS_staticExplicit(XElement to UInt64)

Cast the value of this XElement to a UInt64.

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIXmlLineInfo.HasLineInfo()

Gets a value indicating whether or not this XObject has line information.(Inherited from XObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIXmlSerializable.GetSchema()

Gets an XML schema definition that describes the XML representation of this object.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIXmlSerializable.ReadXml(XmlReader)

Generates an object from its XML representation.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIXmlSerializable.WriteXml(XmlWriter)

Converts an object into its XML representation.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIXmlLineInfo.LineNumber

Gets the line number that the underlying XmlReader reported for this XObject.(Inherited from XObject.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIXmlLineInfo.LinePosition

Gets the line position that the underlying XmlReader reported for this XObject.(Inherited from XObject.)

NameDescription
System_CAPS_pubmethodCreateNavigator()

Overloaded. Creates an XPathNavigator for an XNode.(Defined by Extensions.)

System_CAPS_pubmethodCreateNavigator(XmlNameTable)

Overloaded. Creates an XPathNavigator for an XNode. The XmlNameTable enables more efficient XPath expression processing.(Defined by Extensions.)

System_CAPS_pubmethodGetSchemaInfo()

Overloaded. Gets the post-schema-validation infoset (PSVI) of a validated element.(Defined by Extensions.)

System_CAPS_pubmethodValidate(XmlSchemaObject, XmlSchemaSet, ValidationEventHandler)

Overloaded. This method validates that an XElement sub-tree conforms to a specified XmlSchemaObject and an XmlSchemaSet.(Defined by Extensions.)

System_CAPS_pubmethodValidate(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.)

System_CAPS_pubmethodXPathEvaluate(String)

Overloaded. Evaluates an XPath expression.(Defined by Extensions.)

System_CAPS_pubmethodXPathEvaluate(String, IXmlNamespaceResolver)

Overloaded. Evaluates an XPath expression, resolving namespace prefixes using the specified IXmlNamespaceResolver.(Defined by Extensions.)

System_CAPS_pubmethodXPathSelectElement(String)

Overloaded. Selects an XElement using a XPath expression.(Defined by Extensions.)

System_CAPS_pubmethodXPathSelectElement(String, IXmlNamespaceResolver)

Overloaded. Selects an XElement using a XPath expression, resolving namespace prefixes using the specified IXmlNamespaceResolver.(Defined by Extensions.)

System_CAPS_pubmethodXPathSelectElements(String)

Overloaded. Selects a collection of elements using an XPath expression.(Defined by Extensions.)

System_CAPS_pubmethodXPathSelectElements(String, IXmlNamespaceResolver)

Overloaded. Selects a collection of elements using an XPath expression, resolving namespace prefixes using the specified IXmlNamespaceResolver.(Defined by Extensions.)

System_CAPS_noteNote

To view the .NET Framework source code for this type, see the Reference Source. You can browse through the source code online, download the reference for offline viewing, and step through the sources (including patches and updates) during debugging; see instructions.

This class represents an XML element, the fundamental XML construct. See XElement Class Overview for other usage information.

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.

No code example is currently available or this language may not be supported.

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.

No code example is currently available or this language may not be supported.

This example produces the following output:


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

Universal Windows Platform
Available since 8
.NET Framework
Available since 3.5
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1

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

Return to top
Show: