Namespace VersOne.Epub
Classes
Epub2NcxException
Represents an exception thrown by the EpubReader due to a EPUB 2 NCX document parsing error.
Epub3NavException
Represents an exception thrown by the EpubReader due to a EPUB 3 navigation document parsing error.
EpubBook
Represents a EPUB book with all its content and metadata.
EpubBookRef
Represents a EPUB book with its metadata. An instance of this class holds a reference to the EPUB file to load book's content on demand.
EpubContainerException
Represents an exception thrown by the EpubReader due to an OCF container parsing error.
EpubContent
A container for all content files within the EPUB book.
EpubContentCollectionException
Represents an exception thrown by the EpubReader due to an invalid operation performed on an instance of the EpubContentCollection<TLocalContentFile, TRemoteContentFile> class.
EpubContentCollectionRefException
Represents an exception thrown by the EpubReader due to an invalid operation performed on an instance of the EpubContentCollectionRef<TLocalContentFileRef, TRemoteContentFileRef> class.
EpubContentCollectionRef<TLocalContentFileRef, TRemoteContentFileRef>
A container for a subset of content file references within the EPUB book.
EpubContentCollection<TLocalContentFile, TRemoteContentFile>
A container for a subset of content files within the EPUB book.
EpubContentDownloaderException
Represents an exception thrown by the EpubReader due to a remote content downloading error.
EpubContentException
Represents an exception thrown by the EpubReader due to a missing content file within the EPUB archive.
EpubContentFile
The base class for content files and content file references declared in the EPUB manifest (e.g., HTML files or images).
EpubContentFileRef
The base class for content file references.
EpubContentFileRefMetadata
Metadata for a content file reference.
EpubContentRef
A container for all content file references within the EPUB book.
EpubLocalByteContentFile
A file within the EPUB archive with its content represented as a byte array. It is used for images and font files. Unlike EpubLocalByteContentFileRef, this class contains the whole content of the file.
EpubLocalByteContentFileRef
A reference for a file within the EPUB archive which allows to read its content as a byte array. Unlike EpubLocalByteContentFile, this class contains only a reference to the file but doesn't contain its content.
EpubLocalContentFile
The base class for a local content file within the EPUB archive (e.g., an HTML file or an image). Unlike EpubLocalContentFileRef, the classes derived from this base class contain the whole content of the file.
EpubLocalContentFileRef
The base class for a content file reference within the EPUB archive (e.g., an HTML file or an image). Unlike EpubLocalContentFile, the classes derived from this base class contain only a reference to the file but don't contain its content.
EpubLocalTextContentFile
A file within the EPUB archive with its content represented as a string. It is used mainly for HTML and CSS files. Unlike EpubLocalTextContentFileRef, this class contains the whole content of the file.
EpubLocalTextContentFileRef
A reference for a file within the EPUB archive which allows to read its content as a string. Unlike EpubLocalTextContentFile, this class contains only a reference to the file but doesn't contain its content.
EpubNarrationPhrase
Represents a single phrase within a narration sequence.
EpubNavigationItem
A single navigation element of the book (typically within the table of contents).
Depending on the value of the Type property, it can act either as a header or as a navigation link.
Unlike EpubNavigationItemRef, this class contains the HtmlContentFile property
which (if it's not null
) holds the whole content of the file referenced by this navigation element.
EpubNavigationItemLink
Navigation link representing a pointer to a specific place in the book's content.
EpubNavigationItemRef
A single navigation element of the book (typically within the table of contents).
Depending on the value of the Type property, it can act either as a header or as a navigation link.
Unlike EpubNavigationItem, this class contains the HtmlContentFileRef property
which (if it's not null
) holds only the reference to the file but doesn't have its content.
EpubPackageException
Represents an exception thrown by the EpubReader due to an OPF package parsing error.
EpubReader
The main entry point of the EpubReader library. The methods in this class let the consumer to open/read EPUB books from a file or a Stream.
EpubReaderException
Represents a base class for exceptions thrown by the EpubReader.
EpubRemoteByteContentFile
A file located outside of the EPUB archive with its content represented as a byte array. It is used for images and font files. Unlike EpubRemoteByteContentFileRef, this class contains the whole content of the file.
EpubRemoteByteContentFileRef
A reference for a file located outside of the EPUB archive which allows to read its content as a byte array. Unlike EpubRemoteByteContentFile, this class contains only a reference to the file but doesn't contain its content.
EpubRemoteContentFile
The base class for a remote content file outside of the EPUB archive (e.g., an HTML file or an image). Unlike EpubRemoteContentFileRef, the classes derived from this base class contain the whole content of the file.
EpubRemoteContentFileRef
The base class for a content file reference located outside of the EPUB archive (e.g., an HTML file or an image). Unlike EpubRemoteContentFile, the classes derived from this base class contain only a reference to the file but don't contain its content.
EpubRemoteTextContentFile
A file located outside of the EPUB archive with its content represented as a string. It is used mainly for HTML and CSS files. Unlike EpubRemoteTextContentFileRef, this class contains the whole content of the file.
EpubRemoteTextContentFileRef
A reference for a file located outside of the EPUB archive which allows to read its content as a string. Unlike EpubRemoteTextContentFile, this class contains only a reference to the file but doesn't contain its content.
EpubSchema
Parsed content of all EPUB schema files (OPF package and EPUB 2 NCX / EPUB 3 OPS navigation document) of the EPUB book.
See https://www.w3.org/publishing/epub32/epub-packages.html and https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm for more information.
EpubSchemaException
Represents a base class for exceptions thrown by the EpubReader due to a schema parsing error.
EpubSmilException
Represents an exception thrown by the EpubReader due to a SMIL document parsing error.
Structs
EpubNarrationTimestamp
Represents a timestamp of the beginning or the end of the narration audio clip.
Interfaces
IEpubContentLoader
Provides methods for loading content files.
Enums
EpubContentFileType
The type of a single EPUB content file (e.g. a chapter or an image).
EpubContentLocation
The location of a single EPUB content file (e.g. a chapter or an image).
EpubContentType
The type of the content in a EPUB content file.
EpubNavigationItemType
The type of the EPUB navigation item (from EPUB 2 NCX document for EPUB 2 books or from EPUB 3 NAV document for EPUB 3 books).
EpubSchemaFileType
Type of the EPUB schema file.