Project

PSWriteOffice

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

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

API Reference

Cmdlet

Get-OfficeImageText

Namespace PSWriteOffice
Inputs
System.String
Outputs
System.String OfficeIMO.Ocr.OcrResult
Source
Sources/PSWriteOffice/Cmdlets/Ocr/GetOfficeImageTextCommand.cs:25 Edit on GitHub

Recognizes text in an image with automatic local OCR runtime discovery.

Remarks

Recognizes text in an image with automatic local OCR runtime discovery.

Examples

Authored help example

Read English text from an image.

PS>


Get-OfficeImageText -Path .\Scan.png

Returns recognized text and automatically uses an installed Tesseract runtime.

Read English and Polish text with recognition evidence.

PS>


Get-OfficeImageText -Path .\Scan.png -Language English, Polish -PassThru

Returns the full OCR result, including confidence, word geometry, provider, model, and diagnostics.

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

Get-OfficeImageText [-Language <English>] [-NoLanguageDownload] [-Options <TesseractOcrSessionOptions>] [-PassThru] -Path <String> [-TessdataDirectory <String>] [-TesseractLanguageExpression <String>] [-TesseractPath <String>] [<CommonParameters>]
#
Parameter set: All Parameter Sets

Parameters

Language TesseractOcrLanguage[] optionalposition: namedpipeline: Falsevalues: 28
Friendly OCR languages. Supply more than one value to recognize multilingual content.
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
NoLanguageDownload SwitchParameter optionalposition: namedpipeline: False
Do not download checksum-pinned curated language data when a requested language is missing.
Options TesseractOcrSessionOptions optionalposition: namedpipeline: False
Advanced OfficeIMO OCR options. Convenience parameters override matching values.
PassThru SwitchParameter optionalposition: namedpipeline: False
Return the complete OCR result instead of recognized text only.
Path String requiredposition: 0pipeline: True (ByValue)aliases: FilePath
PNG, JPEG, TIFF, BMP, GIF, WebP, or JPEG 2000 image path.
TessdataDirectory String optionalposition: namedpipeline: False
Explicit directory containing Tesseract trained-data files.
TesseractLanguageExpression String optionalposition: namedpipeline: False
Advanced raw Tesseract expression for caller-installed custom trained-data models.
TesseractPath String optionalposition: namedpipeline: False
Explicit Tesseract executable path. By default OfficeIMO securely discovers an installed runtime.

Outputs

System.String, OfficeIMO.Ocr.OcrResult