Class UriExtensions

Namespace: Cuemon.Extensions.Xml

Assembly: Cuemon.Extensions.Xml.dll

Extension methods for the Uri class.

public static class UriExtensions

Inheritance: object

UriExtensions

Examples

UriExtensions in the Xml namespace creates XmlReader instances from file URIs with configurable reader settings. This example writes a simple XML snippet to a temporary file, constructs a Uri pointing to it, and calls ToXmlReader with settings that ignore XML comments and disable DTD processing. After positioning the reader with MoveToFirstElement, the local element name is output as "root". A finally block ensures the temporary file is deleted after the demonstration.

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

namespace DocExamples;

public static class UriExtensionsExample
{
    public static void Demonstrate()
    {
        var xml = "<?xml version=\"1.0\"?><root><!--comment--><item>42</item></root>";
        var filePath = Path.Combine(AppContext.BaseDirectory, "settings.xml");
        File.WriteAllText(filePath, xml, Encoding.UTF8);

        try
        {
            using var reader = new Uri(filePath).ToXmlReader(settings =>
            {
                settings.IgnoreComments = true;
                settings.DtdProcessing = DtdProcessing.Ignore;
            });

            if (reader.MoveToFirstElement())
            {
                Console.WriteLine(reader.LocalName);
            }
        }
        finally
        {
            if (File.Exists(filePath))
            {
                File.Delete(filePath);
            }
        }
    }
}

Methods

ToXmlReader(Uri, Action<XmlReaderSettings>)

Converts the given value to an XmlReader.

public static XmlReader ToXmlReader(this Uri value, Action<XmlReaderSettings> setup = null)

Parameters

value Uri: The Uri to extend.
setup Action<XmlReaderSettings>: The XmlReaderSettings which may be configured.

Returns