XDocument Class

July 28, 2014

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 methodXDocument()Initializes a new instance of the XDocument class.
Public methodXDocument(Object[])Initializes a new instance of the XDocument class with the specified content.
Public methodXDocument(XDocument)Initializes a new instance of the XDocument class from an existing XDocument object.
Public methodXDocument(XDeclaration, Object[])Initializes a new instance of the XDocument class with the specified XDeclaration and content.
Top

  NameDescription
Public propertyBaseUriGets the base URI for this XObject. (Inherited from XObject.)
Public propertyDeclarationGets or sets the XML declaration for this document.
Public propertyDocumentGets the XDocument for this XObject. (Inherited from XObject.)
Public propertyDocumentTypeGets the Document Type Definition (DTD) for this document.
Public propertyFirstNodeGet the first child node of this node. (Inherited from XContainer.)
Public propertyLastNodeGet the last child node of this node. (Inherited from XContainer.)
Public propertyNextNodeGets the next sibling node of this node. (Inherited from XNode.)
Public propertyNodeTypeGets the node type for this node. (Overrides XObject.NodeType.)
Public propertyParentGets the parent XElement of this XObject. (Inherited from XObject.)
Public propertyPreviousNodeGets the previous sibling node of this node. (Inherited from XNode.)
Public propertyRootGets the root element of the XML Tree for this document.
Top

  NameDescription
