Quick bars

At the beginning of most property and method descriptions, a small table or quick bar provides a summary of the item’s availability and usage recommendations.

The quick bar shown here has descriptive column headings that are not shown in the reference.

Version or
Deprecated

Save and
Preferences

Security

Availability

6.0

D 

S 

C 

The following tables show the symbols that can appear in each column and their meanings.

Column 1: Version or deprecated

#.#

A number indicates the version of the software in which a property or method became available. If the number is specified, the property or method is available only in versions of the Acrobat software greater than or equal to that number.

For Acrobat 8.0, there are some compatibility issues with older versions. Before accessing the property or method, the script should check that the forms version is greater than or equal to that number to ensure backward compatibility. For example:

if (typeof app.formsVersion != "undefined" && app.formsVersion >= 8.0) 
{ 
  // Perform version specific operations. 
} 

If the first column is blank, no compatibility checking is necessary.

X 

The property or method is deprecated.

Column 2: Save and Preferences

D 

Writing to this property or method dirties (modifies) the PDF document. If the document is subsequently saved, the effects of this method are saved as well. (In Adobe Reader, the document requires specific rights to be saved.)

P 

Even though this property does not change the document, it can permanently change a user’s application preferences.

Column 3: Security

S 

 For security reasons, this property or method may be available only during certain events. These events include batch processing, application start, or execution within the console. (See the event object for details of the Acrobat events.)

Beginning with Acrobat 7.0, to execute a security-restricted method through a menu event, one of the following must be true:

  • The JavaScript user preferences item Enable Menu Items JavaScript Execution Privileges is checked.

  • The method is executed through a trusted function. For details and examples, see the app.trustedFunction method.

See Privileged versus non-privileged context for more information.

Note:(Acrobat 6.0 or later) Methods marked with S will execute without restriction in a certified document provided the certifier’s certificate is trusted for running embedded high privilege JavaScript and other limitations in the quick bar fields are met.

Column 4: Availability

 

If the column is blank, the property or method is allowed in Adobe Reader, Acrobat Pro or Acrobat Standard.

X 

The property or method is not allowed in Adobe Reader but is available in Acrobat Pro and Acrobat Standard.

F
C
S
D
G
 

The property or method is allowed in Acrobat Pro and Acrobat Standard. It can be accessed in Adobe Reader (version 5.1 or later) depending on additional usage rights that have been applied to the document:

  • F — Requires forms rights

  • C — Requires the right to manipulate comments

  • S — Requires the document save right

  • D — Requires file attachment rights

  • G — Requires digital signature rights

P 

The property or method is available only in Acrobat Pro