Export (0) Print
Expand All

XmlWriterSettings Class

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

System.Object
  System.Xml.XmlWriterSettings

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

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

The XmlWriterSettings type exposes the following members.

  NameDescription
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryXmlWriterSettingsInitializes a new instance of the XmlWriterSettings class.
Top

  NameDescription
Public propertySupported by the XNA FrameworkSupported by Portable Class LibraryCheckCharactersGets or sets a value indicating whether to do character checking.
Public propertySupported by the XNA FrameworkSupported by Portable Class LibraryCloseOutputGets or sets a value indicating whether the XmlWriter should also close the underlying stream or TextWriter when the Close method is called.
Public propertySupported by the XNA FrameworkSupported by Portable Class LibraryConformanceLevelGets or sets the level of conformance which the XmlWriter complies with.
Public propertySupported by the XNA FrameworkSupported by Portable Class LibraryEncodingGets or sets the type of text encoding to use.
Public propertySupported by the XNA FrameworkSupported by Portable Class LibraryIndentGets or sets a value indicating whether to indent elements.
Public propertySupported by the XNA FrameworkSupported by Portable Class LibraryIndentCharsGets or sets the character string to use when indenting. This setting is used when the Indent property is set to true.
Public propertyNamespaceHandlingGets 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.
Public propertySupported by the XNA FrameworkSupported by Portable Class LibraryNewLineCharsGets or sets the character string to use for line breaks.
Public propertySupported by the XNA FrameworkSupported by Portable Class LibraryNewLineHandlingGets or sets a value indicating whether to normalize line breaks in the output.
Public propertySupported by the XNA FrameworkSupported by Portable Class LibraryNewLineOnAttributesGets or sets a value indicating whether to write attributes on a new line.
Public propertySupported by the XNA FrameworkSupported by Portable Class LibraryOmitXmlDeclarationGets or sets a value indicating whether to write an XML declaration.
Public propertySupported by the XNA FrameworkOutputMethodGets the method used to serialize the XmlWriter output.
Top

  NameDescription
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryCloneCreates a copy of the XmlWriterSettings instance.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodSupported by the XNA FrameworkSupported by Portable Class LibraryFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodSupported by the XNA FrameworkSupported by Portable Class LibraryMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryResetResets the members of the settings class to their default values.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryToStringReturns a string that represents the current object. (Inherited from Object.)
Top

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.

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>

.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

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.

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

Community Additions

ADD
Show:
© 2014 Microsoft