Project

PSWriteOffice

PowerShell document automation across Word, Excel, PowerPoint, PDF, Reader, Confluence, Visio, and open text formats.

View on GitHub Releases Get package
Stars 162
Forks 15
PowerShell Gallery downloads 158,661
Release v3.0.7
Language: C# Updated: 2026-09-24

API Reference

Cmdlet

New-OfficeDocumentReader

Namespace PSWriteOffice
Inputs
None
Outputs
OfficeIMO.Reader.OfficeDocumentReader
Source
Sources/PSWriteOffice/Cmdlets/Reader/NewOfficeDocumentReaderCommand.cs:24 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>


$reader = New-OfficeDocumentReader -OcrLanguage English, Polish -MaxStoreItems 5000 -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 [-AllStoreItems] [-MaxConcurrentReads <Int32>] [-MaxStoreItems <Int32>] [-OcrLanguage <English>] [-ProcessorFailureBehavior <Throw|ContinueWithDiagnostic|StopWithDiagnostic>] [-TesseractDataPath <String>] [-TesseractDpi <Int32>] [-TesseractExecutablePath <String>] [-TesseractLanguage <String>] [-TesseractTimeoutSeconds <Int32>] [-UseTesseract] [<CommonParameters>]
#
Parameter set: All Parameter Sets

Parameters

AllStoreItems SwitchParameter optionalposition: namedpipeline: False
Project every matching item from each email store.
MaxConcurrentReads Int32 optionalposition: namedpipeline: False
Maximum asynchronous reads allowed in flight.
MaxStoreItems Int32 optionalposition: namedpipeline: False
Maximum PST, OST, OLM, or EMLX items projected from each store. The default is 1,000.
OcrLanguage TesseractOcrLanguage[] optionalposition: namedpipeline: Falsevalues: 28
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 optionalposition: namedpipeline: Falsevalues: 3
Behavior when a processor fails.
Possible values: Throw, ContinueWithDiagnostic, StopWithDiagnostic
TesseractDataPath String optionalposition: namedpipeline: False
Optional Tesseract tessdata directory.
TesseractDpi Int32 optionalposition: namedpipeline: False
Optional input DPI passed to Tesseract.
TesseractExecutablePath String optionalposition: namedpipeline: False
Tesseract executable path or command name.
TesseractLanguage String optionalposition: namedpipeline: False
Advanced raw Tesseract expression for caller-installed custom trained-data models.
TesseractTimeoutSeconds Int32 optionalposition: namedpipeline: False
Maximum Tesseract process duration in seconds. The default is 120.
UseTesseract SwitchParameter optionalposition: namedpipeline: False
Enable the built-in Tesseract command-line OCR adapter with default settings.

Outputs

OfficeIMO.Reader.OfficeDocumentReader