XPathNavigator.ReadSubtree メソッド

.NET Framework クラス ライブラリ リファレンス

XPathNavigator.ReadSubtree メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

現在のノードとその子ノードが格納された XmlReader オブジェクトを返します。

名前空間: System.Xml.XPath
アセンブリ: System.Xml (system.xml.dll 内)
構文

Visual Basic (宣言)

Public Overridable Function
 ReadSubtree As XmlReader

Visual Basic (使用法)

Dim instance As XPathNavigator
Dim returnValue As XmlReader

returnValue = instance.ReadSubtree

C#

public virtual XmlReader ReadSubtree ()

C++

public:
virtual XmlReader^ ReadSubtree ()

J#

public XmlReader ReadSubtree ()

JScript

public function ReadSubtree () : XmlReader

戻り値
現在のノードとその子ノードが格納された XmlReader。

例外

例外の種類	条件
InvalidOperationException	XPathNavigator が要素ノードまたはルート ノードのいずれにも配置されていません。

解説

現在のノードおよびその子ノードで XmlReader オブジェクトが作成されると、XmlReader オブジェクトの ReadState プロパティが Initial に設定されます。XmlReader オブジェクトの Read メソッドが初めて呼び出されたときに、XmlReader が XPathNavigator の現在のノードに移動されます。新しい XmlReader オブジェクトは、XML ツリーの末尾に到達するまで読み取りを継続します。この時点で、Read メソッドが false を返し、XmlReader オブジェクトの ReadState プロパティが EndOfFile に設定されます。

メモ
XmlReader オブジェクトの位置を変更しても、XPathNavigator の位置には影響を与えません。

現在のノードのスコープ内の名前空間に対する名前空間宣言は、XmlReader オブジェクトに提供する XML ストリームに挿入されません。

メモ
この動作は、WriteSubtree メソッドと異なります。

使用例

contosoBooks.xml ファイルの最初の book 要素の ReadSubtree メソッドを使用する例を次に示します。

Visual Basic

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 reader As XmlReader = navigator.ReadSubtree()

While reader.Read()
    Console.WriteLine(reader.ReadInnerXml())
End While

reader.Close()

C#

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");

XmlReader reader = navigator.ReadSubtree();

while (reader.Read())
{
    Console.WriteLine(reader.ReadInnerXml());
}

reader.Close();

この例では、入力として、contosoBooks.xml というファイルを使用しています。

<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>

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
XPathNavigator クラス
XPathNavigator メンバ
System.Xml.XPath 名前空間