PDF - Disable field(s)
Declaration
<AMPDF ACTIVITY="disable" SESSION="text" SOURCE="text" PASSWORD="text (encrypted)" SAVETYPE="text (options)" DESTINATION="text" FIELDNAME="text" />
Description
Disables one or more form fields in a PDF file.
Practical usage
PDF form fields allow information to be entered interactively by the user. A PDF file may contain any number of form fields appearing on any combination of pages, all of which make up a single, global interactive form spanning the entire document. This activity disables interactions to be performed on selected form fields of a PDF file.
Parameters
Resource
Property | Type | Required | Default | Markup | Description |
---|---|---|---|---|---|
Resource | --- | --- | --- | --- | Specifies the source of the PDF file. The available options are:
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 disable fields. 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 |
|
Specifies how changes to the PDF file are saved upon completion of this activity. The available
options are:
|
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. |
Field
Property | Type | Required | Default | Markup | Description |
---|---|---|---|---|---|
AcroForm | --- | Yes | All field(s) | --- | Specifies the fields to disable. The
available options are:
NOTE: This parameter does not contain markup and is only displayed in visual mode for task construction and configuration purposes. |
Specific field name(s) | Text | Yes, if AcroForm is set to Specific file name(s) | (Empty) | FIELDNAME="Field1" | The names of the form fields
to disable. Use a comma (,) to specify more than one field (for example,
Field1,Field2,Field5). NOTE: Use the Get
field(s) activity to retrieve information about one or more
form fields contained in a PDF file. |
Example
- 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 disables three fields from a PDF file and then saves it using a different file name.
<AMPDF ACTIVITY="disable" SOURCE="C:\temp\sourcePDF.pdf" SAVETYPE="save_as" DESTINATION="C:\temp\NewPDF.pdf" FIELDNAME="Field1,Field2,Field3" />