XmlWriterSettings.NewLineHandling XmlWriterSettings.NewLineHandling XmlWriterSettings.NewLineHandling XmlWriterSettings.NewLineHandling Property

定義

出力内の改行を正規化するかどうかを示す値を取得または設定します。Gets or sets a value indicating whether to normalize line breaks in the output.

public:
 property System::Xml::NewLineHandling NewLineHandling { System::Xml::NewLineHandling get(); void set(System::Xml::NewLineHandling value); };
public System.Xml.NewLineHandling NewLineHandling { get; set; }
member this.NewLineHandling : System.Xml.NewLineHandling with get, set
Public Property NewLineHandling As NewLineHandling

プロパティ値

NewLineHandling 値のいずれか 1 つ。One of the NewLineHandling values. 既定値は、Replace です。The default is Replace.

注釈

この設定は、テキストの内容または属性値を書き込むときに適用されます。This setting applies when writing text content or attribute values. それぞれの値NewLineHandlingについて以下に説明します。Each of the NewLineHandling values is described below:

  • この設定によりXmlWriter 、は、文字エンティティを使用した正規化XmlReaderによって保存されない新しい行文字を置き換えるようにに指示します。 EntitizeThe Entitize setting tells the XmlWriter to replace new line characters that would not be otherwise preserved by a normalizing XmlReader with character entities. これは、正規化XmlReaderによって出力が読み込まれるラウンドトリップシナリオで役立ちます。This is useful in round-trip scenarios where the output is read by a normalizing XmlReader. から\t \r のラウンドXmlReaderトリップ時の属性値には、追加の正規化規則が適用されます。また、で正規化された場合、属性値のスペースで置き換えられます。\nAdditional normalization rules apply for attribute values when round tripping since \t, \n and \r are replaced with a space in attribute values when normalized in an XmlReader.

  • このReplace設定は、 XmlWriter新しい行文字を Microsoft Windows \r\nオペレーティングシステムで使用される新しい行形式と置き換えるようにに指示します。The Replace setting tells the XmlWriter to replace new line characters with \r\n, which is the new line format used by the Microsoft Windows operating system. これにより、メモ帳または Microsoft Word アプリケーションによってファイルが正しく表示されるようになります。This helps to ensure that the file can be correctly displayed by the Notepad or Microsoft Word applications. また、この設定により、属性の新しい行が文字エンティティに置き換えられ、文字が保持されます。This setting also replaces new lines in attributes with character entities to preserve the characters. これが既定値です。This is the default value.

  • 設定Noneは、 XmlWriter入力を変更せずに残すようにに指示します。The None setting tells the XmlWriter to leave the input unchanged. この設定は、改行処理が不要な場合に使用します。This setting is used when you do not want any new-line processing. これは、正規化を行わない (たとえばXmlReader XmlTextReader 、既定の設定を持つ) によって出力が読み込まれる場合に便利です。This is useful when the output is read by an XmlReader that does not do any normalization (for example, an XmlTextReader with default settings.)

次の表は、 WriteString NewLineHandlingプロパティの設定に応じて、入力値が指定された場合のメソッドの出力を示しています。The following tables show the output of the WriteString method when supplied with the input value depending on the NewLineHandling property setting. これらの表は、テキストコンテンツの書き込み時と属性値の書き込み時の出力を示しています。The tables show the output when writing text content and also when writing an attribute value.

Text Node Value:

\r\n\r\n \n\n \r\r \t\t
含まれるEntitize & #D; \n&#D;\n \n\n & #D;&#D; \t\t
ReplaceReplace \r\n\r\n \r\n\r\n \r\n\r\n \t\t
NoneNone \r\n\r\n \n\n \r\r \t\t

Attribute Value:

\r\n\r\n \n\n \r\r \t\t
含まれるEntitize & #D; & #A;&#D;&#A; & #A;&#A; & #D;&#D; 		
ReplaceReplace & #D; & #A;&#D;&#A; & #A;&#A; & #D;&#D; 		
NoneNone \r\n\r\n \n\n \r\r \t\t

注意

XmlWriter 、CDATA セクション、コメント、または処理命令内にコンテンツを書き込むときに、次の動作をします。The XmlWriter has the following behavior when writing content within a CDATA section, comment, or processing instruction. NewLineHandlingプロパティがにEntitize設定されている場合でも、新しい行は文字エンティティには置き換えられません。New lines are never replaced with their character entities, even when the NewLineHandling property is set to Entitize. これは、文字エンティティが CDATA セクション、コメント、または処理命令で認識されないためです。This is because character entities are not recognized in CDATA sections, comments or processing instructions. プロパティがまたはNone Replaceに設定されている場合、動作はテキストノードの値を書き込む場合と同じです。 NewLineHandlingIf the NewLineHandling property is set to None or Replace, the behavior is the same as when writing a text node value.

次の表では、各XmlReader空白文字の入力に対して正規化が返す内容について説明します。The following table describes what a normalizing XmlReader returns for each white space input. 詳細については、W3C 勧告『 XML 1.0 』の2.11 および3.3.3 のセクションを参照してください。For more information, see sections 2.11 and 3.3.3 of the W3C XML 1.0 Recommendation.

注意

標準化されたリーダー XmlReaderは、 XmlReader.Createメソッドによって作成された任意のオブジェクトです。A normalizing reader is any XmlReader object created by the XmlReader.Create method. これらのオブジェクトは、常に改行の正規化と属性の完全な正規化を実行します。These objects always perform line break normalization and full normalization of attributes. プロパティがXmlTextReadertrue設定されている場合は、オブジェクトを正規化されたリーダーにすることもNormalizationできます。The XmlTextReader object can also be a normalizing reader if it's Normalization property is set to true.

\r\n\r\n \n\n \r\r \t\t
テキストノードの値Text Node Value \n\n \n\n \n\n \t\t
属性の値Attribute Value 1つのスペースsingle space 1つのスペースsingle space 1つのスペースsingle space 1つのスペースsingle space

適用対象