Remove-OfficePdfAnnotation

Namespace PSWriteOffice

Inputs

System.String

Outputs

System.IO.FileInfo OfficeIMO.Pdf.PdfAnnotationEditResult

Source

Sources/PSWriteOffice/Cmdlets/Pdf/RemoveOfficePdfAnnotationCommand.cs:12 Edit on GitHub

Removes PDF annotations matching friendly filters.

Remarks

Removes PDF annotations matching friendly filters.

Examples

Authored help example

EXAMPLE 1


Remove-OfficePdfAnnotation -Path 'C:\Path'

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>] [-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.
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