XmlWriterSettings.IndentChars Propriedade

Definição

Namespace:

System.Xml

Assembly:

System.Xml.ReaderWriter.dll

Origem:

XmlWriterSettings.cs

Especifica ou define a cadeia de caracteres a ser usada ao recuar. Esta configuração é usada quando a propriedade Indent for definida como 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

Valor da propriedade

String

A cadeia de caracteres a ser usada ao recuar. Isso pode ser definido para qualquer valor de cadeia de caracteres. No entanto, para garantir um XML válido, você deve especificar somente caracteres de espaço em branco válidos, como caracteres de espaço, tabulações, retornos de carro ou alimentações de linha. O padrão é os dois espaços.

Exceções

ArgumentNullException

O valor atribuído ao IndentChars é null.

Exemplos

O exemplo a seguir cria um XmlWriter objeto que usa o caractere TAB para recuo.

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

Comentários

Essa propriedade só se aplica a XmlWriter instâncias que geram conteúdo de texto; caso contrário, essa configuração é ignorada. O XmlWriter gera uma exceção se os caracteres de recuo resultarem em XML inválido.