Public methodAdd(Object)Adds the specified content as children of this XContainer. (Inherited from XContainer.)
Public methodAdd(Object[])Adds the specified content as children of this XContainer. (Inherited from XContainer.)
Public methodAddAfterSelf(Object)Adds the specified content immediately after this node. (Inherited from XNode.)
Public methodAddAfterSelf(Object[])Adds the specified content immediately after this node. (Inherited from XNode.)
Public methodAddAnnotationAdds an object to the annotation list of this XObject. (Inherited from XObject.)
Public methodAddBeforeSelf(Object)Adds the specified content immediately before this node. (Inherited from XNode.)
Public methodAddBeforeSelf(Object[])Adds the specified content immediately before this node. (Inherited from XNode.)
Public methodAddFirst(Object)Adds the specified content as the first children of this document or element. (Inherited from XContainer.)
Public methodAddFirst(Object[])Adds the specified content as the first children of this document or element. (Inherited from XContainer.)
Public methodAncestors()Returns a collection of the ancestor elements of this node. (Inherited from XNode.)
Public methodAncestors(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 methodAnnotation(Type)Gets the first annotation object of the specified type from this XObject. (Inherited from XObject.)
Public methodAnnotation<T>()Get the first annotation object of the specified type from this XObject. (Inherited from XObject.)
Public methodAnnotations(Type)Gets a collection of annotations of the specified type for this XObject. (Inherited from XObject.)
Public methodAnnotations<T>()Gets a collection of annotations of the specified type for this XObject. (Inherited from XObject.)
Public methodCreateReader()Creates an XmlReader for this node. (Inherited from XNode.)
Public methodCreateReader(ReaderOptions)Creates an XmlReader for this node. (Inherited from XNode.)
Public methodCreateWriterCreates an XmlWriter that can be used to add nodes to the XContainer. (Inherited from XContainer.)
Public methodDescendantNodesReturns a collection of the descendant nodes for this document or element, in document order. (Inherited from XContainer.)
Public methodDescendants()Returns a collection of the descendant elements for this document or element, in document order. (Inherited from XContainer.)
Public methodDescendants(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 methodElementGets the first (in document order) child element with the specified XName. (Inherited from XContainer.)
Public methodElements()Returns a collection of the child elements of this element or document, in document order. (Inherited from XContainer.)
Public methodElements(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 methodElementsAfterSelf()Returns a collection of the sibling elements after this node, in document order. (Inherited from XNode.)
Public methodElementsAfterSelf(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 methodElementsBeforeSelf()Returns a collection of the sibling elements before this node, in document order. (Inherited from XNode.)
Public methodElementsBeforeSelf(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 methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIsAfterDetermines if the current node appears after a specified node in terms of document order. (Inherited from XNode.)
Public methodIsBeforeDetermines 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 using the specified stream.
Public methodStatic memberLoad(String)Creates a new XDocument from a file located in the application's XAP package.
Public methodStatic memberLoad(TextReader)Creates a new XDocument from a TextReader.
Public methodStatic memberLoad(XmlReader)Creates a new XDocument from an XmlReader.
Public methodStatic memberLoad(Stream, LoadOptions)Creates a new XDocument instance using the specified stream, optionally preserving white space, setting the base URI, and retaining line information.
Public methodStatic memberLoad(String, LoadOptions)Creates a new XDocument from a file located in the application's XAP package, optionally preserving white space, setting the base URI, and retaining line information.
Public methodStatic memberLoad(TextReader, LoadOptions)Creates a new XDocument from a TextReader, optionally preserving white space, setting the base URI, and retaining line information.
Public methodStatic memberLoad(XmlReader, LoadOptions)Creates a new XDocument from an XmlReader, optionally setting the base URI, and retaining line information.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodNodesReturns a collection of the child nodes of this element or document, in document order. (Inherited from XContainer.)
Public methodNodesAfterSelfReturns a collection of the sibling nodes after this node, in document order. (Inherited from XNode.)
Public methodNodesBeforeSelfReturns a collection of the sibling nodes before this node, in document order. (Inherited from XNode.)
Public methodStatic memberParse(String)Creates a new XDocument from a string.
Public methodStatic memberParse(String, LoadOptions)Creates a new XDocument from a string, optionally preserving white space, setting the base URI, and retaining line information.
Public methodRemoveRemoves this node from its parent. (Inherited from XNode.)
Public methodRemoveAnnotations(Type)Removes the annotations of the specified type from this XObject. (Inherited from XObject.)
Public methodRemoveAnnotations<T>()Removes the annotations of the specified type from this XObject. (Inherited from XObject.)
Public methodRemoveNodesRemoves the child nodes from this document or element. (Inherited from XContainer.)
Public methodReplaceNodes(Object)Replaces the children nodes of this document or element with the specified content. (Inherited from XContainer.)
Public methodReplaceNodes(Object[])Replaces the children nodes of this document or element with the specified content. (Inherited from XContainer.)
Public methodReplaceWith(Object)Replaces this node with the specified content. (Inherited from XNode.)
Public methodReplaceWith(Object[])Replaces this node with the specified content. (Inherited from XNode.)
Public methodSave(Stream)Outputs this XDocument to the specified Stream.
Public methodSave(TextWriter)Serialize this XDocument to a TextWriter.
Public methodSave(XmlWriter)Serialize this XDocument to an XmlWriter.
Public methodSave(Stream, SaveOptions)Outputs this XDocument to the specified Stream, optionally specifying formatting behavior.
Public methodSave(TextWriter, SaveOptions)Serialize this XDocument to a TextWriter, optionally disabling formatting.
Public methodToString()Returns the indented XML for this node. (Inherited from XNode.)
Public methodToString(SaveOptions)Returns the XML for this node, optionally disabling formatting. (Inherited from XNode.)
Public methodWriteToWrite this document to an XmlWriter. (Overrides XNode.WriteTo(XmlWriter).)
Top

  NameDescription
Public eventChangedRaised when this XObject or any of its descendants have changed. (Inherited from XObject.)
Public eventChangingRaised when this XObject or any of its descendants are about to change. (Inherited from XObject.)
Top

  NameDescription
Explicit interface implemetationPrivate methodIXmlLineInfo.HasLineInfoGets a value indicating whether or not this XObject has line information. (Inherited from XObject.)
Explicit interface implemetationPrivate propertyIXmlLineInfo.LineNumberGets the line number that the underlying XmlReader reported for this XObject. (Inherited from XObject.)
Explicit interface implemetationPrivate propertyIXmlLineInfo.LinePositionGets the line position that the underlying XmlReader reported for this XObject. (Inherited from XObject.)
Top

For more information about the valid content of an XDocument, see Valid Content of XElement and XDocument Objects in the .NET Framework documentation.

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.


StringBuilder output = new StringBuilder();
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
    )
);
output.Append(doc + Environment.NewLine);

OutputTextBlock.Text = output.ToString();


Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

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

Show:
© 2014 Microsoft