API Reference
OfficeDocumentReaderBuilder
Builds an OfficeDocumentReader with an isolated handler configuration.
Inheritance
- Object
- OfficeDocumentReaderBuilder
Remarks
A builder may be reused or changed after Build. Each built reader retains its own immutable snapshot and is unaffected by later builder changes.
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
- Extension method OfficeDocumentReaderBuilder.AddPlainTextHandlers
- Method OfficeDocumentReaderBuilder.AddHandler
- Method OfficeDocumentReaderBuilder.AddProcessor
- Method OfficeDocumentReaderBuilder.AddProcessors
- Method OfficeDocumentReaderBuilder.ClearProcessors
- Method OfficeDocumentReaderBuilder.UseProcessorPipeline
- Method OfficeDocumentReaderBuilder.WithMaxConcurrentReads
- Method OfficeDocumentReaderBuilder.WithProcessorFailureBehavior
- Method OfficeDocumentReaderBuilderTextExtensions.AddPlainTextHandlers
Accepted by parameters
Constructors
public OfficeDocumentReaderBuilder() #Methods
public OfficeDocumentReaderBuilder AddHandler(ReaderHandlerRegistration registration, Boolean replaceExisting = false) #OfficeDocumentReaderBuilderAdds a handler to this reader configuration.
Parameters
- registration OfficeIMO.Reader.ReaderHandlerRegistration
- Handler registration.
- replaceExisting System.Boolean = false
- Whether conflicting handler identifiers and extensions may be replaced.
Returns
This builder.
public OfficeDocumentReaderBuilder AddProcessor(IOfficeDocumentProcessor processor) #OfficeDocumentReaderBuilderAdds a document processor after existing processors.
Parameters
- processor OfficeIMO.Reader.IOfficeDocumentProcessor
public OfficeDocumentReaderBuilder AddProcessors(IEnumerable<IOfficeDocumentProcessor> processors) #OfficeDocumentReaderBuilderAdds document processors in enumeration order.
Parameters
- processors System.Collections.Generic.IEnumerable{OfficeIMO.Reader.IOfficeDocumentProcessor}
public OfficeDocumentReader Build() #OfficeDocumentReaderCreates an immutable, thread-safe reader from the current configuration.
public OfficeDocumentReaderBuilder ClearProcessors() #OfficeDocumentReaderBuilderRemoves all configured processors.
public Boolean RemoveProcessor(String processorId) #BooleanRemoves a configured processor by stable identifier.
Parameters
- processorId System.String
public OfficeDocumentReaderBuilder UseProcessorPipeline(OfficeDocumentProcessorPipeline pipeline) #OfficeDocumentReaderBuilderReplaces configured processors with a snapshot of an existing pipeline.
Parameters
- pipeline OfficeIMO.Reader.OfficeDocumentProcessorPipeline
public OfficeDocumentReaderBuilder WithMaxConcurrentReads(Int32 maxConcurrentReads) #OfficeDocumentReaderBuilderSets the maximum number of asynchronous read operations allowed in flight for the built reader.
Parameters
- maxConcurrentReads System.Int32
- A value from 1 through 64.
Returns
This builder.
public OfficeDocumentReaderBuilder WithProcessorFailureBehavior(OfficeDocumentProcessorFailureBehavior failureBehavior) #OfficeDocumentReaderBuilderSets processor failure behavior for the built reader.
Parameters
- failureBehavior OfficeIMO.Reader.OfficeDocumentProcessorFailureBehavior
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
Extension Methods
public static OfficeDocumentReaderBuilder AddPlainTextHandlers(OfficeDocumentReaderBuilder builder, Boolean replaceExisting = false) #OfficeDocumentReaderBuilderAdds explicit plain-text handling and a detected-unknown fallback.
Parameters
- builder OfficeIMO.Reader.OfficeDocumentReaderBuilder
- replaceExisting System.Boolean = false