Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, PowerShell module, CLI, Studio and browser tools 606 stars

Talk and help

DiscordQuestions, ideas and show and tell Report an issueBugs and feature requests SponsorFund ongoing development

Mode

Background

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Search the whole siteOpen search page →
Documentation Search all OfficeIMO/
Cmdlet

New-OfficeDocumentReader

Module PSWriteOffice
Inputs
None
Outputs
OfficeIMO.Reader.OfficeDocumentReader
Source
NewOfficeDocumentReaderCommand.cs:24 Edit on GitHub

Creates an immutable fully configured OfficeIMO document reader.

Syntax

New-OfficeDocumentReader [-AllStoreItems] [-MaxConcurrentReads <Int32>] [-MaxStoreItems <Int32>] [-OcrLanguage <TesseractOcrLanguage[]>] [-ProcessorFailureBehavior <Throw|ContinueWithDiagnostic|StopWithDiagnostic>] [-TesseractDataPath <String>] [-TesseractDpi <Int32>] [-TesseractExecutablePath <String>] [-TesseractLanguage <String>] [-TesseractTimeoutSeconds <Int32>] [-UseTesseract] [<CommonParameters>]
#
Parameter set: All Parameter Sets

Guides & Samples

Authored walkthroughs and practical samples linked to this command.

  • Choose a PSWriteOffice Workflow Guide

    Decide between authoring, editing, inspection, conversion, and normalized Reader extraction. Includes examples and cmdlet links.

Examples

Authored help example

Create a reader with OCR and a resilient processor policy.

$reader = New-OfficeDocumentReader -OcrLanguage English, Polish -MaxStoreItems 5000 -ProcessorFailureBehavior ContinueWithDiagnostic

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

Parameters

-AllStoreItems SwitchParameter optional
Project every matching item from each email store.
-MaxConcurrentReads Int32 optional
Maximum asynchronous reads allowed in flight.
-MaxStoreItems Int32 optional
Maximum PST, OST, OLM, or EMLX items projected from each store. The default is 1,000.
-OcrLanguage TesseractOcrLanguage[] optional
Friendly OCR languages used by the built-in Tesseract adapter.
Possible values: English, Polish, Arabic, ChineseSimplified, ChineseTraditional, Czech, Danish, Dutch, Finnish, French, German, Greek, Hebrew, Hindi, Hungarian, Italian, Japanese, Korean, Norwegian, Portuguese, Romanian, Russian, Slovak, Spanish, Swedish, Turkish, Ukrainian, Vietnamese
-ProcessorFailureBehavior OfficeDocumentProcessorFailureBehavior optional
Behavior when a processor fails.
Possible values: Throw, ContinueWithDiagnostic, StopWithDiagnostic
-TesseractDataPath String optional
Optional Tesseract tessdata directory.
-TesseractDpi Int32 optional
Optional input DPI passed to Tesseract.
-TesseractExecutablePath String optional
Tesseract executable path or command name.
-TesseractLanguage String optional
Advanced raw Tesseract expression for caller-installed custom trained-data models.
-TesseractTimeoutSeconds Int32 optional
Maximum Tesseract process duration in seconds. The default is 120.
-UseTesseract SwitchParameter optional
Enable the built-in Tesseract command-line OCR adapter with default settings.

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.