XmlWriterSettings.Indent プロパティとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

XmlWriterSettings.Indent プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

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

名前空間: System.Xml
アセンブリ: System.Xml (system.xml.dll 内)
構文

Visual Basic (宣言)

Public Property Indent As
 Boolean

Visual Basic (使用法)

Dim instance As XmlWriterSettings
Dim value As Boolean

value = instance.Indent

instance.Indent = value

public bool Indent { get;
 set; }

C++

public:
property bool Indent {
    bool get ();
    void set (bool value);
}

/** @property */
public boolean get_Indent ()

/** @property */
public void set_Indent (boolean value)

JScript

public function get Indent
 () : boolean

public function set Indent
 (value : boolean)

プロパティ値
各要素を新しい行に書き込んでインデントを設定する場合は true。それ以外の場合は false。既定値は false です。

解説

このプロパティは、テキストの内容を出力する、XmlWriter のインスタンスにのみ適用されます。それ以外の場合、この設定は無視されます。

要素に混合コンテンツが含まれていない場合は、要素にインデントが設定されます。WriteString メソッドまたは WriteWhitespace メソッドを呼び出して混合された要素の内容を書き込むと、XmlWriter によってインデント処理が停止されます。混合コンテンツ要素を閉じると、インデント処理が再開されます。

使用例

インデントにタブ文字を使用する XmlWriter オブジェクトを作成する例を次に示します。

Visual Basic

Imports System
Imports System.IO
Imports System.Xml
Imports System.Text
Imports Microsoft.VisualBasic

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

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