XmlWriterSettings クラス

定義

XmlWriter メソッドで作成された Create オブジェクトでサポートする一連の機能を指定します。Specifies a set of features to support on the XmlWriter object created by the Create method.

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

次の例では、XML ファイルに書き込む XmlWriter を作成し、各属性を新しい行に書き込みます。The following example creates an XmlWriter that writes to an XML file and writes each attribute on a new line.

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

このサンプルでは、次の出力が生成されます。The sample produces the following output:

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

注釈

Create メソッドは、XmlWriter インスタンスを取得するために推奨されるメカニズムです。The Create method is the preferred mechanism for obtaining XmlWriter instances. Create メソッドは、XmlWriterSettings クラスを使用して、作成される XmlWriter オブジェクトに実装する機能を指定します。The Create method uses the XmlWriterSettings class to specify which features to implement in the XmlWriter object that is created.

注意

Transform メソッドで XmlWriter オブジェクトを使用している場合は、OutputSettings プロパティを使用して、正しい設定の XmlWriterSettings オブジェクトを取得する必要があります。If you're using the XmlWriter object with the Transform method, you should use the OutputSettings property to obtain an XmlWriterSettings object with the correct settings. これにより、作成された XmlWriter オブジェクトに正しい出力設定が適用されます。This ensures that the created XmlWriter object has the correct output settings.

XmlWriterSettings クラスには、データの一致と出力形式を制御するプロパティが用意されています。The XmlWriterSettings class provides properties that control data conformance and output format.

データの一致チェックと自動修正の場合は、次のプロパティを使用します。For data conformance checks and auto-corrections, use these properties:

プロパティProperty 指定対象Specifies Value DefaultDefault
CheckCharacters W3C によって定義されているように、文字が有効な XML 文字セットに含まれているかどうかを確認するかどうか。Whether to check that characters are in the legal XML character set, as defined by W3C. true または falsetrue or false true
ConformanceLevel 出力が整形式の XML 1.0 ドキュメントまたはフラグメントであるかどうかをチェックするかどうか。Whether to check that output is a well-formed XML 1.0 document or fragment. ConformanceLevel.Document (ドキュメントレベル)、Fragment (フラグメントレベル)、または Auto (自動検出)ConformanceLevel.Document (document-level), Fragment (fragment-level), or Auto (auto-detection) ConformanceLevel.Document (ドキュメントレベルの一致)ConformanceLevel.Document (document-level conformance)
WriteEndDocumentOnClose Close メソッドが呼び出されたときに、閉じていないすべての要素に終了タグを追加するかどうかを指定します。Whether to add closing tags to all unclosed elements when the Close method is called. true または falsetrue or false true

出力形式を指定するには、次のプロパティを使用します。To specify output format, use these properties:

プロパティProperty 指定対象Specifies Value DefaultDefault
Encoding 使用するテキストエンコーディング。Text encoding to use. System.Text.EncodingSystem.Text.Encoding value Encoding.UTF8
Indent 要素にインデントを指定するかどうかWhether to indent elements true または falsetrue or false false (インデントなし)false (no indentation)
IndentChars インデント時に使用する文字列。 Indenttrueに設定されている場合に使用します。Character string to use when indenting (used when Indent is set to true). StringString 2 つのスペースTwo spaces
NewLineChars 改行に使用する文字列。Character string to use for line breaks. StringString \r\n (キャリッジリターン、ラインフィード)\r\n (carriage return, line feed)
NewLineHandling 改行文字を処理する方法。How to handle newline characters. System.Xml.NewLineHandling 値: Entitize (正規化)、Replace (置換)、または None (変更なしのまま)System.Xml.NewLineHandling value: Entitize (normalize), Replace (replace), or None (leave unchanged) Replace (NewLineCharsで指定された文字に置き換える)Replace (replace with characters specified by NewLineChars)
NewLineOnAttributes 個々の行に属性を書き込むかどうかを指定します (Indentfalseの場合は効果がありません)。Whether to write attributes on individual lines (has no effect when Indent is false). true または falsetrue or false false
OmitXmlDeclaration XML 宣言を書き込むかどうかを指定します。Whether to write an XML declaration. true または falsetrue or false false

