Get-OfficePdfAnnotation

Namespace PSWriteOffice

Inputs

System.String

Outputs

OfficeIMO.Pdf.PdfAnnotation

Source

Sources/PSWriteOffice/Cmdlets/Pdf/GetOfficePdfAnnotationCommand.cs:8 Edit on GitHub

Gets page annotations and action evidence from a PDF.

Remarks

Gets page annotations and action evidence from a PDF.

Examples

Authored help example

EXAMPLE 1


Get-OfficePdfAnnotation -Path 'C:\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.

Syntax

Get-OfficePdfAnnotation [-PageNumber <Nullable`1>] [-Password <String>] -Path <String> [-Subtype <String>] [-WithAction] [<CommonParameters>]

Parameter set: All Parameter Sets

Parameters

PageNumber Nullable`1 optionalposition: namedpipeline: False: Optional one-based page number filter.
Password String optionalposition: namedpipeline: False: Password used to inspect a Standard password-encrypted PDF.
Path String requiredposition: 0pipeline: True (ByValue)aliases: FilePath: PDF file path.
Subtype String optionalposition: namedpipeline: False: Optional annotation subtype filter such as Text, Link, Widget, or FreeText.
WithAction SwitchParameter optionalposition: namedpipeline: False: Return only annotations with actions, additional actions, or chained actions.

Outputs

OfficeIMO.Pdf.PdfAnnotation