Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, CLI, Studio and browser tools 573 stars PSWriteOfficePowerShell module 165 stars

Talk and help

DiscordQuestions, ideas and show and tell Report an issueBugs and feature requests SponsorFund ongoing development

Mode

Background

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Search the whole siteOpen search page →
Documentation Search all OfficeIMO/

API Reference

Class

EpubDocument

Edit on GitHub
Namespace OfficeIMO.Epub
Assembly OfficeIMO.Epub
Source EpubDocument.cs:86
Modifiers sealed

Represents extracted EPUB content.

Inheritance

  • Object
  • EpubDocument

Usage

Explore 3 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 3

Constructors

public EpubDocument() #
EpubDocument.cs:86

Methods

InspectContentSafety 2 overloads
public static OfficeContentSafetyReport InspectContentSafety(Byte[] packageBytes, OfficeContentSafetyOptions? options = null, EpubReadOptions? readOptions = null, CancellationToken cancellationToken = default) #
EpubDocument.ContentSafety.cs:19
Returns: OfficeContentSafetyReport

Inspects concealed machine-readable HTML across bounded EPUB content documents.

Parameters

packageBytes System.Byte[] requiredposition: 0
options OfficeIMO.ContentSafety.OfficeContentSafetyOptions? = null optionalposition: 1
readOptions OfficeIMO.Epub.EpubReadOptions? = null optionalposition: 2
cancellationToken System.Threading.CancellationToken = default optionalposition: 3
public static OfficeContentSafetyReport InspectContentSafety(String filePath, OfficeContentSafetyOptions? options = null, EpubReadOptions? readOptions = null, CancellationToken cancellationToken = default) #
EpubDocument.ContentSafety.cs:35
Returns: OfficeContentSafetyReport

Inspects concealed machine-readable HTML across a bounded EPUB file.

Parameters

filePath System.String requiredposition: 0
options OfficeIMO.ContentSafety.OfficeContentSafetyOptions? = null optionalposition: 1
readOptions OfficeIMO.Epub.EpubReadOptions? = null optionalposition: 2
cancellationToken System.Threading.CancellationToken = default optionalposition: 3
public static OfficeProvenanceReport InspectProvenance(String filePath, OfficeProvenanceOptions? options = null) #
EpubDocument.Provenance.cs:11
Returns: OfficeProvenanceReport

Inspects C2PA and IPTC provenance in an EPUB package and its supported embedded images.

Parameters

filePath System.String requiredposition: 0
options OfficeIMO.Provenance.OfficeProvenanceOptions? = null optionalposition: 1
Load 4 overloads
public static EpubDocument Load(String path, EpubReadOptions? options = null) #
EpubDocument.cs:11
Returns: EpubDocument

Loads an EPUB document from a file.

Parameters

path System.String requiredposition: 0
options OfficeIMO.Epub.EpubReadOptions? = null optionalposition: 1
public static EpubDocument Load(Stream stream, EpubReadOptions? options = null) #
EpubDocument.cs:14
Returns: EpubDocument

Loads an EPUB document from a caller-owned stream.

Parameters

stream System.IO.Stream requiredposition: 0
options OfficeIMO.Epub.EpubReadOptions? = null optionalposition: 1
public static EpubDocument Load(String path, EpubReadOptions? options, CancellationToken cancellationToken) #
EpubDocument.cs:18
Returns: EpubDocument

Loads a file with cancellation during package reading and parsing.

Parameters

path System.String requiredposition: 0
options OfficeIMO.Epub.EpubReadOptions? requiredposition: 1
cancellationToken System.Threading.CancellationToken requiredposition: 2
public static EpubDocument Load(Stream stream, EpubReadOptions? options, CancellationToken cancellationToken) #
EpubDocument.cs:22
Returns: EpubDocument

Loads a caller-owned stream with cancellation during reading and parsing.

Parameters

stream System.IO.Stream requiredposition: 0
options OfficeIMO.Epub.EpubReadOptions? requiredposition: 1
cancellationToken System.Threading.CancellationToken requiredposition: 2
LoadAsync 2 overloads
public static async Task<EpubDocument> LoadAsync(String path, EpubReadOptions? options = null, CancellationToken cancellationToken = default) #
Returns: Task<EpubDocument>

Asynchronously loads an EPUB document from a file.

Parameters

