Get-OfficePdfText

Namespace PSWriteOffice

Inputs

System.String

Outputs

System.Object

Source

Sources/PSWriteOffice/Cmdlets/Pdf/GetOfficePdfTextCommand.cs:20 Edit on GitHub

Extracts text or Markdown from a PDF.

Remarks

Extracts text or Markdown from a PDF.

Examples

Authored help example

Extract text and Markdown from a PDF.

PS>


$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.

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-OfficePdfText [-AsMarkdown] [-AsTextBlock] [-ByPage] [-OutputPath <String>] [-PageRange <String>] [-Password <String>] -Path <String> [<CommonParameters>]

Parameter set: All Parameter Sets

Parameters

AsMarkdown SwitchParameter optionalposition: namedpipeline: False: Return logical Markdown instead of plain text.
AsTextBlock SwitchParameter optionalposition: namedpipeline: False: Return line-level logical text blocks with page and coordinate metadata.
ByPage SwitchParameter optionalposition: namedpipeline: False: Return one object per page with PageNumber and Text properties.
OutputPath String optionalposition: namedpipeline: False: Optional output text file path.
PageRange String optionalposition: namedpipeline: False: Optional page ranges such as 1-3,5.
Password String optionalposition: namedpipeline: False: Password used to extract from a Standard password-encrypted PDF.
Path String requiredposition: 0pipeline: True (ByValue)aliases: FilePath: PDF file path.

Outputs

System.Object