XmlWriterSettings クラス

  • リファレンス

定義

名前空間:
System.Xml
アセンブリ:
System.Xml.ReaderWriter.dll
アセンブリ:
System.Xml.dll
アセンブリ:
netstandard.dll

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

public ref class XmlWriterSettings sealed
public sealed class XmlWriterSettings
type XmlWriterSettings = class
Public NotInheritable Class XmlWriterSettings
継承
Object
XmlWriterSettings

例

次の例では、 XmlWriter XML ファイルに書き込み、各属性を新しい行に書き込む方法を作成します。

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();

        Dim settings As 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>

注釈

この Create 方法は、インスタンスを取得 XmlWriter するための推奨されるメカニズムです。 このメソッドは Create 、クラスを XmlWriterSettings 使用して、作成されるオブジェクトに実装する機能を XmlWriter 指定します。

注意

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

このクラスは XmlWriterSettings 、データの準拠と出力形式を制御するプロパティを提供します。

データ準拠チェックと自動修正の場合は、次のプロパティを使用します。

プロパティ 指定内容 値 Default
CheckCharacters W3C で定義されている有効な XML 文字セットに文字があるかどうかを確認するかどうか。 true または false true
ConformanceLevel 出力が整形式の XML 1.0 ドキュメントかフラグメントかを確認するかどうか。 ConformanceLevel.Document (ドキュメント レベル)、 Fragment (フラグメント レベル)、または Auto (自動検出) ConformanceLevel.Document (ドキュメント レベルの準拠)
WriteEndDocumentOnClose メソッドの呼び出し時に閉じられていないすべての要素に終了タグを Close 追加するかどうか。 true または false true

出力形式を指定するには、次のプロパティを使用します。

プロパティ 指定内容 値 Default
Encoding 使用するテキスト エンコード。 System.Text.Encoding 値 Encoding.UTF8
Indent 要素をインデントするかどうか true または false false (インデントなし)
IndentChars インデント時に使用する文字列 (に設定されている場合 Indent に true使用)。 String 2 つのスペース
NewLineChars 改行に使用する文字列。 String \r\n (キャリッジ リターン、ライン フィード)
NewLineHandling 改行文字を処理する方法。 System.Xml.NewLineHandling 値: Entitize (正規化)、 Replace (置換)、または None (変更せずに残す) Replace (で指定された NewLineChars文字に置き換えます)
NewLineOnAttributes 個々の行に属性を書き込むかどうか (ある場合 Indent は false影響しません)。 true または false false
OmitXmlDeclaration XML 宣言を記述するかどうか。 true または false false

コンストラクター

XmlWriterSettings()

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

プロパティ

Async

非同期 XmlWriter メソッドを XmlWriter の特定のインスタンスで使用できるかどうかを示す値を取得または設定します。
CheckCharacters

ドキュメント内のすべての文字が W3C の「XML 1.0 Recommendation」(XML 1.0 勧告) の「2.2 Characters」(2.2 文字) に準拠していることを XML ライターがチェックする必要があるかどうかを示す値を取得または設定します。
CloseOutput

XmlWriter メソッドを呼び出したときに、TextWriter が、基になるストリームまたは Close() も閉じる必要があるかどうかを示す値を取得または設定します。
ConformanceLevel

XML ライターが XML 出力をチェックする準拠のレベルを取得または設定します。
DoNotEscapeUriAttributes

XmlWriter が URI 属性をエスケープしないかどうかを示す値を取得または設定します。
Encoding

使用するテキスト エンコーディングの種類を取得または設定します。
Indent

要素にインデントを設定するかどうかを示す値を取得または設定します。
IndentChars

インデント処理を行うときに使用する文字列を取得または設定します。 この設定は、Indent プロパティが true に設定されている場合に使用します。
NamespaceHandling

XML コンテンツの書き込み時に、重複する名前空間宣言を XmlWriter で削除するかどうかを示す値を取得または設定します。 既定の動作では、ライターの名前空間リゾルバーに存在するすべての名前空間宣言がライターによって出力されます。
NewLineChars

改行に使用する文字列を取得または設定します。
NewLineHandling

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

新しい行に属性を書き込むかどうかを示す値を取得または設定します。
OmitXmlDeclaration

XML 宣言を省略するかどうかを示す値を取得または設定します。
OutputMethod

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

XmlWriter メソッドが呼び出されるときに Close() がすべての閉じられていない要素タグに終了タグを追加するかどうかを示す値を取得または設定します。

メソッド

Clone()

XmlWriterSettings インスタンスのコピーを作成します。
Equals(Object)

指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判断します。

(継承元 Object)
GetHashCode()

既定のハッシュ関数として機能します。

(継承元 Object)
GetType()

現在のインスタンスの Type を取得します。

(継承元 Object)
MemberwiseClone()

現在の Object の簡易コピーを作成します。

(継承元 Object)
Reset()

設定クラスのメンバーを既定値にリセットします。
ToString()

現在のオブジェクトを表す文字列を返します。

(継承元 Object)

適用対象