path System.String requiredposition: 0
options OfficeIMO.Epub.EpubReadOptions? = null optionalposition: 1
cancellationToken System.Threading.CancellationToken = default optionalposition: 2
public static async Task<EpubDocument> LoadAsync(Stream stream, EpubReadOptions? options = null, CancellationToken cancellationToken = default) #
Returns: Task<EpubDocument>

Asynchronously loads an EPUB document from a caller-owned stream.

Parameters

stream System.IO.Stream requiredposition: 0
options OfficeIMO.Epub.EpubReadOptions? = null optionalposition: 1
cancellationToken System.Threading.CancellationToken = default optionalposition: 2
RemoveProvenance 2 overloads
public static OfficeProvenanceRemovalResult RemoveProvenance(String inputPath, String outputPath, OfficeProvenanceRemovalOptions? options = null) #
EpubDocument.Provenance.cs:25
Returns: OfficeProvenanceRemovalResult

Removes selected provenance and atomically writes an EPUB package.

Parameters

inputPath System.String requiredposition: 0
outputPath System.String requiredposition: 1
options OfficeIMO.Provenance.OfficeProvenanceRemovalOptions? = null optionalposition: 2
public static OfficeProvenanceRemovalResult RemoveProvenance(Byte[] packageBytes, String fileName = "publication.epub", OfficeProvenanceRemovalOptions? options = null) #
EpubDocument.Provenance.cs:40
Returns: OfficeProvenanceRemovalResult

Removes selected provenance from encoded EPUB package bytes.

Parameters

packageBytes System.Byte[] requiredposition: 0
fileName System.String = "publication.epub" optionalposition: 1
options OfficeIMO.Provenance.OfficeProvenanceRemovalOptions? = null optionalposition: 2
RemoveSelectedContent 2 overloads
public static OfficeContentCleanupResult RemoveSelectedContent(Byte[] packageBytes, OfficeContentCleanupSelection selection, OfficeContentCleanupOptions? options = null, EpubReadOptions? readOptions = null, CancellationToken cancellationToken = default) #
EpubDocument.ContentSafety.cs:48
Returns: OfficeContentCleanupResult

Removes exact selected concealed HTML findings, preserves other EPUB entries, and reopens the result.

Parameters

packageBytes System.Byte[] requiredposition: 0
selection OfficeIMO.ContentSafety.OfficeContentCleanupSelection requiredposition: 1
options OfficeIMO.ContentSafety.OfficeContentCleanupOptions? = null optionalposition: 2
readOptions OfficeIMO.Epub.EpubReadOptions? = null optionalposition: 3
cancellationToken System.Threading.CancellationToken = default optionalposition: 4
public static OfficeContentCleanupResult RemoveSelectedContent(String inputPath, String outputPath, OfficeContentCleanupSelection selection, OfficeContentCleanupOptions? options = null, EpubReadOptions? readOptions = null, CancellationToken cancellationToken = default) #
EpubDocument.ContentSafety.cs:110
Returns: OfficeContentCleanupResult

Atomically writes an explicitly cleaned EPUB artifact.

Parameters

inputPath System.String requiredposition: 0
outputPath System.String requiredposition: 1
selection OfficeIMO.ContentSafety.OfficeContentCleanupSelection requiredposition: 2
options OfficeIMO.ContentSafety.OfficeContentCleanupOptions? = null optionalposition: 3
readOptions OfficeIMO.Epub.EpubReadOptions? = null optionalposition: 4
cancellationToken System.Threading.CancellationToken = default optionalposition: 5
public static OfficeXmlPackageSigningResult SignPackage(String filePath, IOfficeSecurityProvider securityProvider, X509Certificate2 signingCertificate, OfficeXmlPackageSignatureOptions? options = null) #
EpubDocument.Signatures.cs:21
Returns: OfficeXmlPackageSigningResult

Creates, validates, and atomically commits an EPUB XML package signature.

Parameters

filePath System.String requiredposition: 0
securityProvider OfficeIMO.Security.IOfficeSecurityProvider requiredposition: 1
signingCertificate System.Security.Cryptography.X509Certificates.X509Certificate2 requiredposition: 2
options OfficeIMO.Security.OfficeXmlPackageSignatureOptions? = null optionalposition: 3
public static OfficeXmlPackageSigningResult TrySignPackage(String filePath, IOfficeSecurityProvider securityProvider, X509Certificate2 signingCertificate, OfficeXmlPackageSignatureOptions? options = null) #
EpubDocument.Signatures.cs:31
Returns: OfficeXmlPackageSigningResult

Attempts atomic EPUB XML signature creation and returns structured failure evidence.

