Get-OfficePdf

Namespace PSWriteOffice

Inputs

System.String

Outputs

OfficeIMO.Pdf.PdfDocument

Source

Sources/PSWriteOffice/Cmdlets/Pdf/GetOfficePdfCommand.cs:15 Edit on GitHub

Opens an existing PDF as an OfficeIMO.Pdf document.

Remarks

Opens an existing PDF as an OfficeIMO.Pdf document.

Examples

Authored help example

Open a PDF for OfficeIMO.Pdf operations.

PS>


$pdf = Get-OfficePdf -Path .\Examples\Documents\Report.pdf
            $pdf.Read.Text() | Select-Object -First 1

Returns the OfficeIMO.Pdf document object for advanced readback or operations.

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-OfficePdf [-Password <String>] -Path <String> [<CommonParameters>]

Parameter set: All Parameter Sets

Parameters

Password String optionalposition: namedpipeline: False: Password used to open a Standard password-encrypted PDF for readback operations.
Path String requiredposition: 0pipeline: True (ByValue)aliases: FilePath: PDF file path.

Outputs

OfficeIMO.Pdf.PdfDocument