XmlWriter.Settings

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

XmlWriter.Settings プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

この XmlWriter インスタンスを作成するために使用した XmlWriterSettings オブジェクトを取得します。

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

Visual Basic (宣言)

Public Overridable ReadOnly
 Property Settings As XmlWriterSettings

Visual Basic (使用法)

Dim instance As XmlWriter
Dim value As XmlWriterSettings

value = instance.Settings

C#

public virtual XmlWriterSettings Settings { get;
 }

C++

public:
virtual property XmlWriterSettings^ Settings {
    XmlWriterSettings^ get ();
}

J#

/** @property */
public XmlWriterSettings get_Settings ()

JScript

public function get Settings
 () : XmlWriterSettings

プロパティ値
このライタのインスタンスを作成するために使用した XmlWriterSettings オブジェクト。このライタが Create メソッドを使用して作成されなかった場合、このプロパティは null 参照 (Visual Basic では Nothing) を返します。

解説

XmlWriterSettings クラスは、作成したライタのインスタンスでサポートする一連の機能を指定するために使用します。Settings プロパティによって返された XmlWriterSettings オブジェクトは変更できません。個々の設定を変更しようとすると、例外がスローされます。

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

プラットフォーム

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

参照

関連項目
XmlWriter クラス
XmlWriter メンバ
System.Xml 名前空間
その他の技術情報
XmlWriter による XML の書き方

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 名前空間

XmlWriterSettings コンストラクタ

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

XmlWriterSettings クラスの新しいインスタンスを初期化します。

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

Visual Basic (宣言)

Public Sub New

Visual Basic (使用法)

Dim instance As New XmlWriterSettings

C#

public XmlWriterSettings ()

C++

public:
XmlWriterSettings ()

J#

public XmlWriterSettings ()

JScript

public function XmlWriterSettings ()

解説

XmlWriterSettings のインスタンスの初期プロパティ値を次の表に示します。

プロパティ	初期値
CheckCharacters	true
CloseOutput	false
ConformanceLevel	Document
Encoding	Encoding.UTF8
Indent	false
IndentChars	2 個の空白
NewLineChars	\r\n (復帰、改行)
NewLineHandling	Replace
NewLineOnAttributes	false
OmitXmlDeclaration	false

使用例

インデントにタブ文字を使用する XmlWriter オブジェクトを作成する例を次に示します。

Visual Basic

Imports System
Imports System.IO
Imports System.Xml
Imports System.Text
Imports Microsoft.VisualBasic

Public Class Sample 

  Public Shared Sub Main()
 
  
    Dim writer As XmlWriter = Nothing

    Try 

       ' Create an XmlWriterSettings object with the correct options.
 
       Dim settings As XmlWriterSettings =
 New XmlWriterSettings()
       settings.Indent = true
       settings.IndentChars = (ControlChars.Tab)
       settings.OmitXmlDeclaration = true

       ' Create the XmlWriter object and write some content.
       writer = XmlWriter.Create("data.xml", settings)
       writer.WriteStartElement("book")
       writer.WriteElementString("item", "tesing")
       writer.WriteEndElement()
    
       writer.Flush()

      Finally
         If Not (writer Is
 Nothing) Then
            writer.Close()
         End If
      End Try

   End Sub 
End Class 

C#

using System;
using System.IO;
using System.Xml;
using System.Text;

public class Sample {

  public static void Main()
 {
  
    XmlWriter writer = null;

    try {

       // Create an XmlWriterSettings object with the correct options.
 
       XmlWriterSettings settings = new XmlWriterSettings();
       settings.Indent = true;
       settings.IndentChars = ("\t");
       settings.OmitXmlDeclaration = true;

       // Create the XmlWriter object and write some content.
       writer = XmlWriter.Create("data.xml", settings);
       writer.WriteStartElement("book");
       writer.WriteElementString("item", "tesing");
       writer.WriteEndElement();
    
       writer.Flush();

     } 
     finally  {
        if (writer != null)
          writer.Close();
     }
  } 
} 

プラットフォーム

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 クラス
XmlWriterSettings メンバ
System.Xml 名前空間
その他の技術情報
XML ライタの作成

XmlWriterSettings プロパティ

パブリック プロパティ

	名前	説明
	OutputMethod	XmlWriter 出力をシリアル化するために使用するメソッドを取得します。

参照

関連項目

XmlWriterSettings クラス
System.Xml 名前空間

XmlWriterSettings メソッド

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Clone	XmlWriterSettings インスタンスのコピーを作成します。
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	Reset	設定クラスのメンバを既定値にリセットします。
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)

参照

関連項目

XmlWriterSettings クラス
System.Xml 名前空間

XmlWriterSettings メンバ

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

XmlWriterSettings データ型で公開されるメンバを以下の表に示します。

パブリック コンストラクタ

	名前	説明
	XmlWriterSettings	XmlWriterSettings クラスの新しいインスタンスを初期化します。

パブリック プロパティ

	名前	説明
	OutputMethod	XmlWriter 出力をシリアル化するために使用するメソッドを取得します。

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Clone	XmlWriterSettings インスタンスのコピーを作成します。
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	Reset	設定クラスのメンバを既定値にリセットします。
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)

参照

関連項目

XmlWriterSettings クラス
System.Xml 名前空間