Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Cmdlet

Get-OfficePdfText

Module PSWriteOffice
Inputs
System.String

Extracts text or Markdown from a PDF.

Syntax

Get-OfficePdfText [-AsMarkdown] [-AsTextBlock] [-ByPage] [-IgnorePermissionRestrictions] [-OutputPath <String>] [-PageRange <String>] [-Password <String>] [-Path] <String> [<CommonParameters>]
#
Parameter set: All Parameter Sets

Examples

Authored help example

Extract text and Markdown from a PDF.

$proof = @(
    Get-OfficePdfText -Path .\Examples\Documents\Report.pdf -PageRange '1'
    Get-OfficePdfText -Path .\Examples\Documents\Report.pdf -AsMarkdown -OutputPath .\Examples\Documents\ReportText.md
)
$proof

Reads plain text directly and writes Markdown readback to a file.

Parameters

-AsMarkdown SwitchParameter optional
Return logical Markdown instead of plain text.
-AsTextBlock SwitchParameter optional
Return line-level logical text blocks with page and coordinate metadata.
-ByPage SwitchParameter optional
Return one object per page with PageNumber and Text properties.
-IgnorePermissionRestrictions SwitchParameter optional
After successful password authentication, explicitly ignore owner-imposed extraction restrictions.
-OutputPath String optional
Optional output text file path.
-PageRange String optional
Optional page ranges such as 1-3,5.
-Password String optional
Password used to extract from a Standard password-encrypted PDF.
-Path String requiredposition: 0pipeline: True (ByValue, ByPropertyName)aliases: FilePath, FullName, LiteralPath
PDF file path.

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.