XmlWriterSettings クラス

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

XmlWriterSettings クラス

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

System.Xml.XmlWriter.Create メソッドで作成された XmlWriter オブジェクトでサポートする一連の機能を指定します。

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

Visual Basic (宣言)

Public NotInheritable Class
 XmlWriterSettings

Visual Basic (使用法)

Dim instance As XmlWriterSettings

C#

public sealed class XmlWriterSettings

C++

public ref class XmlWriterSettings sealed

J#

public final class XmlWriterSettings

JScript

public final class XmlWriterSettings

解説

Microsoft .NET Framework 2.0 リリースで XmlWriter インスタンスを取得する場合は、Create メソッドの使用をお勧めします。Create メソッドは、XmlWriterSettings クラスを使用して、作成された XmlWriter オブジェクトに実装する機能を指定します。

メモ
XmlWriter を Transform メソッドと組み合わせて使用する場合は、OutputSettings プロパティを使って、正しい設定の割り当てられた XmlWriterSettings オブジェクトを取得する必要があります。これにより、作成された XmlWriter オブジェクトに正しい出力設定が適用されます。

詳細については、「XML ライタの作成」を参照してください。

使用例

XML ファイルに書き込みを行う XmlWriter を作成し、新しい行にそれぞれの属性を書き込む方法の例を次に示します。

Visual Basic

Dim settings As XmlWriterSettings = New
 XmlWriterSettings()
settings.Indent = true
settings.OmitXmlDeclaration = true
settings.NewLineOnAttributes = true
       
writer = XmlWriter.Create(Console.Out, settings)

writer.WriteStartElement("order")
writer.WriteAttributeString("orderID", "367A54")
writer.WriteAttributeString("date", "2001-05-03")
writer.WriteElementString("price", "19.95")
writer.WriteEndElement()
    
writer.Flush()

C#

XmlWriterSettings settings = new XmlWriterSettings();
settings.Indent = true;
settings.OmitXmlDeclaration = true;
settings.NewLineOnAttributes = true;
       
writer = XmlWriter.Create(Console.Out, settings);

writer.WriteStartElement("order");
writer.WriteAttributeString("orderID", "367A54");
writer.WriteAttributeString("date", "2001-05-03");
writer.WriteElementString("price", "19.95");
writer.WriteEndElement();
    
writer.Flush();

このサンプルの出力は、次のようになります。

<order
  orderID="367A54"
  date="2001-05-03">
  <price>19.95</price>
</order>

継承階層

System.Object
  System.Xml.XmlWriterSettings

スレッド セーフ

この型の 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
.NET Compact Framework
サポート対象 : 2.0

参照

関連項目
XmlWriterSettings メンバ
System.Xml 名前空間