コンストラクター

XmlWriterSettings()

XmlWriterSettings クラスの新しいインスタンスを初期化します。Initializes a new instance of the XmlWriterSettings class.

プロパティ

Async

非同期 XmlWriter メソッドを XmlWriter の特定のインスタンスで使用できるかどうかを示す値を取得または設定します。Gets or sets a value that indicates whether asynchronous XmlWriter methods can be used on a particular XmlWriter instance.

CheckCharacters

ドキュメント内のすべての文字が W3C の「XML 1.0 Recommendation」(XML 1.0 勧告) の「2.2 Characters」(2.2 文字) に準拠していることを XML ライターがチェックする必要があるかどうかを示す値を取得または設定します。Gets or sets a value that indicates whether the XML writer should check to ensure that all characters in the document conform to the "2.2 Characters" section of the W3C XML 1.0 Recommendation.

CloseOutput

XmlWriter メソッドを呼び出したときに、TextWriter が、基になるストリームまたは Close() も閉じる必要があるかどうかを示す値を取得または設定します。Gets or sets a value indicating whether the XmlWriter should also close the underlying stream or TextWriter when the Close() method is called.

ConformanceLevel

XML ライターが XML 出力をチェックする準拠のレベルを取得または設定します。Gets or sets the level of conformance that the XML writer checks the XML output for.

DoNotEscapeUriAttributes

XmlWriter が URI 属性をエスケープしないかどうかを示す値を取得または設定します。Gets or sets a value that indicates whether the XmlWriter does not escape URI attributes.

Encoding

使用するテキスト エンコーディングの種類を取得または設定します。Gets or sets the type of text encoding to use.

Indent

要素にインデントを設定するかどうかを示す値を取得または設定します。Gets or sets a value indicating whether to indent elements.

IndentChars

インデント処理を行うときに使用する文字列を取得または設定します。Gets or sets the character string to use when indenting. この設定は、Indent プロパティが true に設定されている場合に使用します。This setting is used when the Indent property is set to true.

NamespaceHandling

XML コンテンツの書き込み時に、重複する名前空間宣言を XmlWriter で削除するかどうかを示す値を取得または設定します。Gets or sets a value that indicates whether the XmlWriter should remove duplicate namespace declarations when writing XML content. 既定の動作では、ライターの名前空間リゾルバーに存在するすべての名前空間宣言がライターによって出力されます。The default behavior is for the writer to output all namespace declarations that are present in the writer's namespace resolver.

NewLineChars

改行に使用する文字列を取得または設定します。Gets or sets the character string to use for line breaks.

NewLineHandling

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

NewLineOnAttributes

新しい行に属性を書き込むかどうかを示す値を取得または設定します。Gets or sets a value indicating whether to write attributes on a new line.

OmitXmlDeclaration

XML 宣言を省略するかどうかを示す値を取得または設定します。Gets or sets a value indicating whether to omit an XML declaration.

OutputMethod

XmlWriter 出力をシリアル化するために使用するメソッドを取得します。Gets the method used to serialize the XmlWriter output.

WriteEndDocumentOnClose

XmlWriter メソッドが呼び出されるときに Close() がすべての閉じられていない要素タグに終了タグを追加するかどうかを示す値を取得または設定します。Gets or sets a value that indicates whether the XmlWriter will add closing tags to all unclosed element tags when the Close() method is called.

メソッド

Clone()

XmlWriterSettings インスタンスのコピーを作成します。Creates a copy of the XmlWriterSettings instance.

Equals(Object)

指定したオブジェクトが、現在のオブジェクトと等しいかどうかを判断します。Determines whether the specified object is equal to the current object.

(継承元 Object)
GetHashCode()

既定のハッシュ関数として機能します。Serves as the default hash function.

(継承元 Object)
GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(継承元 Object)
MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(継承元 Object)
Reset()

設定クラスのメンバーを既定値にリセットします。Resets the members of the settings class to their default values.

ToString()

現在のオブジェクトを表す文字列を返します。Returns a string that represents the current object.

(継承元 Object)

適用対象