Parameters

filePath System.String requiredposition: 0
securityProvider OfficeIMO.Security.IOfficeSecurityProvider requiredposition: 1
signingCertificate System.Security.Cryptography.X509Certificates.X509Certificate2 requiredposition: 2
options OfficeIMO.Security.OfficeXmlPackageSignatureOptions? = null optionalposition: 3
public static OfficeXmlPackageSignatureValidationReport ValidatePackageSignatures(String filePath, IOfficeSecurityProvider securityProvider, OfficeXmlPackageSignatureOptions? options = null) #
EpubDocument.Signatures.cs:12
Returns: OfficeXmlPackageSignatureValidationReport

Validates META-INF/signatures.xml and signed EPUB entry digests through an explicit provider.

Parameters

filePath System.String requiredposition: 0
securityProvider OfficeIMO.Security.IOfficeSecurityProvider requiredposition: 1
options OfficeIMO.Security.OfficeXmlPackageSignatureOptions? = null optionalposition: 2

Properties

public String? Title { get; internal set; } #
EpubDocument.cs:51

Best-effort document title.

public String? Identifier { get; internal set; } #
EpubDocument.cs:56

Package identifier from OPF metadata when available.

public String? Language { get; internal set; } #
EpubDocument.cs:61

Primary language from OPF metadata when available.

public String? Creator { get; internal set; } #
EpubDocument.cs:66

Creator/author from OPF metadata when available.

public String? OpfPath { get; internal set; } #
EpubDocument.cs:71

Internal path to the OPF package document when discovered.

public String? PackageVersion { get; internal set; } #
EpubDocument.cs:74

Version declared by the OPF package element.

public String? UniqueIdentifierId { get; internal set; } #
EpubDocument.cs:77

ID of the dc:identifier selected by the package unique-identifier attribute.

public EpubRenditionLayout? RenditionLayout { get; internal set; } #
EpubDocument.cs:80

Globally declared rendition layout, or null when the package uses the default.

public Boolean IsFixedLayout { get; } #
EpubDocument.cs:83

Whether the package globally declares a pre-paginated fixed layout.

public IReadOnlyList<EpubRootfile> Rootfiles { get; internal set; } #
EpubDocument.cs:86

Ordered rootfile declarations from META-INF/container.xml.

public IReadOnlyList<EpubMetadataEntry> Metadata { get; internal set; } #
EpubDocument.cs:89

Ordered OPF metadata declarations, including EPUB 3 refinements and EPUB 2 metadata.

public IReadOnlyList<EpubNavigationItem> TableOfContents { get; internal set; } #
EpubDocument.cs:92

Hierarchical EPUB table of contents.

public IReadOnlyList<EpubNavigationItem> PageList { get; internal set; } #
EpubDocument.cs:95

EPUB page-list navigation items.

public IReadOnlyList<EpubNavigationItem> Landmarks { get; internal set; } #
EpubDocument.cs:98

EPUB landmarks or EPUB 2 guide references.

public IReadOnlyList<EpubChapter> Chapters { get; internal set; } #
EpubDocument.cs:103

Extracted chapters.

public EpubReadSummary ReadSummary { get; internal set; } #
EpubDocument.cs:106

Chapter extraction counts and completeness under the selected reading policy.

public IReadOnlyList<EpubResource> Resources { get; internal set; } #
EpubDocument.cs:111

OPF manifest resources in deterministic package order.

public IReadOnlyList<EpubEncryptionInfo> Encryption { get; internal set; } #
EpubDocument.cs:114

Encrypted or obfuscated resources declared by META-INF/encryption.xml.

public Boolean HasEncryptedResources { get; } #
EpubDocument.cs:117

Whether the container declares any encrypted or obfuscated resources.

public Boolean RequiresDecryption { get; } #
EpubDocument.cs:120

Whether one or more resources require unsupported decryption.

public EpubSignatureInfo Signatures { get; internal set; } #
EpubDocument.cs:123

Structural information about META-INF/signatures.xml, when present.

public Boolean HasSignatures { get; } #
EpubDocument.cs:126

Whether the EPUB container carries a signatures.xml document.

public IReadOnlyList<EpubDiagnostic> Diagnostics { get; internal set; } #
EpubDocument.cs:129

Structured non-fatal diagnostics encountered during extraction.

public IReadOnlyList<String> Warnings { get; internal set; } #
EpubDocument.cs:134

Non-fatal warnings encountered during extraction.