API Reference
ReaderHandlerRegistration
Custom handler registration model for configuring an OfficeDocumentReaderBuilder without hard dependencies.
Inheritance
- Object
- ReaderHandlerRegistration
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Accepted by parameters
Constructors
public ReaderHandlerRegistration() #Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
Properties
public String Id { get; set; } #Stable unique identifier for this handler (for example: "officeimo.reader.epub").
public String DisplayName { get; set; } #Optional display name shown in capability listings.
public String Description { get; set; } #Optional handler description shown in capability listings.
public ReaderHandlerOrigin Origin { get; set; } #Identifies whether the handler is supplied by OfficeIMO or by an application/integration. Custom is the safe default for registrations created by consumers.
public ReaderInputKind Kind { get; set; } #Kind advertised by this handler for detect/capability workflows.
public Boolean UseDetectedKindFallback { get; set; } #Gets or sets whether this handler may be selected as the sole custom fallback for a detected Kind when no registered extension matches. Default: true. Set false for extension-specific formats that share a broader detected kind.
public IReadOnlyList<String> Extensions { get; set; } #File extensions handled by this registration (for example: ".epub", ".zip").
public Func<String, ReaderOptions, CancellationToken, IEnumerable<ReaderChunk>> ReadPath { get; set; } #Path-based reader delegate.
public Func<Stream, String, ReaderOptions, CancellationToken, IEnumerable<ReaderChunk>> ReadStream { get; set; } #Stream-based reader delegate.
public Func<String, ReaderOptions, CancellationToken, OfficeDocumentReadResult> ReadDocumentPath { get; set; } #Optional path-based rich document reader delegate. When present, CancellationToken) dispatches directly to this delegate instead of rebuilding a generic result from chunks.
public Func<Stream, String, ReaderOptions, CancellationToken, OfficeDocumentReadResult> ReadDocumentStream { get; set; } #Optional stream-based rich document reader delegate. The delegate must not close the caller-owned stream. When present, CancellationToken) dispatches directly to this delegate instead of rebuilding a generic result from chunks.
public Func<String, ReaderOptions, CancellationToken, Task<OfficeDocumentReadResult>> ReadDocumentPathAsync { get; set; } #Optional native asynchronous path-based rich document reader delegate.
public Func<Stream, String, ReaderOptions, CancellationToken, Task<OfficeDocumentReadResult>> ReadDocumentStreamAsync { get; set; } #Optional native asynchronous stream-based rich document reader delegate. The delegate must not close the caller-owned stream.
public Func<Stream, String, ReaderOptions, CancellationToken, Boolean> ProbeStream { get; set; } #Optional bounded content probe used when structural detection finds a container but cannot determine the inner format. The probe must restore caller-visible stream position and return false for non-matches.
public Nullable<Int64> DefaultMaxInputBytes { get; set; } #Optional advertised default max input bytes for this handler. Null means "no handler-specific default advertised".
public ReaderSourceHashBehavior SourceHashBehavior { get; set; } #Defines whether Core derives the source hash from ComputeHashes or leaves source-hash ownership to the format handler.
public ReaderWarningBehavior WarningBehavior { get; set; } #Advertised warning model for this handler.
public Boolean DeterministicOutput { get; set; } #True when this handler advertises deterministic chunk ordering/output for identical input.