PDF - Delete annotation(s)

Declaration

<AMPDF ACTIVITY="delete_annotation" SESSION="text" SOURCE="text" PASSWORD="text (encrypted)" SAVETYPE="text (options)" DESTINATION="text" ANNOTATIONTYPE="text (options)" ANNOTATIONTITLE="text" PAGE="number" />

Related Topics

Description

Deletes one or more annotations from a PDF file.

Practical usage

Used to permanently delete one or more annotations from a PDF file.

Parameters

Resource

Property Type Required Default Markup Description
Resource --- --- --- --- Specifies the source of the PDF file. The available options are:
  • File (default) - The source derives from a PDF file located on the system. This option is normally selected if only a single activity is required to complete the operation.
  • Session - The source PDF is obtained from a pre-configured session created in an earlier step with the use of the PDF - Create session activity. This option is normally selected if a combination of related activities is required to complete an operation. Consolidating several activities to a single session can eliminate redundancy. Moreover, a single task supports multi-session executions which can improve efficiency and speed up production.
NOTE: This parameter does not contain markup and is only displayed in visual mode for task construction and configuration purposes.
Session Text Yes, if Resource is set to Session PDFSession1 SESSION="mySession" The existing session to associate with this activity. This parameter becomes active and is required if the Resource parameter is set to Session.
Source PDF Text Yes, if Resource is set to File (Empty) SOURCE="C:\PDFFileName.pdf" The PDF path and file name of where to delete annotations. This parameter becomes active and is required if the Resource parameter is set to File.
Password (optional) Text No (Empty) PASSWORD="encrypted" The password required to open the PDF file (if required).
On completion Text (options) Yes, if Resource is set to File Save
  • SAVETYPE="save"
  • SAVETYPE="do_not_save"
  • SAVETYPE="save_as"
 Specifies how changes to the PDF file are saved upon completion of this activity. The available options are:
  • Save (default) - Changes are saved under the PDF file's original file name.
  • Do not save changes - Any changes made to the existing PDF file are not saved.
  • Save As - Changes are saved to a new path and file name.
Destination PDF Text Yes, if On completion is set to Save As (Empty) DESTINATION="C:\PDFFileName.pdf" The path and file name where the modified PDF file is stored. This parameter becomes active and is required if the On completion parameter is set to Save as.

Annotation

Property Type Required Default Markup Description
Type Text (options) Yes Text
  • ANNOTATIONTYPE="Text"
  • ANNOTATIONTYPE="FreeText"
  • ANNOTATIONTYPE="Watermark"

 

 Specifies the type of annotation to delete from the PDF file. The available options are:
  • Text (default) - The annotation is a sticky note that can be opened and closed.
  • Free Text - The annotation is text within a box that is always visible.
  • Watermark - The annotation is a watermark that appears in front of any content.
Delete --- --- --- --- Determines the annotations to delete. The available options are:
  • All - Deletes all instances of the annotation type from the PDF file.
  • Specific annotation - Deletes one or more specific annotations from the PDF file.
NOTE: This parameter does not contain markup and is only displayed in visual mode for task construction and configuration purposes.
Specific annotation Text Yes if Type is set to Text or Free Text and Delete is set to Specific annotation (Empty) ANNOTATIONTITLE="Note" The annotation titles to delete. Manually enter the desired annotation titles in the Title text box. Use a comma to delimit each entry (for example, Note,Comment,Comment2). This parameter becomes active and is required if Delete is set to Specific annotation.
NOTE: Annotation titles are case-sensitive.

Page

Property Type Required Default Markup Description
Page range --- Yes All --- Specifies the pages to delete annotations from in the PDF file. The available options are:
  • All - Deletes annotations from all pages in the PDF file.
  • Page(s) - Deletes annotations from one or more specific pages in the PDF file.
NOTE: This parameter does not contain markup and is only displayed in visual mode for task construction and configuration purposes.
Page(s) Text Yes, if Page range is set to Page(s) (Empty) PAGE="1,3,5" If selected, specifies the pages to delete annotations from in the PDF file. For a single page, enter the page number. Use a comma (,) to specify more than one page (for example, 1,3,5). Use a dash (-) to specify a range of pages (for example, 5-10).

Description

Error Causes

On Error

Examples

NOTE:
  • Copy and paste the sample AML code below directly into the Task Builder Steps Panel.
  • To successfully run the sample code, update parameters containing user credentials, files, file paths, or other information specific to the task to match your environment.

Description

This sample task deletes all instances of the annotation titled Note from pages 1 and 2 of a PDF file and then saves it using a different file name.

Copy 
<AMPDF ACTIVITY="delete_annotation" SOURCE="C:\Temp\SamplePDF.pdf" SAVETYPE="save_as" DESTINATION="C:\Temp\Output.pdf" ANNOTATIONTYPE="FreeText" ANNOTATIONTITLE="Note" PAGE="1,2" />