Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

EpubReference

OfficeIMO.Epub

Namespace
OfficeIMO.Epub
Assembly
OfficeIMO.Epub
Source revision
ba882f6b0d07 with working tree changes
Modifiers
sealed

Represents an EPUB URL reference resolved against a container document path.

Inheritance

  • object
  • EpubReference

Usage

Explore 2 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 2

Methods

Resolve 2 overloads
public static EpubReference Resolve(string basePath, string reference) #

Resolves a reference against an EPUB container document path.

Parameters

basePath string required
Case-sensitive archive path of the containing document.
reference string required
URL reference to resolve.

Returns

EpubReference A typed result. Invalid and unsafe values do not throw.
public static EpubReference Resolve(string documentPath, string? baseHref, string reference) #

Resolves a content reference using an optional HTML base element value.

Parameters

documentPath string required
Case-sensitive archive path of the content document.
baseHref string? required
Optional HTML base URL.
reference string required
URL reference to resolve.

Returns

EpubReference A typed result. Invalid and unsafe values do not throw.
public override string ToString() #

Returns a string that represents the current object.

Returns

string A string that represents the current object.

Properties

public string Original { get; } #

The original trimmed reference value.

public EpubReferenceKind Kind { get; } #

The resolved reference kind.

public EpubReferenceError Error { get; } #

The resolution error, or EpubReferenceError.None on success.

public string? ContainerPath { get; } #

Case-sensitive normalized archive path for a container reference.

public string? ContainerUrlPath { get; } #

URL-encoded form of EpubReference.ContainerPath for serialization in links and media references.

public string? ExternalUri { get; } #

External or data URL, including its query and fragment when present.

public string? Query { get; } #

Raw query value without the leading question mark.

public string? Fragment { get; } #

Decoded fragment value without the leading number sign.

public bool IsContainerRootRelative { get; } #

Whether a container reference began at the virtual container root.

public bool IsConforming { get; } #

Whether the reference conforms to EPUB OCF URL restrictions. Safely resolved root-relative or backslash-separated container references are exposed with this value set to false.

public bool IsValid { get; } #

Whether the reference resolved successfully.

public string? Target { get; } #

Resolved target without a fragment. Container targets include any original query.

public string? ResolvedValue { get; } #

Fully resolved container path or preserved external/data URL.