XmlWriterSettings XmlWriterSettings XmlWriterSettings XmlWriterSettings Class

定義

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
継承
XmlWriterSettingsXmlWriterSettingsXmlWriterSettingsXmlWriterSettings

次の例ではXmlWriter 、XML ファイルへの書き込みを行い、各属性を新しい行に書き込むを作成します。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 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()

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

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

注釈

インスタンスを取得XmlWriterするには、メソッドを使用することをお勧めします。CreateThe 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.

注意

メソッドを使用してXmlWriterオブジェクトOutputSettings XmlWriterSettingsを使用している場合は、プロパティを使用して、正しい設定のオブジェクトを取得する必要があります。 TransformIf 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 既定値Default
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 既定値Default
Encoding 使用するテキストエンコーディング。Text encoding to use. System.Text.Encoding の値System.Text.Encoding value Encoding.UTF8
Indent 要素にインデントを指定するかどうかWhether to indent elements true または falsetrue or false false(インデントなし)false (no indentation)
IndentChars をインデントするときに使用する文字列。 Indentがにtrue設定されている場合に使用します。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() XmlWriterSettings() XmlWriterSettings()

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

プロパティ

Async Async Async Async

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

CheckCharacters CheckCharacters CheckCharacters 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 CloseOutput CloseOutput 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 ConformanceLevel ConformanceLevel ConformanceLevel

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

DoNotEscapeUriAttributes DoNotEscapeUriAttributes DoNotEscapeUriAttributes DoNotEscapeUriAttributes

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

Encoding Encoding Encoding Encoding

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

Indent Indent Indent Indent

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

IndentChars IndentChars IndentChars 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 NamespaceHandling NamespaceHandling 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 NewLineChars NewLineChars NewLineChars

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

NewLineHandling NewLineHandling NewLineHandling NewLineHandling

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

NewLineOnAttributes NewLineOnAttributes NewLineOnAttributes NewLineOnAttributes

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

OmitXmlDeclaration OmitXmlDeclaration OmitXmlDeclaration OmitXmlDeclaration

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

OutputMethod OutputMethod OutputMethod OutputMethod

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

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

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

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

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

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

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

(Inherited from Object)
GetType() GetType() GetType() GetType()

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

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

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

(Inherited from Object)
Reset() Reset() Reset() Reset()

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

ToString() ToString() ToString() ToString()

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

(Inherited from Object)

適用対象