XmlWriter.Settings Property

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

Gets the XmlWriterSettings object used to create this XmlWriter instance.

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

Syntax

'Declaration
Public Overridable ReadOnly Property Settings As XmlWriterSettings
public virtual XmlWriterSettings Settings { get; }

Property Value

Type: System.Xml.XmlWriterSettings
The XmlWriterSettings object used to create this writer instance. If this writer was not created using the Create method, this property returns nulla null reference (Nothing in Visual Basic).

Remarks

The XmlWriterSettings class is used to specify the set of features to support on the created writer instance. The XmlWriterSettings object returned by the Settings property cannot be modified. Any attempt to change individual settings results in an exception being thrown.

Examples

Dim settings As New XmlWriterSettings()
settings.OmitXmlDeclaration = True
Dim sw As New StringWriter()

Using writer As XmlWriter = XmlWriter.Create(sw, settings)
    writer.WriteStartElement("book")
    writer.WriteElementString("price", "19.95")
    writer.WriteEndElement()
    writer.Flush()
End Using

OutputTextBlock.Text = sw.ToString()

XmlWriterSettings settings = new XmlWriterSettings();
settings.OmitXmlDeclaration = true;
StringWriter sw = new StringWriter();

using (XmlWriter writer = XmlWriter.Create(sw, settings))
{
    writer.WriteStartElement("book");
    writer.WriteElementString("price", "19.95");
    writer.WriteEndElement();
    writer.Flush();
}

OutputTextBlock.Text = sw.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.