Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, PowerShell module, CLI, Studio and browser tools 622 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

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

Guides & Samples

Authored walkthroughs and practical samples linked to this command.

Examples

Authored help example

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.