1 out of 1 rated this helpful Rate this topic

XmlWriterSettings Class

.NET Framework 4

Other Versions

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

Inheritance Hierarchy

System.Object
System.Xml.XmlWriterSettings

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

Syntax

C++

Copy

[PermissionSetAttribute(SecurityAction.InheritanceDemand, Name = "FullTrust")]
public sealed class XmlWriterSettings

The XmlWriterSettings type exposes the following members.

Constructors

	Name	Description
	XmlWriterSettings	Initializes a new instance of the XmlWriterSettings class.

Top

Properties

	Name	Description
	CheckCharacters	Gets or sets a value indicating whether to do character checking.
	CloseOutput	Gets or sets a value indicating whether the XmlWriter should also close the underlying stream or TextWriter when the Close method is called.
	ConformanceLevel	Gets or sets the level of conformance which the XmlWriter complies with.
	Encoding	Gets or sets the type of text encoding to use.
	Indent	Gets or sets a value indicating whether to indent elements.
	IndentChars	Gets or sets the character string to use when indenting. This setting is used when the Indent property is set to true.
	NamespaceHandling	Gets or sets a value that indicates whether the XmlWriter should remove duplicate namespace declarations when writing XML content. The default behavior is for the writer to output all namespace declarations that are present in the writer's namespace resolver.
	NewLineChars	Gets or sets the character string to use for line breaks.
	NewLineHandling	Gets or sets a value indicating whether to normalize line breaks in the output.
	NewLineOnAttributes	Gets or sets a value indicating whether to write attributes on a new line.
	OmitXmlDeclaration	Gets or sets a value indicating whether to write an XML declaration.
	OutputMethod	Gets the method used to serialize the XmlWriter output.

Top

Methods

	Name	Description
	Clone	Creates a copy of the XmlWriterSettings instance.
	Equals(Object)	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Reset	Resets the members of the settings class to their default values.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

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.

Note
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.

Copy


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:

Copy

<order
  orderID="367A54"
  date="2001-05-03">
  <price>19.95</price>
</order>

Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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.

Reference

System.Xml Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(2000 characters remaining)

Community Content Add

FAQ

Sample Using PowerShell

<#
.SYNOPSIS
    This script uses XMLWriter to write XML
.DESCRIPTION
    This script creates and XML writer and writes some basic
    XML.
.NOTES
    File Name  : Write-XML.ps1
    Author     : Thomas Lee - tfl@psp.co.uk
    Requires   : PowerShell Version 2.0
.LINK
    This script posted to:
        http://www.pshscripts.blogspot.com
    MSDN Sample posted at:
       http://msdn.microsoft.com/en-us/library/system.xml.xmlwritersettings.aspx
.EXAMPLE
    PSH [C:\foo]: .\Write-XML.ps1'
    <?xml version="1.0" encoding="IBM437"?>
    <order
      orderID="367A54"
      date="2001-05-03">
      <price>19.95</price>
    </order>PSH [C:\foo]:
#>

# Create a new writer settings object
# And set settings
$settings = New-Object system.Xml.XmlWriterSettings
$settings.Indent = $true
$settings.OmitXmlDeclaration = $false
$settings.NewLineOnAttributes = $true

# Create a new Writer
$writer = [system.xml.XmlWriter]::Create([system.console]::Out, $settings)

#Write some XML
$writer.WriteStartElement("order")
$writer.WriteAttributeString("orderID", "367A54")
$writer.WriteAttributeString("date", "2001-05-03")
$writer.WriteElementString("price", "19.95")
$writer.WriteEndElement() 

# Flush the writer (and close the file)    
$writer.Flush()

History

5/21/2010
Thomas Lee