EpubReference
OfficeIMO.Epub
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
- Property EpubManifestItem.Reference
- Method EpubReference.Resolve
Methods
public static EpubReference Resolve(string basePath, string reference) #Resolves a reference against an EPUB container document path.
Parameters
- basePath string
- Case-sensitive archive path of the containing document.
- reference string
- URL reference to resolve.
public static EpubReference Resolve(string documentPath, string? baseHref, string reference) #Resolves a content reference using an optional HTML base element value.
Parameters
- documentPath string
- Case-sensitive archive path of the content document.
- baseHref string?
- Optional HTML base URL.
- reference string
- URL reference to resolve.
public override string ToString() #Returns a string that represents the current object.
Returns
string A string that represents the current object.Inherited Methods
Properties
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 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.