XPathNavigator.WriteSubtree(XmlWriter) Method

Definition

Namespace:

System.Xml.XPath

Assembly:

System.Xml.ReaderWriter.dll

Source:

XPathNavigator.cs

Streams the current node and its child nodes to the XmlWriter object specified.

public:
 virtual void WriteSubtree(System::Xml::XmlWriter ^ writer);

public virtual void WriteSubtree (System.Xml.XmlWriter writer);

abstract member WriteSubtree : System.Xml.XmlWriter -> unit
override this.WriteSubtree : System.Xml.XmlWriter -> unit

Public Overridable Sub WriteSubtree (writer As XmlWriter)

Parameters

writer

XmlWriter

The XmlWriter object to stream to.

Examples

The following example illustrates using the WriteSubtree method on the first book element of the contosoBooks.xml file.

    XPathDocument^ document = gcnew XPathDocument("contosoBooks.xml");
    XPathNavigator^ navigator = document->CreateNavigator();

    navigator->MoveToChild("bookstore", "http://www.contoso.com/books");
    navigator->MoveToChild("book", "http://www.contoso.com/books");

XmlWriter^ writer = XmlWriter::Create("contosoBook.xml");
    navigator->WriteSubtree(writer);

    writer->Close();

XPathDocument document = new XPathDocument("contosoBooks.xml");
XPathNavigator navigator = document.CreateNavigator();

navigator.MoveToChild("bookstore", "http://www.contoso.com/books");
navigator.MoveToChild("book", "http://www.contoso.com/books");

XmlWriter writer = XmlWriter.Create("contosoBook.xml");
navigator.WriteSubtree(writer);

writer.Close();

Dim document As XPathDocument = New XPathDocument("contosoBooks.xml")
Dim navigator As XPathNavigator = document.CreateNavigator()

navigator.MoveToChild("bookstore", "http://www.contoso.com/books")
navigator.MoveToChild("book", "http://www.contoso.com/books")

Dim writer As XmlWriter = XmlWriter.Create("contosoBook.xml")
navigator.WriteSubtree(writer)

writer.Close()

The example takes the contosoBooks.xml file as an input.

<?xml version="1.0" encoding="utf-8" ?>  
<bookstore xmlns="http://www.contoso.com/books">  
    <book genre="autobiography" publicationdate="1981-03-22" ISBN="1-861003-11-0">  
        <title>The Autobiography of Benjamin Franklin</title>  
        <author>  
            <first-name>Benjamin</first-name>  
            <last-name>Franklin</last-name>  
        </author>  
        <price>8.99</price>  
    </book>  
    <book genre="novel" publicationdate="1967-11-17" ISBN="0-201-63361-2">  
        <title>The Confidence Man</title>  
        <author>  
            <first-name>Herman</first-name>  
            <last-name>Melville</last-name>  
        </author>  
        <price>11.99</price>  
    </book>  
    <book genre="philosophy" publicationdate="1991-02-15" ISBN="1-861001-57-6">  
        <title>The Gorgias</title>  
        <author>  
            <name>Plato</name>  
        </author>  
        <price>9.99</price>  
    </book>  
</bookstore>  

Remarks

Namespace declarations for the in-scope namespaces of the current node are inserted into the XML streamed to the XmlWriter object specified.

For example, if the WriteSubtree method is called on the first book element of the books.xml file, the http://www.contoso.com/books namespace declaration made at the top of the XML document will appear in the XML streamed to the XmlWriter object specified as shown in the following example.

<?xml version="1.0" encoding="utf-8"?>  
<book genre="autobiography" publicationdate="1981" ISBN="1-861003-11-0" xmlns="http://www.contoso.com/books">  
    <title>The Autobiography of Benjamin Franklin</title>  
    <author>  
        <first-name>Benjamin</first-name>  
        <last-name>Franklin</last-name>  
    </author>  
    <price>8.99</price>  
</book>  

Note

The WriteSubtree method does not affect the position of the XPathNavigator.