XmlReader.ReadOuterXml メソッド

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

XmlReader.ReadOuterXml メソッド

派生クラスでオーバーライドされると、このノードとそのすべての子を表す内容 (マークアップを含む) を読み取ります。

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

Visual Basic (宣言)

Public Overridable Function
 ReadOuterXml As String

Visual Basic (使用法)

Dim instance As XmlReader
Dim returnValue As String

returnValue = instance.ReadOuterXml

C#

public virtual string ReadOuterXml ()

C++

public:
virtual String^ ReadOuterXml ()

J#

public String ReadOuterXml ()

JScript

public function ReadOuterXml () : String

戻り値
リーダーが要素ノードまたは属性ノードに配置されている場合、このメソッドは、現在のノードおよびそのすべての子の、マークアップを含む、XML の内容をすべて返します。それ以外の場合は、空の文字列を返します。

例外

例外の種類	条件
XmlException	XML が整形式ではありませんでした。または、XML の解析中にエラーが発生しました。

解説

このメソッドは、開始タグと終了タグを返す点を除くと、ReadInnerXml に似ています。

このメソッドは、要素ノードおよび属性ノードを次の方法で処理します。

ノード型	呼び出し前の位置	XML フラグメント	戻り値	呼び出し後の位置
Element	item1 開始タグ上。	<item1>text1</item1><item2>text2</item2>	<item1>text1</item1>	item2 開始タグ上。
Attribute	attr1 属性ノード上。	<item attr1="val1" attr2="val2">text</item>	attr1="val1"	attr1 属性ノードに残しておきます。

リーダーをリーフ ノードに配置すると、ReadOuterXml の呼び出しは、Read の呼び出しに等しくなります。メソッドは String.Empty を返します (ただし、属性ノードの場合は属性マークアップを返します)。

このメソッドは、整形式の XML かどうかをチェックします。ReadOuterXml が XmlValidatingReader から呼び出された場合、返された内容も検証します。

ReadOuterXml メソッドは、XmlNodeReader クラス、XmlTextReader クラス、および XmlValidatingReader クラスで実装されるため、名前空間を認識します。XML テキスト <A xmlns:S="urn:1"><S:B>hello</S:B></A> を指定した場合、リーダーを S:B 開始タグ上に配置すると、ReadOuterXml は <S:B xmlns:S="urn:1">hello<S:B/> を返します。

使用例

ReadInnerXml メソッドと ReadOuterXml メソッドを比較する例を次に示します。

Visual Basic

' Load the file and ignore all white space.
Dim settings As New XmlReaderSettings()
settings.IgnoreWhitespace = True
Using reader As XmlReader = XmlReader.Create("2books.xml")

  ' Moves the reader to the root element.
  reader.MoveToContent()
                
  ' Moves to book node.
  reader.Read()
                
  ' Note that ReadInnerXml only returns the markup of the node's children
  ' so the book's attributes are not returned.
  Console.WriteLine("Read the first book using ReadInnerXml...")
  Console.WriteLine(reader.ReadInnerXml())
                
  ' ReadOuterXml returns the markup for the current node and its children
  ' so the book's attributes are also returned.
  Console.WriteLine("Read the second book using ReadOuterXml...")
  Console.WriteLine(reader.ReadOuterXml())

End Using

C#

// Load the file and ignore all white space.
XmlReaderSettings settings = new XmlReaderSettings();
settings.IgnoreWhitespace = true;
using (XmlReader reader = XmlReader.Create("2books.xml"))
 {

  // Moves the reader to the root element.
  reader.MoveToContent();
 
  // Moves to book node.
  reader.Read(); 

  // Note that ReadInnerXml only returns the markup of the node's children
  // so the book's attributes are not returned.
  Console.WriteLine("Read the first book using ReadInnerXml...");
  Console.WriteLine(reader.ReadInnerXml());

  // ReadOuterXml returns the markup for the current node and its children
  // so the book's attributes are also returned.
  Console.WriteLine("Read the second book using ReadOuterXml...");
  Console.WriteLine(reader.ReadOuterXml());      

}

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

<!--sample XML fragment-->
<bookstore>
  <book genre='novel' ISBN='10-861003-324'>
    <title>The Handmaid's
 Tale</title>
    <price>19.95</price>
  </book>
  <book genre='novel' ISBN='1-861001-57-5'>
    <title>Pride
 And Prejudice</title>
    <price>24.95</price>
  </book>
</bookstore>

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, 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、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
XmlReader クラス
XmlReader メンバ
System.Xml 名前空間
その他の技術情報
XmlReader による XML の読み取り