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

Set-OfficePdfAnnotation

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

Updates a single indirect PDF annotation.

Syntax

Set-OfficePdfAnnotation
[-Color <String>]
[-Contents <String>]
[-Flags <Int32>]
[-IgnorePermissionRestrictions]
[-Name <String>]
-ObjectNumber <Int32>
[-OutputPath] <String>
[-PassThru]
[-PassThruReport]
[-Password <String>]
[-Path] <String>
[-RemoveAction]
[-Title <String>]
[<CommonParameters>]
#
Parameter set: All Parameter Sets

Examples

Example 1

Set-OfficePdfAnnotation -Path 'C:\Path' -OutputPath 'C:\Path' -ObjectNumber 1

Parameters

-Color String optional
Replacement annotation color. Named colors and hexadecimal values are accepted.
-Contents String optional
Replacement annotation contents text.
-Flags Int32 optional
Replacement annotation flags.
-IgnorePermissionRestrictions SwitchParameter optional
After successful password authentication, explicitly ignore owner-imposed annotation-modification restrictions.
-Name String optional
Replacement annotation name.
-ObjectNumber Int32 required
Indirect annotation object number to update.
-OutputPath String requiredposition: 1
Output PDF path.
-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.
-RemoveAction SwitchParameter optional
Remove /A and /AA action dictionaries from the annotation.
-Title String optional
Replacement annotation title text.

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.