DjVuDocument
OfficeIMO.DjVu
An owned, immutable snapshot of a DjVu document and its explicitly resolved components.
Inheritance
- object
- DjVuDocument
Usage
Explore 9 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 1
- Method DjVuDocument.Load
Accepted by parameters 8
- Extension method DjVuDocument.SaveAsImages
- Extension method DjVuDocument.SaveAsImagesAsync
- Extension method DjVuDocument.ToImages
- Extension method DjVuDocument.ToImagesAsync
- Method DjVuDocumentImageConversionExtensions.SaveAsImages
- Method DjVuDocumentImageConversionExtensions.SaveAsImagesAsync
- Method DjVuDocumentImageConversionExtensions.ToImages
- Method DjVuDocumentImageConversionExtensions.ToImagesAsync
Methods
public static DjVuDocument Load(byte[] bytes, DjVuLoadOptions? options = null, CancellationToken cancellationToken = default) #Loads and copies a DjVu file's bytes, applying aggregate document limits.
Parameters
- bytes byte[]
- options OfficeIMO.DjVu.DjVuLoadOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
DjVuDocumentpublic static DjVuDocument Load(Stream stream, DjVuLoadOptions? options = null, CancellationToken cancellationToken = default) #Loads from the current position of a readable stream, including non-seekable streams. Leaves the stream open.
Parameters
- stream System.IO.Stream
- options OfficeIMO.DjVu.DjVuLoadOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
DjVuDocumentpublic static DjVuDocument Load(string path, DjVuLoadOptions? options = null, CancellationToken cancellationToken = default) #Loads a file and closes its handle before returning. Component IDs never trigger implicit file access.
Parameters
- path string
- options OfficeIMO.DjVu.DjVuLoadOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
DjVuDocumentInherited Methods
Properties
public IReadOnlyList<DjVuPage> Pages { get; } #Pages in the source directory's order.
public IReadOnlyList<DjVuBookmark> Bookmarks { get; } #Stored document outline entries in source order.
public string? BookmarkDiagnostic { get; } #A malformed outline diagnostic; null for absent or valid outlines.
public string SourceSha256 { get; } #SHA-256 of the exact primary input snapshot. Resolved indirect components are separate inputs.
public long SourceLengthBytes { get; } #Length of the exact primary input snapshot, excluding explicitly resolved components.
Extension Methods
public static OfficeConversionReport SaveAsImages(DjVuDocument document, string folderPath, OfficeImageExportOptions? options = null, DjVuRenderOptions? renderOptions = null, CancellationToken cancellationToken = default) #Saves selected pages with atomic files, bounded output and fidelity acceptance.
Parameters
- document OfficeIMO.DjVu.DjVuDocument
- folderPath string
- options OfficeIMO.Drawing.OfficeImageExportOptions? = null
- renderOptions OfficeIMO.DjVu.DjVuRenderOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
OfficeConversionReportpublic static async Task<OfficeConversionReport> SaveAsImagesAsync(DjVuDocument document, string folderPath, OfficeImageExportOptions? options = null, DjVuRenderOptions? renderOptions = null, CancellationToken cancellationToken = default) #Saves selected pages asynchronously without retaining completed image payloads.
Parameters
- document OfficeIMO.DjVu.DjVuDocument
- folderPath string
- options OfficeIMO.Drawing.OfficeImageExportOptions? = null
- renderOptions OfficeIMO.DjVu.DjVuRenderOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeConversionReport>public static IReadOnlyList<OfficeImageExportResult> ToImages(DjVuDocument document, OfficeImageExportOptions? options = null, DjVuRenderOptions? renderOptions = null, CancellationToken cancellationToken = default) #Renders selected source pages in caller order, retaining source and encoding diagnostics.
Parameters
- document OfficeIMO.DjVu.DjVuDocument
- options OfficeIMO.Drawing.OfficeImageExportOptions? = null
- renderOptions OfficeIMO.DjVu.DjVuRenderOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
IReadOnlyList<OfficeImageExportResult>public static void ToImages(DjVuDocument document, OfficeImageExportConsumer consumer, OfficeImageExportOptions? options = null, DjVuRenderOptions? renderOptions = null, CancellationToken cancellationToken = default) #Streams selected images without retaining earlier encoded payloads.
Parameters
- document OfficeIMO.DjVu.DjVuDocument
- consumer OfficeIMO.Drawing.OfficeImageExportConsumer
- options OfficeIMO.Drawing.OfficeImageExportOptions? = null
- renderOptions OfficeIMO.DjVu.DjVuRenderOptions? = null
- cancellationToken System.Threading.CancellationToken = default
public static Task<IReadOnlyList<OfficeImageExportResult>> ToImagesAsync(DjVuDocument document, OfficeImageExportOptions? options = null, DjVuRenderOptions? renderOptions = null, CancellationToken cancellationToken = default) #Renders selected source pages asynchronously with shared cancellation and deadlines.
Parameters
- document OfficeIMO.DjVu.DjVuDocument
- options OfficeIMO.Drawing.OfficeImageExportOptions? = null
- renderOptions OfficeIMO.DjVu.DjVuRenderOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<IReadOnlyList<OfficeImageExportResult>>