XmlTextWriter クラス

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

XmlTextWriter クラス

W3C 勧告『Extensible Markup Language (XML) 1.0』および勧告『Namespaces in XML』に準拠する XML データを格納するストリームまたはファイルを高速に、非キャッシュで、前方向に生成する方法を提供するライタを表します。

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

Visual Basic (宣言)

Public Class XmlTextWriter
    Inherits XmlWriter

Visual Basic (使用法)

Dim instance As XmlTextWriter

C#

public class XmlTextWriter : XmlWriter

C++

public ref class XmlTextWriter : public
 XmlWriter

J#

public class XmlTextWriter extends XmlWriter

JScript

public class XmlTextWriter extends
 XmlWriter

解説

このクラスは、XmlWriter クラスを実装します。

メモ
Microsoft .NET Framework version 2.0 リリースでは、System.Xml.XmlWriter.Create メソッドと XmlWriterSettings クラスを使用して XmlWriter インスタンスを作成することをお勧めします。これにより、このリリースで導入されたすべての新機能を十分に活用できます。詳細については、「XML ライタの作成」を参照してください。

XmlTextWriter は、現在の要素スタックで定義されたすべての名前空間に対応する名前空間スタックを保持します。XmlTextWriter を使用すると、手動で名前空間を宣言できます。

 w.WriteStartElement("root");
 w.WriteAttributeString("xmlns", "x", null, "urn:1");
  w.WriteStartElement("item","urn:1");
  w.WriteEndElement();
  w.WriteStartElement("item","urn:1");
  w.WriteEndElement();
 w.WriteEndElement();

上記の C# コードで、次の出力が生成されます。XmlTextWriter は、名前空間宣言をルート要素に昇格させ、2 つの子要素で重複しないようにします。子要素は、名前空間宣言からプリフィックスをピック アップします。

 <root xmlns:x="urn:1">
  <x:item/>
  <x:item/>
 </x:root>

XmlTextWriter を使用すると、現在の名前空間宣言をオーバーライドできます。名前空間 URI "123" が "abc" でオーバーライドされ、XML 要素 <x:node xmlns:x="abc"/> を作成する例を次に示します。

 w.WriteStartElement("x","node","123");
 w.WriteAttributeString("xmlns","x",null,"abc");

プリフィックスを引数として取得する書き込みメソッドを使用して、使用するプリフィックスを指定することもできます。2 つの異なるプリフィックスを同じ名前空間 URI に割り当て、XML テキスト <x:root xmlns:x="urn:1"><y:item xmlns:y="urn:1"/></x:root> を作成する例を次に示します。

 XmlTextWriter w = new XmlTextWriter(Console.Out);
 w.WriteStartElement("x","root","urn:1");
  w.WriteStartElement("y","item","urn:1");
  w.WriteEndElement();
 w.WriteEndElement();
 w.Close();

異なるプリフィックスを同じ名前空間 URI に割り当てる複数の名前空間宣言がある場合、XmlTextWriter は、名前空間宣言のスタックを逆方向に検索し、最も近いものを選択します。

 XmlTextWriter w = new XmlTextWriter(Console.Out);
 w.Formatting = Formatting.Indented;
 w.WriteStartElement("x","root","urn:1");
 w.WriteStartElement("y","item","urn:1");
 w.WriteAttributeString("attr","urn:1","123");
 w.WriteEndElement();
 w.WriteEndElement();
 w.Close();

上記の C# の例では、WriteAttributeString 呼び出しでプリフィックスを指定しないため、ライタは、名前空間スタックに最後にプッシュされたプリフィックスを使用し、次の XML を作成します。

 <x:root xmlns:x="urn:1">
  <y:item y:attr="123" xmlns:y="urn:1" />
 </x:root>

名前空間の競合が発生すると、XmlTextWriter は、代替プリフィックスを生成して競合を解決します。たとえば、属性と要素のプリフィックスが同じで、名前空間が異なる場合、XmlWriter は、属性に対し代替プリフィックスを生成します。生成されたプリフィックスには、n{i} という名前が付けられます。i は 1 から始まる数字です。この数字は、要素ごとに 1 にリセットされます。

名前空間 URI に関連付けられる属性は、プリフィックスを持つ必要があります (既定の名前空間は属性に適用されません)。これは、W3C 勧告『Namespaces in XML』のセクション 5.2 に準拠します。属性が名前空間 URI を参照していても、プリフィックスを指定していない場合は、ライタが属性のプリフィックスを生成します。

空の要素を書き込むと、タグ名と終了タグの間に <item /> などの空白が追加されます。これにより、以前のバージョンのブラウザとの互換性を保つことができます。

String をメソッド パラメータとして使用すると、null 参照 (Visual Basic では Nothing) と String.Empty は等しくなります。String.Empty は、W3C の規則に準拠します。

厳密に型指定されたデータを書き込むには、XmlConvert クラスを使用してデータ型を文字列に変換します。たとえば、次に示す C# コードは、データを Double から String に変換し、要素 <price>19.95</price> を書き込みます。

 Double price = 19.95;
 writer.WriteElementString("price", XmlConvert.ToString(price));

XmlTextWriter は次のことをチェックしません。

• 属性名および要素名の無効な文字。

• 指定したエンコーディングに適合しない Unicode 文字。指定したエンコーディングに Unicode 文字が適合しない場合、XmlTextWriter は、その Unicode 文字を文字エンティティにエスケープしません。

• 重複する属性。

• DOCTYPE のパブリック ID またはシステム ID の文字。

XML の書き込みに関する詳細については、「XmlWriter による XML の書き方」を参照してください。

セキュリティについての考慮事項

XmlTextWriter クラスを使用する際の考慮事項を次に示します。

• XmlTextWriter によって例外がスローされると、本来アプリケーションには表示されてはならないパス情報が開示されてしまう可能性があります。アプリケーションで例外をキャッチし、適切に処理する必要があります。

• 他のアプリケーションに XmlTextWriter を渡すと、基になるストリームがそのアプリケーションに公開されます。信頼度の低いアプリケーションに XmlTextWriter を渡す場合は、Create メソッドによって作成される XmlWriter オブジェクトを使用する必要があります。

• XmlTextWriter は、WriteDocType メソッドまたは WriteRaw メソッドに渡されるデータの検証を行いません。これらのメソッドに任意のデータを渡さないでください。

• 既定の設定が変更された場合、生成される出力が整形式の XML データにならない可能性があります。

• 信頼関係のないソースからのサポート コンポーネント (Encoding オブジェクトなど) は受け入れないようにしてください。

継承階層

System.Object
   System.Xml.XmlWriter
    System.Xml.XmlTextWriter

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

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

参照

関連項目
XmlTextWriter メンバ
System.Xml 名前空間
その他の技術情報
XML ドキュメントと XML データ
セキュリティと System.Xml アプリケーション