XmlWriterSettings.Encoding Property

Definition

Namespace:

System.Xml

Assemblies:

netstandard.dll, System.Xml.ReaderWriter.dll

Source:

XmlWriterSettings.cs

Gets or sets the type of text encoding to use.

C#

public System.Text.Encoding Encoding { get; set; }

Property Value

Encoding

The text encoding to use. The default is Encoding.UTF8.

Examples

The following example shows how to set the Encoding property:

C#

XmlWriterSettings settings = new XmlWriterSettings();
settings.Indent = true;
settings.Encoding = Encoding.Unicode;
XmlWriter writer = XmlWriter.Create("books.xml", settings);

Remarks

The XmlWriter encodes a buffer of characters all at once, rather than character by character. An exception is thrown when the Flush method is called if any encoding errors are encountered.

The Encoding property only applies to the XmlWriter instances that are created either with the specified Stream or with the specified file name. If the XmlWriter instance is created with the specified TextWriter, the Encoding property is overridden by the encoding of the underlying TextWriter. For example, if this property is set to Unicode (UTF-16) for a particular XmlWriter, but the underlying writer is a StreamWriter (which derives from TextWriter) with its encoding set to UTF8, the output will be UTF-8 encoded.

If the XmlWriter instance is created with other output parameters, the Encoding property is ignored.

In the following example:

• The default value of Encoding is Encoding.UTF8.

• The StreamWriter is set to Encoding.Unicode and the StreamWriter's encoding overrides the Encoding setting.

• The output will be Encoding.Unicode.

C#

using (StreamWriter output =
    new StreamWriter(new FileStream("Xml01.xml", FileMode.Create), Encoding.Unicode))
{
    using (XmlWriter xmlWriter =
        XmlWriter.Create(output, new XmlWriterSettings()))
    {
        xmlWriter.WriteStartDocument();
        xmlWriter.WriteStartElement("Root");
        xmlWriter.WriteEndElement();
        xmlWriter.WriteEndDocument();
    }
}

Important

Do not accept an Encoding object from an untrusted source.

Applies to