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

Set-OfficePdfAnnotation

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

Updates a single indirect PDF annotation.

Remarks

Updates a single indirect PDF annotation.

Examples

Authored help example

EXAMPLE 1


Set-OfficePdfAnnotation -ObjectNumber 1

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

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

Parameters

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

Outputs

System.IO.FileInfo, OfficeIMO.Pdf.PdfAnnotationEditResult