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

Remove-OfficePdfAnnotation

Module PSWriteOffice
Inputs
System.String
Outputs
System.IO.FileInfo OfficeIMO.Pdf.PdfAnnotationEditResult
Source
RemoveOfficePdfAnnotationCommand.cs:17 Edit on GitHub

Removes PDF annotations matching friendly filters.

Syntax

Remove-OfficePdfAnnotation [-IgnorePermissionRestrictions] [-KeepPopups] [-ObjectNumber <Int32>] [-OutputPath] <String> [-PageNumber <Int32>] [-PassThru] [-PassThruReport] [-Password <String>] [-Path] <String> [-Subtype <String>] [<CommonParameters>]
#
Parameter set: All Parameter Sets

Guides & Samples

Authored walkthroughs and practical samples linked to this command.

Examples

Authored help example

Remove text annotations from the first page.

Remove-OfficePdfAnnotation -Path .\Reviewed.pdf -OutputPath .\Clean.pdf -PageNumber 1 -Subtype Text -Confirm:$false

Parameters

-IgnorePermissionRestrictions SwitchParameter optional
After successful password authentication, explicitly ignore owner-imposed annotation-modification restrictions.
-KeepPopups SwitchParameter optional
Keep popup annotations linked from matching annotations through /Popup.
-ObjectNumber Int32 optional
Specific annotation object number to remove.
-OutputPath String requiredposition: 1
Output PDF path.
-PageNumber Int32 optional
Optional one-based page number filter.
-PassThru SwitchParameter optional
Emit the object created or changed by the command.
-PassThruReport SwitchParameter optional
Return the annotation edit result instead of the output file.
-Password String optional
Password used to authenticate an encrypted PDF.
-Path String requiredposition: 0pipeline: True (ByValue)aliases: FilePath
Input PDF path.
-Subtype String optional
Optional annotation subtype filter such as Text, Link, Widget, or FreeText.

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.