Project

PSWriteOffice

PowerShell document automation across OfficeIMO's document, spreadsheet, presentation, PDF, Project, Access, EPUB, invoicing, and conversion engines.

View on GitHub Releases Get package
Stars 654
Forks 82
Open issues 1
Total downloads 4,320,051
Release OfficeIMO-v3.5.3
Language: C# Updated: 2026-11-03
Cmdlet

Get-OfficePdfAnnotation

Module
PSWriteOffice
Inputs
System.String
Outputs
OfficeIMO.Pdf.PdfAnnotation
Source
GetOfficePdfAnnotationCommand.cs:10 Edit on GitHub

Gets page annotations and action evidence from a PDF.

Syntax

Get-OfficePdfAnnotation
[-IgnorePermissionRestrictions]
[-PageNumber <Int32>]
[-Password <String>]
[-Path] <String>
[-Subtype <String>]
[-WithAction]
[<CommonParameters>]
#
Parameter set: All Parameter Sets

Examples

Example 1

Get-OfficePdfAnnotation -Path 'C:\Path'

Parameters

-IgnorePermissionRestrictions SwitchParameter optional
After successful password authentication, explicitly ignore owner-imposed usage restrictions.
-PageNumber Int32 optional
Optional one-based page number filter.
-Password String optional
Password used to inspect a Standard password-encrypted PDF.
-Path String requiredposition: 0pipeline: True (ByValue)aliases: FilePath
PDF file path.
-Subtype String optional
Optional annotation subtype filter such as Text, Link, Widget, or FreeText.
-WithAction SwitchParameter optional
Return only annotations with actions, additional actions, or chained actions.

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.