System.Xml Namespace


.NET Framework Class Library
XmlWriterSettings Class

Specifies a set of features to support on the XmlWriter object created by the XmlWriter..::.Create method.

Namespace:  System.Xml
Assembly:  System.Xml (in System.Xml.dll)
Syntax
Visual Basic (Declaration) 
Public NotInheritable Class XmlWriterSettings
Visual Basic (Usage) 
Dim instance As XmlWriterSettings
C# 
public sealed class XmlWriterSettings
Visual C++ 
public ref class XmlWriterSettings sealed
JScript 
public final class XmlWriterSettings
Remarks

In the Microsoft .NET Framework 2.0 release, the Create method is the preferred mechanism for obtaining XmlWriter instances. The Create method uses the XmlWriterSettings class to specify which features to implement in the created XmlWriter object.

NoteNote:

If the XmlWriter is being used with the Transform method, you should use the OutputSettings property to obtain an XmlWriterSettings object with the correct settings. This ensures that the created XmlWriter object has the correct output settings.

For more information, see Creating XML Writers.
Examples

The following example creates an XmlWriter that writes to an XML file and writes each attribute on a new line.

Visual Basic 
Dim settings As XmlWriterSettings = New XmlWriterSettings()
settings.Indent = true
settings.OmitXmlDeclaration = true
settings.NewLineOnAttributes = true

writer = XmlWriter.Create(Console.Out, settings)

writer.WriteStartElement("order")
writer.WriteAttributeString("orderID", "367A54")
writer.WriteAttributeString("date", "2001-05-03")
writer.WriteElementString("price", "19.95")
writer.WriteEndElement()
    
writer.Flush()
C# 
XmlWriterSettings settings = new XmlWriterSettings();
settings.Indent = true;
settings.OmitXmlDeclaration = true;
settings.NewLineOnAttributes = true;

writer = XmlWriter.Create(Console.Out, settings);

writer.WriteStartElement("order");
writer.WriteAttributeString("orderID", "367A54");
writer.WriteAttributeString("date", "2001-05-03");
writer.WriteElementString("price", "19.95");
writer.WriteEndElement();
    
writer.Flush();

The sample produces the following output:

<order
  orderID="367A54"
  date="2001-05-03">
  <price>19.95</price>
</order>
Inheritance Hierarchy
System..::.Object
  System.Xml..::.XmlWriterSettings
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0

.NET Compact Framework

Supported in: 3.5, 2.0

XNA Framework

Supported in: 3.0, 2.0, 1.0
See Also

Reference

XmlWriterSettings Members
System.Xml Namespace
Tags :


Page view tracker