Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, PowerShell module, CLI, Studio and browser tools 606 stars

Talk and help

DiscordQuestions, ideas and show and tell Report an issueBugs and feature requests SponsorFund ongoing development

Mode

Background

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Search the whole siteOpen search page →
Documentation Search all OfficeIMO/
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

Guides & Samples

Authored walkthroughs and practical samples linked to this command.

Examples

Authored help example

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.