XmlWriterSettings.IndentChars Property

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Gets or sets the character string to use when indenting. This setting is used when the Indent property is set to true.

Namespace:  System.Xml
Assembly:  System.Xml (in System.Xml.dll)

Syntax

'Declaration
Public Property IndentChars As String
public string IndentChars { get; set; }

Property Value

Type: System.String
The character string to use when indenting. This can be set to any string value. However, to ensure valid XML, you should specify only valid white space characters, such as space characters, tabs, carriage returns, or line feeds. The default is two spaces.

Exceptions

Exception Condition
ArgumentNullException

The value assigned to the IndentChars is nulla null reference (Nothing in Visual Basic).

Remarks

This property only applies to XmlWriter instances that output text content; otherwise, this setting is ignored. The XmlWriter throws an exception if the indent characters would result in invalid XML.

For more information and code examples, see XML Data.

Examples

Dim output As New StringBuilder()

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

' Create the XmlWriter object and write some content.
Using writer As XmlWriter = XmlWriter.Create(output, settings)
    writer.WriteStartElement("book")
    writer.WriteElementString("item", "tesing")
    writer.WriteEndElement()

    writer.Flush()
End Using
OutputTextBlock.Text = output.ToString()
StringBuilder output = new StringBuilder();

// 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.
using (XmlWriter writer = XmlWriter.Create(output, settings))
{
    writer.WriteStartElement("book");
    writer.WriteElementString("item", "tesing");
    writer.WriteEndElement();

    writer.Flush();
}
OutputTextBlock.Text = output.ToString();

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.