Class XmlEncodingOptions

Namespace

Cuemon.Xml

Assembly

Cuemon.Xml.dll

Configuration options for XmlEncodingOptions.

public class XmlEncodingOptions : EncodingOptions, IEncodingOptions, IParameterObject

Inheritance

object

EncodingOptions

XmlEncodingOptions

Implements

IEncodingOptions

IParameterObject

Inherited Members

EncodingOptions.DefaultPreambleSequence

EncodingOptions.DefaultEncoding

EncodingOptions.Preamble

EncodingOptions.Encoding

Examples

The following example demonstrates how to configure XmlEncodingOptions to control character encoding and XML declaration behavior when writing XML documents.

using System;
using System.IO;
using System.Text;
using System.Xml;
using Cuemon.Text;
using Cuemon.Xml;

namespace MyApp.Examples
{
    public class XmlEncodingOptionsExample
    {
        public void Demonstrate()
        {
            // Configure XML encoding options.
            var options = new XmlEncodingOptions
            {
                Encoding = Encoding.UTF8,
                Preamble = EncodingOptions.DefaultPreambleSequence,
                OmitXmlDeclaration = false
            };

            Console.WriteLine($"Encoding:           {options.Encoding.WebName}");          // utf-8
            Console.WriteLine($"Omit XML declaration: {options.OmitXmlDeclaration}");       // False

            // Write XML with explicit encoding settings.
            var settings = new XmlWriterSettings
            {
                Encoding = options.Encoding,
                OmitXmlDeclaration = options.OmitXmlDeclaration,
                Indent = true
            };

            using var writer = XmlWriter.Create(Stream.Null, settings);
            writer.WriteStartDocument();
            writer.WriteStartElement("root");
            writer.WriteElementString("value", "Hello, World!");
            writer.WriteEndElement();
            writer.WriteEndDocument();
            writer.Flush();

            // Omit the XML declaration.
            options.OmitXmlDeclaration = true;
            Console.WriteLine($"Omit XML declaration now: {options.OmitXmlDeclaration}");  // True

}}
}

Constructors

XmlEncodingOptions()

Initializes a new instance of the XmlEncodingOptions class.

public XmlEncodingOptions()

Remarks

The following table shows the initial property values for an instance of XmlEncodingOptions.

Property	Initial Value
Preamble	DefaultPreambleSequence
Encoding	DefaultEncoding
OmitXmlDeclaration	false

Properties

OmitXmlDeclaration

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

public bool OmitXmlDeclaration { get; set; }

Property Value

bool

true to omit the XML declaration; otherwise, false. The default is false, an XML declaration is written.