API Reference
EpubReference
Represents an EPUB URL reference resolved against a container document path.
Inheritance
- Object
- EpubReference
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Method EpubReference.Resolve
- Method EpubReference.Resolve
Methods
public static EpubReference Resolve(String basePath, String reference) #EpubReferenceResolves a reference against an EPUB container document path.
Parameters
- basePath System.String
- Case-sensitive archive path of the containing document.
- reference System.String
- URL reference to resolve.
Returns
A typed result. Invalid and unsafe values do not throw.
public static EpubReference Resolve(String documentPath, String baseHref, String reference) #EpubReferenceResolves a content reference using an optional HTML base element value.
Parameters
- documentPath System.String
- Case-sensitive archive path of the content document.
- baseHref System.String
- Optional HTML base URL.
- reference System.String
- URL reference to resolve.
Returns
A typed result. Invalid and unsafe values do not throw.
Inherited Methods
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 None on success.
public String ContainerPath { get; } #Case-sensitive normalized archive path for a container reference.
public String ContainerUrlPath { get; } #URL-encoded form of 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 Boolean IsContainerRootRelative { get; } #Whether a container reference began at the virtual container root.
public Boolean 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 Boolean 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.