Class XmlReaderOptions

Various options to configure how EPUB reader handles XML files.

Inheritance

object

XmlReaderOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: VersOne.Epub.Options

Assembly: VersOne.Epub.dll

Syntax

public class XmlReaderOptions

Constructors

XmlReaderOptions(EpubReaderOptionsPreset?)

Initializes a new instance of the XmlReaderOptions class.

Declaration

public XmlReaderOptions(EpubReaderOptionsPreset? preset = null)

Parameters

Type	Name	Description
EpubReaderOptionsPreset?	preset	An optional preset to initialize the XmlReaderOptions class with a predefined set of options.

Properties

SkipXmlHeaders

Gets or sets a value indicating whether XML reader should skip XML headers for all schema files before attempting to read them. This is a workaround for handling XML 1.1 files due to the lack of their support in .NET (only XML 1.0 files are currently supported). If this property is set to true, XML reader will check if an XML file contains a declaration (<?xml version="..." encoding="UTF-8"?>) in which case the reader will skip it before passing the file to the underlying .NET XDocument class. This lets the library to handle EPUB files containing XML 1.1 files at the expense of an additional processing overhead for every schema file inside the EPUB file. If this property is set to false, then there is no overhead for processing XML files. However in an attempt to open an EPUB with an XML 1.1 file, an XmlException "Version number '1.1' is invalid" will be thrown. Default value is false.

Declaration

public bool SkipXmlHeaders { get; set; }

Property type: bool