Show / Hide Table of Contents

Class 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.

Inheritance
object
EpubContentFile
EpubLocalContentFile
EpubLocalByteContentFile
EpubLocalTextContentFile
Inherited Members
EpubContentFile.Key
EpubContentFile.ContentType
EpubContentFile.ContentMimeType
EpubContentFile.ContentFileType
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 abstract class EpubLocalContentFile : EpubContentFile

Constructors

View Source

EpubLocalContentFile(string, EpubContentType, string, string)

Initializes a new instance of the EpubLocalContentFile class.

Declaration
protected EpubLocalContentFile(string key, EpubContentType contentType, string contentMimeType, string filePath)
Parameters
Type Name Description
string key

The content file key as it is declared in the EPUB manifest (in the Href property).

EpubContentType contentType

The type of the content of the file.

string contentMimeType

The MIME type of the content of the file.

string filePath

The absolute path of the local content file in the EPUB archive.

Exceptions
Type Condition
ArgumentNullException

The contentMimeType parameter is null.

ArgumentNullException

The filePath parameter is null.

Properties

View Source

ContentLocation

Gets the location of the content file which is always LOCAL for local content files.

Declaration
public override EpubContentLocation ContentLocation { get; }
Property type: EpubContentLocation
Overrides
EpubContentFile.ContentLocation
View Source

FilePath

Gets the absolute path of the local content file in the EPUB archive.

Declaration
public string FilePath { get; }
Property type: string
  • View Source
In this article
Back to top Generated by DocFX