New-OfficeDocumentReader

Namespace PSWriteOffice

Inputs

None

Outputs

OfficeIMO.Reader.OfficeDocumentReader

Source

Sources/PSWriteOffice/Cmdlets/Reader/NewOfficeDocumentReaderCommand.cs:20 Edit on GitHub

Creates an immutable fully configured OfficeIMO document reader.

Remarks

Creates an immutable fully configured OfficeIMO document reader.

Examples

Authored help example

Create a reader with OCR and a resilient processor policy.

PS>


$ocr = [OfficeIMO.Reader.Ocr.Tesseract.TesseractOcrEngineOptions]::new(); $ocr.Language = 'eng+pol'; $reader = New-OfficeDocumentReader -TesseractOptions $ocr -ProcessorFailureBehavior ContinueWithDiagnostic

The returned reader can be supplied to every PSWriteOffice Reader command.

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.

Syntax

New-OfficeDocumentReader [-MaxConcurrentReads <Nullable`1>] [-OcrEngine <IOfficeOcrEngine>] [-OcrOptions <OfficeDocumentOcrExecutionOptions>] [-ProcessOcrOptions <ProcessOfficeOcrEngineOptions>] [-Processor <IOfficeDocumentProcessor[]>] [-ProcessorFailureBehavior <Throw|ContinueWithDiagnostic|StopWithDiagnostic>] [-ReaderAllOptions <ReaderAllOptions>] [-TesseractOptions <TesseractOcrEngineOptions>] [<CommonParameters>]

Parameter set: All Parameter Sets

Parameters

MaxConcurrentReads Nullable`1 optionalposition: namedpipeline: False: Maximum asynchronous reads allowed in flight.
OcrEngine IOfficeOcrEngine optionalposition: namedpipeline: False: Caller-provided OCR engine.
OcrOptions OfficeDocumentOcrExecutionOptions optionalposition: namedpipeline: False: Optional OCR execution limits and merge behavior.
ProcessOcrOptions ProcessOfficeOcrEngineOptions optionalposition: namedpipeline: False: Configure the generic JSON file-protocol OCR process adapter.
Processor IOfficeDocumentProcessor[] optionalposition: namedpipeline: False: Additional ordered processors to run after document extraction.
ProcessorFailureBehavior OfficeDocumentProcessorFailureBehavior optionalposition: namedpipeline: Falsevalues: 3: Behavior when a processor fails.; Possible values: Throw, ContinueWithDiagnostic, StopWithDiagnostic
ReaderAllOptions ReaderAllOptions optionalposition: namedpipeline: False: Optional format-specific settings captured while OfficeIMO Reader handlers are registered.
TesseractOptions TesseractOcrEngineOptions optionalposition: namedpipeline: False: Configure the built-in Tesseract command-line OCR adapter.

Outputs

OfficeIMO.Reader.OfficeDocumentReader