XDocument Class

Represents an XML document.

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

public class XDocument : XContainer

The XDocument type exposes the following members.

  NameDescription
Public methodSupported by the XNA FrameworkXDocument()Initializes a new instance of the XDocument class.
Public methodSupported by the XNA FrameworkXDocument(Object[])Initializes a new instance of the XDocument class with the specified content.
Public methodSupported by the XNA FrameworkXDocument(XDocument)Initializes a new instance of the XDocument class from an existing XDocument object.
Public methodSupported by the XNA FrameworkXDocument(XDeclaration, Object[])Initializes a new instance of the XDocument class with the specified XDeclaration and content.
Top

  NameDescription
Public propertySupported by the XNA FrameworkBaseUriGets the base URI for this XObject. (Inherited from XObject.)
Public propertySupported by the XNA FrameworkDeclarationGets or sets the XML declaration for this document.
Public propertySupported by the XNA FrameworkDocumentGets the XDocument for this XObject. (Inherited from XObject.)
Public propertySupported by the XNA FrameworkDocumentTypeGets the Document Type Definition (DTD) for this document.
Public propertySupported by the XNA FrameworkFirstNodeGet the first child node of this node. (Inherited from XContainer.)
Public propertySupported by the XNA FrameworkLastNodeGet the last child node of this node. (Inherited from XContainer.)
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 FrameworkRootGets the root element of the XML Tree for this document.
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 FrameworkAncestors()Returns 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 FrameworkAnnotation(Type)Gets the first annotation object of the specified type from this XObject. (Inherited from XObject.)
Public methodSupported by the XNA FrameworkAnnotation<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<T>()Gets a collection of annotations of the specified type for this XObject. (Inherited from XObject.)
Public methodSupported by the XNA FrameworkCreateReader()Creates 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 FrameworkDescendants()Returns 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 FrameworkElementGets the first (in document order) child element with the specified XName. (Inherited from XContainer.)
Public methodSupported by the XNA FrameworkElements()Returns 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 FrameworkElementsAfterSelf()Returns 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 FrameworkElementsBeforeSelf()Returns 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 FrameworkGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
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 XDocument instance by using the specified stream.
Public methodStatic memberSupported by the XNA FrameworkLoad(String)Creates a new XDocument from a file.
Public methodStatic memberSupported by the XNA FrameworkLoad(TextReader)Creates a new XDocument from a TextReader.
Public methodStatic memberSupported by the XNA FrameworkLoad(XmlReader)Creates a new XDocument from an XmlReader.
Public methodStatic memberLoad(Stream, LoadOptions)Creates a new XDocument 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)Creates a new XDocument from a file, optionally preserving white space, setting the base URI, and retaining line information.
Public methodStatic memberSupported by the XNA FrameworkLoad(TextReader, LoadOptions)Creates a new XDocument from a TextReader, optionally preserving white space, setting the base URI, and retaining line information.
Public methodStatic memberSupported by the XNA FrameworkLoad(XmlReader, LoadOptions)Loads an XElement from an XmlReader, optionally 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)Creates a new XDocument from a string.
Public methodStatic memberSupported by the XNA FrameworkParse(String, LoadOptions)Creates a new XDocument from a string, optionally preserving white space, setting the base URI, and retaining line information.
Public methodSupported by the XNA FrameworkRemoveRemoves this node from its parent. (Inherited from XNode.)
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<T>()Removes the annotations of the specified type from this XObject. (Inherited from XObject.)
Public methodSupported by the XNA FrameworkRemoveNodesRemoves the child nodes from this document or element. (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 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 XDocument to the specified Stream.
Public methodSupported by the XNA FrameworkSave(String)Serialize this XDocument to a file, overwriting an existing file, if it exists.
Public methodSupported by the XNA FrameworkSave(TextWriter)Serialize this XDocument to a TextWriter.
Public methodSupported by the XNA FrameworkSave(XmlWriter)Serialize this XDocument to an XmlWriter.
Public methodSave(Stream, SaveOptions)Outputs this XDocument to the specified Stream, optionally specifying formatting behavior.
Public methodSupported by the XNA FrameworkSave(String, SaveOptions)Serialize this XDocument to a file, optionally disabling formatting.
Public methodSupported by the XNA FrameworkSave(TextWriter, SaveOptions)Serialize this XDocument to a TextWriter, optionally disabling formatting.
Public methodSupported by the XNA FrameworkToString()Returns 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 document 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 Extension MethodCreateNavigator()Overloaded. 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 MethodValidate(XmlSchemaSet, ValidationEventHandler)Overloaded. This method validates that an XDocument conforms to an XSD in an XmlSchemaSet. (Defined by Extensions.)
Public Extension MethodValidate(XmlSchemaSet, ValidationEventHandler, Boolean)Overloaded. Validates that an XDocument conforms to an XSD in 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.)
Top

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

The following example creates a document, and then adds a comment and an element to it. It then composes another document using the results of a query.

XDocument srcTree = new XDocument(
    new XComment("This is a comment"),
    new XElement("Root",
        new XElement("Child1", "data1"),
        new XElement("Child2", "data2"),
        new XElement("Child3", "data3"),
        new XElement("Child2", "data4"),
        new XElement("Info5", "info5"),
        new XElement("Info6", "info6"),
        new XElement("Info7", "info7"),
        new XElement("Info8", "info8")
    )
);

XDocument doc = new XDocument(
    new XComment("This is a comment"),
    new XElement("Root",
        from el in srcTree.Element("Root").Elements()
        where ((string)el).StartsWith("data")
        select el
    )
);
Console.WriteLine(doc);

This example produces the following output:

<!--This is a comment-->
<Root>
  <Child1>data1</Child1>
  <Child2>data2</Child2>
  <Child3>data3</Child3>
  <Child2>data4</Child2>
</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.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft