XmlWriterSettings.IndentChars プロパティ

  • リファレンス

定義

名前空間:
System.Xml
アセンブリ:
System.Xml.ReaderWriter.dll
アセンブリ:
System.Xml.dll
アセンブリ:
netstandard.dll
ソース:
XmlWriterSettings.cs
ソース:
XmlWriterSettings.cs
ソース:
XmlWriterSettings.cs

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

public:
 property System::String ^ IndentChars { System::String ^ get(); void set(System::String ^ value); };
public string IndentChars { get; set; }
member this.IndentChars : string with get, set
Public Property IndentChars As String

プロパティ値

String

インデント処理を行うときに使用する文字列。 これには任意の文字列値を設定できます。 ただし、有効な XML にするには、空白、タブ、復帰、ライン フィードなどの有効な空白文字だけを指定する必要があります。 既定値は 2 つのスペースです。

例外

ArgumentNullException

IndentChars に代入された値が null です。

例

次の例では、インデントに XmlWriter TAB 文字を使用する オブジェクトを作成します。

using System;
using System.IO;
using System.Xml;
using System.Text;

public class Sample {

  public static void Main() {

    XmlWriter writer = null;

    try {

       // Create an XmlWriterSettings object with the correct options.
       XmlWriterSettings settings = new XmlWriterSettings();
       settings.Indent = true;
       settings.IndentChars = ("\t");
       settings.OmitXmlDeclaration = true;

       // Create the XmlWriter object and write some content.
       writer = XmlWriter.Create("data.xml", settings);
       writer.WriteStartElement("book");
       writer.WriteElementString("item", "tesing");
       writer.WriteEndElement();
    
       writer.Flush();
     }
     finally  {
        if (writer != null)
          writer.Close();
     }
  }
}

Imports System.IO
Imports System.Xml
Imports System.Text

Public Class Sample 

  Public Shared Sub Main() 
  
    Dim writer As XmlWriter = Nothing

    Try 

       ' Create an XmlWriterSettings object with the correct options. 
       Dim settings As XmlWriterSettings = New XmlWriterSettings()
       settings.Indent = true
       settings.IndentChars = (ControlChars.Tab)
       settings.OmitXmlDeclaration = true

       ' Create the XmlWriter object and write some content.
       writer = XmlWriter.Create("data.xml", settings)
       writer.WriteStartElement("book")
       writer.WriteElementString("item", "tesing")
       writer.WriteEndElement()
    
       writer.Flush()

      Finally
         If Not (writer Is Nothing) Then
            writer.Close()
         End If
      End Try

   End Sub 
End Class

注釈

このプロパティは、テキスト コンテンツを XmlWriter 出力するインスタンスにのみ適用されます。それ以外の場合、この設定は無視されます。 インデント文字が無効な XML になる場合、 は XmlWriter 例外をスローします。

適用対象