XmlWriterSettings.NewLineHandling プロパティ

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

XmlWriterSettings.NewLineHandling プロパティ

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

出力内の改行を正規化するかどうかを示す値を取得または設定します。

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

Visual Basic (宣言)

Public Property NewLineHandling As
 NewLineHandling

Visual Basic (使用法)

Dim instance As XmlWriterSettings
Dim value As NewLineHandling

value = instance.NewLineHandling

instance.NewLineHandling = value

C#

public NewLineHandling NewLineHandling { get;
 set; }

C++

public:
property NewLineHandling NewLineHandling {
    NewLineHandling get ();
    void set (NewLineHandling value);
}

J#

/** @property */
public NewLineHandling get_NewLineHandling ()

/** @property */
public void set_NewLineHandling (NewLineHandling
 value)

JScript

public function get NewLineHandling
 () : NewLineHandling

public function set NewLineHandling
 (value : NewLineHandling)

プロパティ値
System.Xml.NewLineHandling 値の 1 つ。既定値は Replace です。

解説

この設定は、テキストのコンテンツまたは属性値を書き込むときに適用します。それぞれの NewLineHandling 値について次に説明します。

• Entitize 設定は、改行文字を置き換えるように XmlWriter に指示します。この置き換えを行わないと、正規化 XmlReader は文字エンティティを保持しません。これは、出力を正規化 XmlReader で読み取るラウンド トリップのシナリオで役立ちます。XmlReader で正規化するときに、属性値内の \t、\n、および \r が空白に置き換えられるため、ラウンド トリップ時に属性値に対して追加の正規化規則が適用されます。

• Replace 設定は、改行文字を Microsoft Windows オペレーティング システムで使用される改行形式の \r\n に置き換えるように XmlWriter に指示します。これは、メモ帳アプリケーションまたは Microsoft Word アプリケーションでファイルを正しく表示できるようにするために役立ちます。また、この設定は、属性内の改行を文字エンティティに置き換えて文字を保持します。これは既定値です。

• None 設定は、入力を変更しないように XmlWriter に指示します。この設定は、改行処理を行わない場合に使用します。これは、正規化を行わない XmlReader (たとえば、既定の設定の XmlTextReader) で出力を読み取る場合に役立ちます。

入力値を渡したときの NewLineHandling プロパティの設定に応じた WriteString メソッドの出力を次の表に示します。この表は、テキストのコンテンツを書き込んだ場合の出力を示すほか、属性値を書き込んだ場合の出力も示しています。

テキスト ノード値

	\r\n	\n	\r	\t
Entitize	&#D;\n	\n	&#D;	\t
Replace	\r\n	\r\n	\r\n	\t
なし	\r\n	\n	\r	\t

属性値

	\r\n	\n	\r	\t
Entitize	&#D;&#A;	&#A;	&#D;		
Replace	&#D;&#A;	&#A;	&#D;		
なし	\r\n	\n	\r	\t

メモ
XmlWriter は、CDATA のセクション、コメント、または処理命令内にコンテンツを書き込むときに、次の動作を実行します。NewLineHandling プロパティが Entitize に設定されている場合でも、改行はその文字エンティティで置き換えられません。これは、CDATA のセクション、コメント、または処理命令内で文字エンティティが認識されないためです。NewLineHandling プロパティが None または Replace に設定されている場合、その動作はテキスト ノード値のときと同じです。

それぞれの空白入力に対して正規化 XmlReader が返す出力を次の表に示します。詳細については、W3C 勧告『XML 1.0』のセクション 2.11 およびセクション 3.3.3 を参照してください。

メモ
正規化リーダーは、System.Xml.XmlReader.Create メソッドで作成された任意の XmlReader オブジェクトです。これらのオブジェクトは、改行の正規化および属性の完全な正規化を常に実行します。また、Normalization プロパティが true に設定されている場合、XmlTextReader オブジェクトは正規化リーダーになることもできます。

	\r\n	\n	\r	\t
テキスト ノード値	\n	\n	\n	\t
属性値	単一の空白	単一の空白	単一の空白	単一の空白

プラットフォーム

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 ライタの作成