Class EpubBook

Represents a EPUB book with all its content and metadata.

Inheritance

object

EpubBook

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: VersOne.Epub

Assembly: VersOne.Epub.dll

Syntax

public class EpubBook

Constructors

EpubBook(string?, string, string, List<string>?, string?, byte[]?, List<EpubLocalTextContentFile>?, List<EpubNavigationItem>?, EpubSchema, EpubContent)

Initializes a new instance of the EpubBook class.

Declaration

public EpubBook(string? filePath, string title, string author, List<string>? authorList, string? description, byte[]? coverImage, List<EpubLocalTextContentFile>? readingOrder, List<EpubNavigationItem>? navigation, EpubSchema schema, EpubContent content)

Parameters

Type	Name	Description
string	filePath	The path to the EPUB file or null if the EPUB file is being loaded from a stream.
string	title	The title of the book.
string	author	A comma separated list of the book's authors.
List<string>	authorList	A list of book's authors names.
string	description	The book's description or null if the description is not present in the book.
byte[]	coverImage	The book's cover image or null if there is no cover.
List<EpubLocalTextContentFile>	readingOrder	A list of text content files in the order of reading intended by the author.
List<EpubNavigationItem>	navigation	A list of navigation elements of the book (typically the table of contents) or null if the book doesn't have navigation information.
EpubSchema	schema	The parsed EPUB schema of the book.
EpubContent	content	The collection of the book's content files.

Exceptions

Type	Condition
ArgumentNullException	The title parameter is null.
ArgumentNullException	The author parameter is null.
ArgumentNullException	The schema parameter is null.
ArgumentNullException	The content parameter is null.

Properties

Author

Gets a comma separated list of the book's authors.

Declaration

public string Author { get; }

Property type: string

AuthorList

Gets a list of book's authors names.

Declaration

public List<string> AuthorList { get; }

Property type: List<string>

Content

Gets the collection of the book's content files.

Declaration

public EpubContent Content { get; }

Property type: EpubContent

CoverImage

Gets the book's cover image or null if there is no cover.

Declaration

public byte[]? CoverImage { get; }

Property type: byte[]

Description

Gets the book's description or null if the description is not present in the book.

Declaration

public string? Description { get; }

Property type: string

FilePath

Gets the path to the EPUB file or null if the EPUB file was loaded from a stream.

Declaration

public string? FilePath { get; }

Property type: string

Navigation

Gets a list of navigation elements of the book (typically the table of contents) or null if the book doesn't have navigation information.

Declaration

public List<EpubNavigationItem>? Navigation { get; }

Property type: List<EpubNavigationItem>

ReadingOrder

Gets a list of text content files in the order of reading intended by the author.

Declaration

public List<EpubLocalTextContentFile> ReadingOrder { get; }

Property type: List<EpubLocalTextContentFile>

Schema

Gets the parsed EPUB schema of the book.

Declaration

public EpubSchema Schema { get; }

Property type: EpubSchema

Title

Gets the title of the book.

Declaration

public string Title { get; }

Property type: string