Project

PSWriteOffice

PowerShell document automation across Word, Excel, PowerPoint, PDF, Reader, Confluence, Visio, and open text formats.

View on GitHub Releases Get package
Stars 159
Forks 14
PowerShell Gallery downloads 158,661
Release v3.0.5
Language: C# Updated: 2026-09-03

API Reference

Cmdlet

Remove-OfficePdfAnnotation

Namespace PSWriteOffice
Inputs
System.String
Outputs
System.IO.FileInfo OfficeIMO.Pdf.PdfAnnotationEditResult
Source
Sources/PSWriteOffice/Cmdlets/Pdf/RemoveOfficePdfAnnotationCommand.cs:17 Edit on GitHub

Removes PDF annotations matching friendly filters.

Remarks

Removes PDF annotations matching friendly filters.

Examples

Authored help example

Remove text annotations from the first page.

PS>


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

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

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

Parameters

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

Outputs

System.IO.FileInfo, OfficeIMO.Pdf.PdfAnnotationEditResult