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)

System.Object
  System.Xml.XmlWriterSettings

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

NameDescription
System_CAPS_pubmethodXmlWriterSettings()

Initializes a new instance of the XmlWriterSettings class.

NameDescription
System_CAPS_pubpropertyAsync

Gets or sets a value that indicates whether asynchronous XmlWriter methods can be used on a particular XmlWriter instance.

System_CAPS_pubpropertyCheckCharacters

Gets or sets a value that indicates whether the XML writer should check to ensure that all characters in the document conform to the "2.2 Characters" section of the W3C XML 1.0 Recommendation.

System_CAPS_pubpropertyCloseOutput

Gets or sets a value indicating whether the XmlWriter should also close the underlying stream or TextWriter when the Close method is called.

System_CAPS_pubpropertyConformanceLevel

Gets or sets the level of conformance that the XML writer checks the XML output for.

System_CAPS_pubpropertyDoNotEscapeUriAttributes

Gets or sets a value that indicates whether the XmlWriter does not escape URI attributes.

System_CAPS_pubpropertyEncoding

Gets or sets the type of text encoding to use.

System_CAPS_pubpropertyIndent

Gets or sets a value indicating whether to indent elements.

System_CAPS_pubpropertyIndentChars

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

System_CAPS_pubpropertyNamespaceHandling

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.

System_CAPS_pubpropertyNewLineChars

Gets or sets the character string to use for line breaks.

System_CAPS_pubpropertyNewLineHandling

Gets or sets a value indicating whether to normalize line breaks in the output.

System_CAPS_pubpropertyNewLineOnAttributes

Gets or sets a value indicating whether to write attributes on a new line.

System_CAPS_pubpropertyOmitXmlDeclaration

Gets or sets a value indicating whether to omit an XML declaration.

System_CAPS_pubpropertyOutputMethod

Gets the method used to serialize the XmlWriter output.

System_CAPS_pubpropertyWriteEndDocumentOnClose

Gets or sets a value that indicates whether the XmlWriter will add closing tags to all unclosed element tags when the Close method is called.

NameDescription
System_CAPS_pubmethodClone()

Creates a copy of the XmlWriterSettings instance.

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodReset()

Resets the members of the settings class to their default values.

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

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 XmlWriter object that is created.

System_CAPS_noteNote

If you're using the XmlWriter object 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.

The XmlWriterSettings class provides properties that control data conformance and output format.

For data conformance checks and auto-corrections, use these properties:

Property

Specifies

Value

Default

CheckCharacters

Whether to check that characters are in the legal XML character set, as defined by W3C.

true or false

true

ConformanceLevel

Whether to check that output is a well-formed XML 1.0 document or fragment.

ConformanceLevel.Document (document-level), Fragment (fragment-level), or Auto (auto-detection)

ConformanceLevel.Document (document-level conformance)

WriteEndDocumentOnClose

Whether to add closing tags to all unclosed elements when the Close method is called.

true or false

true

To specify output format, use these properties:

Property

Specifies

Value

Default

Encoding

Text encoding to use.

System.Text.Encoding value

Encoding.UTF8

Indent

Whether to indent elements

true or false

false (no indentation)

IndentChars

Character string to use when indenting (used when Indent is set to true).

String

Two spaces

NewLineChars

Character string to use for line breaks.

String

\r\n (carriage return, line feed)

NewLineHandling

How to handle newline characters.

System.Xml.NewLineHandling value: Entitize (normalize), Replace (replace), or None (leave unchanged)

Replace (replace with characters specified by NewLineChars)

NewLineOnAttributes

Whether to write attributes on individual lines (has no effect when Indent is false).

true or false

false

OmitXmlDeclaration

Whether to write an XML declaration.

true or false

false

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

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>

Universal Windows Platform
Available since 8
.NET Framework
Available since 2.0
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: