This documentation is archived and is not being maintained.
XDocument Class
Visual Studio 2010
Represents an XML document.
System::Object
System.Xml.Linq::XObject
System.Xml.Linq::XNode
System.Xml.Linq::XContainer
System.Xml.Linq::XDocument
System.Xml.Linq::XObject
System.Xml.Linq::XNode
System.Xml.Linq::XContainer
System.Xml.Linq::XDocument
Assembly: System.Xml.Linq (in System.Xml.Linq.dll)
The XDocument type exposes the following members.
| Name | Description | |
|---|---|---|
![]() ![]() | XDocument() | Initializes a new instance of the XDocument class. |
![]() ![]() | XDocument(array<Object>) | Initializes a new instance of the XDocument class with the specified content. |
![]() ![]() | XDocument(XDocument) | Initializes a new instance of the XDocument class from an existing XDocument object. |
![]() ![]() | XDocument(XDeclaration, array<Object>) | Initializes a new instance of the XDocument class with the specified XDeclaration and content. |
| Name | Description | |
|---|---|---|
![]() ![]() | BaseUri | Gets the base URI for this XObject. (Inherited from XObject.) |
![]() ![]() | Declaration | Gets or sets the XML declaration for this document. |
![]() ![]() | Document | Gets the XDocument for this XObject. (Inherited from XObject.) |
![]() ![]() | DocumentType | Gets the Document Type Definition (DTD) for this document. |
![]() ![]() | FirstNode | Get the first child node of this node. (Inherited from XContainer.) |
![]() ![]() | LastNode | Get the last child node of this node. (Inherited from XContainer.) |
![]() ![]() | NextNode | Gets the next sibling node of this node. (Inherited from XNode.) |
![]() ![]() | NodeType | Gets the node type for this node. (Overrides XObject::NodeType.) |
![]() ![]() | Parent | Gets the parent XElement of this XObject. (Inherited from XObject.) |
![]() ![]() | PreviousNode | Gets the previous sibling node of this node. (Inherited from XNode.) |
![]() ![]() | Root | Gets the root element of the XML Tree for this document. |
| Name | Description | |
|---|---|---|
![]() ![]() | Add(Object) | Adds the specified content as children of this XContainer. (Inherited from XContainer.) |
![]() ![]() | Add(array<Object>) | Adds the specified content as children of this XContainer. (Inherited from XContainer.) |
![]() ![]() | AddAfterSelf(Object) | Adds the specified content immediately after this node. (Inherited from XNode.) |
![]() ![]() | AddAfterSelf(array<Object>) | Adds the specified content immediately after this node. (Inherited from XNode.) |
![]() ![]() | AddAnnotation | Adds an object to the annotation list of this XObject. (Inherited from XObject.) |
![]() ![]() | AddBeforeSelf(Object) | Adds the specified content immediately before this node. (Inherited from XNode.) |
![]() ![]() | AddBeforeSelf(array<Object>) | Adds the specified content immediately before this node. (Inherited from XNode.) |
![]() ![]() | AddFirst(Object) | Adds the specified content as the first children of this document or element. (Inherited from XContainer.) |
![]() ![]() | AddFirst(array<Object>) | Adds the specified content as the first children of this document or element. (Inherited from XContainer.) |
![]() ![]() | Ancestors() | Returns a collection of the ancestor elements of this node. (Inherited from XNode.) |
![]() ![]() | Ancestors(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.) |
![]() ![]() | Annotation(Type) | Gets the first annotation object of the specified type from this XObject. (Inherited from XObject.) |
![]() ![]() | Annotation<T>() | Get the first annotation object of the specified type from this XObject. (Inherited from XObject.) |
![]() ![]() | Annotations(Type) | Gets a collection of annotations of the specified type for this XObject. (Inherited from XObject.) |
![]() ![]() | Annotations<T>() | Gets a collection of annotations of the specified type for this XObject. (Inherited from XObject.) |
![]() ![]() | CreateReader() | Creates an XmlReader for this node. (Inherited from XNode.) |
![]() | CreateReader(ReaderOptions) | Creates an XmlReader with the options specified by the readerOptions parameter. (Inherited from XNode.) |
![]() ![]() | CreateWriter | Creates an XmlWriter that can be used to add nodes to the XContainer. (Inherited from XContainer.) |
![]() ![]() | DescendantNodes | Returns a collection of the descendant nodes for this document or element, in document order. (Inherited from XContainer.) |
![]() ![]() | Descendants() | Returns a collection of the descendant elements for this document or element, in document order. (Inherited from XContainer.) |
![]() ![]() | Descendants(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.) |
![]() ![]() | Element | Gets the first (in document order) child element with the specified XName. (Inherited from XContainer.) |
![]() ![]() | Elements() | Returns a collection of the child elements of this element or document, in document order. (Inherited from XContainer.) |
![]() ![]() | Elements(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.) |
![]() ![]() | ElementsAfterSelf() | Returns a collection of the sibling elements after this node, in document order. (Inherited from XNode.) |
![]() ![]() | ElementsAfterSelf(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.) |
![]() ![]() | ElementsBeforeSelf() | Returns a collection of the sibling elements before this node, in document order. (Inherited from XNode.) |
![]() ![]() | ElementsBeforeSelf(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.) |
![]() ![]() | Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
![]() ![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() ![]() | GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
![]() ![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() ![]() | IsAfter | Determines if the current node appears after a specified node in terms of document order. (Inherited from XNode.) |
![]() ![]() | IsBefore | Determines if the current node appears before a specified node in terms of document order. (Inherited from XNode.) |
![]() ![]() | Load(Stream) | Creates a new XDocument instance by using the specified stream. |
![]() ![]() ![]() | Load(String) | Creates a new XDocument from a file. |
![]() ![]() ![]() | Load(TextReader) | Creates a new XDocument from a TextReader. |
![]() ![]() ![]() | Load(XmlReader) | Creates a new XDocument from an XmlReader. |
![]() ![]() | Load(Stream, LoadOptions) | Creates a new XDocument instance by using the specified stream, optionally preserving white space, setting the base URI, and retaining line information. |
![]() ![]() ![]() | Load(String, LoadOptions) | Creates a new XDocument from a file, optionally preserving white space, setting the base URI, and retaining line information. |
![]() ![]() ![]() | Load(TextReader, LoadOptions) | Creates a new XDocument from a TextReader, optionally preserving white space, setting the base URI, and retaining line information. |
![]() ![]() ![]() | Load(XmlReader, LoadOptions) | Loads an XElement from an XmlReader, optionally setting the base URI, and retaining line information. |
![]() ![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() ![]() | Nodes | Returns a collection of the child nodes of this element or document, in document order. (Inherited from XContainer.) |
![]() ![]() | NodesAfterSelf | Returns a collection of the sibling nodes after this node, in document order. (Inherited from XNode.) |
![]() ![]() | NodesBeforeSelf | Returns a collection of the sibling nodes before this node, in document order. (Inherited from XNode.) |
![]() ![]() ![]() | Parse(String) | Creates a new XDocument from a string. |
![]() ![]() ![]() | Parse(String, LoadOptions) | Creates a new XDocument from a string, optionally preserving white space, setting the base URI, and retaining line information. |
![]() ![]() | Remove | Removes this node from its parent. (Inherited from XNode.) |
![]() ![]() | RemoveAnnotations(Type) | Removes the annotations of the specified type from this XObject. (Inherited from XObject.) |
![]() ![]() | RemoveAnnotations<T>() | Removes the annotations of the specified type from this XObject. (Inherited from XObject.) |
![]() ![]() | RemoveNodes | Removes the child nodes from this document or element. (Inherited from XContainer.) |
![]() ![]() | ReplaceNodes(Object) | Replaces the children nodes of this document or element with the specified content. (Inherited from XContainer.) |
![]() ![]() | ReplaceNodes(array<Object>) | Replaces the children nodes of this document or element with the specified content. (Inherited from XContainer.) |
![]() ![]() | ReplaceWith(Object) | Replaces this node with the specified content. (Inherited from XNode.) |
![]() ![]() | ReplaceWith(array<Object>) | Replaces this node with the specified content. (Inherited from XNode.) |
![]() | Save(Stream) | Outputs this XDocument to the specified Stream. |
![]() ![]() | Save(String) | Serialize this XDocument to a file, overwriting an existing file, if it exists. |
![]() ![]() | Save(TextWriter) | Serialize this XDocument to a TextWriter. |
![]() ![]() | Save(XmlWriter) | Serialize this XDocument to an XmlWriter. |
![]() | Save(Stream, SaveOptions) | Outputs this XDocument to the specified Stream, optionally specifying formatting behavior. |
![]() ![]() | Save(String, SaveOptions) | Serialize this XDocument to a file, optionally disabling formatting. |
![]() ![]() | Save(TextWriter, SaveOptions) | Serialize this XDocument to a TextWriter, optionally disabling formatting. |
![]() ![]() | ToString() | Returns the indented XML for this node. (Inherited from XNode.) |
![]() ![]() | ToString(SaveOptions) | Returns the XML for this node, optionally disabling formatting. (Inherited from XNode.) |
![]() ![]() | WriteTo | Write this document to an XmlWriter. (Overrides XNode::WriteTo(XmlWriter).) |
| Name | Description | |
|---|---|---|
![]() | CreateNavigator() | Overloaded. Creates an XPathNavigator for an XNode. (Defined by Extensions.) |
![]() | CreateNavigator(XmlNameTable) | Overloaded. Creates an XPathNavigator for an XNode. The XmlNameTable enables more efficient XPath expression processing. (Defined by Extensions.) |
![]() | Validate(XmlSchemaSet, ValidationEventHandler) | Overloaded. This method validates that an XDocument conforms to an XSD in an XmlSchemaSet. (Defined by Extensions.) |
![]() | Validate(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.) |
![]() | XPathEvaluate(String) | Overloaded. Evaluates an XPath expression. (Defined by Extensions.) |
![]() | XPathEvaluate(String, IXmlNamespaceResolver) | Overloaded. Evaluates an XPath expression, resolving namespace prefixes using the specified IXmlNamespaceResolver. (Defined by Extensions.) |
![]() | XPathSelectElement(String) | Overloaded. Selects an XElement using a XPath expression. (Defined by Extensions.) |
![]() | XPathSelectElement(String, IXmlNamespaceResolver) | Overloaded. Selects an XElement using a XPath expression, resolving namespace prefixes using the specified IXmlNamespaceResolver. (Defined by Extensions.) |
![]() | XPathSelectElements(String) | Overloaded. Selects a collection of elements using an XPath expression. (Defined by Extensions.) |
![]() | XPathSelectElements(String, IXmlNamespaceResolver) | Overloaded. Selects a collection of elements using an XPath expression, resolving namespace prefixes using the specified IXmlNamespaceResolver. (Defined by Extensions.) |
| Name | Description | |
|---|---|---|
![]() ![]() ![]() | IXmlLineInfo::HasLineInfo | Gets a value indicating whether or not this XObject has line information. (Inherited from XObject.) |
![]() ![]() ![]() | IXmlLineInfo::LineNumber | Gets the line number that the underlying XmlReader reported for this XObject. (Inherited from XObject.) |
![]() ![]() ![]() | IXmlLineInfo::LinePosition | Gets the line position that the underlying XmlReader reported for this XObject. (Inherited from XObject.) |
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.
This example produces the following output:
<!--This is a comment--> <Root> <Child1>data1</Child1> <Child2>data2</Child2> <Child3>data3</Child3> <Child2>data4</Child2> </Root>
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.
Show:

