Acrobat JavaScript Scripting Guide
91
Using Acrobat JavaScript in Forms
Forms Essentials
6
Setting Acrobat Form Field Properties
Acrobat Javascript provides a large number of properties and methods for determining the 
appearance and associated actions of form fields. In this section you will learn what 
properties and methods are available, and how to write JavaScripts that control the 
appearance and behavior of form fields.
Form Field Properties Topics
Format Options
Button Properties
Checkbox Properties
Combo Box Properties
Listbox Properties
Radio Button Properties
Signature Properties
Text Field Properties
Validation Options
Calculation Options
Highlighting Required Form Fields
Alerting Users Automatically for Required Form Fields
Create pdf bookmark - add, remove, update PDF bookmarks in C#.net, ASP.NET, MVC, Ajax, WinForms, WPF
Empower Your C# Project with Rapid PDF Internal Navigation Via Bookmark and Outline
add bookmark pdf; split pdf by bookmark
Create pdf bookmark - VB.NET PDF bookmark library: add, remove, update PDF bookmarks in vb.net, ASP.NET, MVC, Ajax, WinForms, WPF
Empower Your VB.NET Project with Rapid PDF Internal Navigation Via Bookmark and Outline
creating bookmarks in a pdf document; bookmarks pdf documents
Using Acrobat JavaScript in Forms
Forms Essentials
6
92
Acrobat JavaScript Scripting Guide
Format Options
Format options applicable to form fields are applied to appearance, validation of data, and 
calculation of results, and differ according to field type. The 
field
class contains many 
properties that may be used to set the format of a given form field. The most basic property 
of every form field is its 
name
, which provides the reference necessary for subsequent 
access and modification.
General formatting options that apply to all form fields include the display rectangle, 
border style, border line thickness, stroke color, orientation, background color, and tooltip. 
In addition, you can choose whether it should be read only, have the ability to scroll, and be 
visible on screen or in print.
There are also specific settings you can apply to text characteristics, button and icon size 
and position relationships, button appearance when pushed, check box and radio button 
glyph appearance, and the number and selection options for combo box and list box items.
All formatting options are listed and described below in Table 6.2.
T
ABLE
6.2
Format Options
Format
Description
Field Properties
display 
rectangle
position and size of field on 
page
rect
border style
rectangle border appearance
borderStyle
stroke color
applied to edge of surrounding 
rectangle
strokeColor
border 
thickness
width of the edge of the 
surrounding rectangle
lineWidth
orientation
rotation of field in 90-degree 
increments
rotation
background 
color
background color of field (gray, 
transparent, RGB, or CMYK)
fillColor
tooltip
short description of field that 
appears on mouse-over
userName
read only
whether the user may change 
the field contents
readonly
scrolling
whether text fields may scroll
doNotScroll
display
visible or hidden on screen or in 
print
display
VB.NET Create PDF from Excel Library to convert xlsx, xls to PDF
Link: Edit URL. Bookmark: Edit Bookmark. Metadata: Edit, Delete Text. Add Text Box. Drawing Markups. PDF Print. Work Barcode Read. Barcode Create. OCR. Twain. Create
bookmarks in pdf; acrobat split pdf bookmark
VB.NET Create PDF from Word Library to convert docx, doc to PDF in
Easy to create searchable and scanned PDF files from Word. Ability to get word count of PDF pages. Change Word hyperlink to PDF hyperlink and bookmark.
how to add bookmarks on pdf; how to bookmark a page in pdf document
Acrobat JavaScript Scripting Guide
93
Using Acrobat JavaScript in Forms
Forms Essentials
6
text
font, color, size, rich text, comb 
format, multiline, limit to 
number of characters, file 
selection format, or password 
format
textFont, textColor, 
textSize, richText, 
richValue, comb, 
multiline, charLimit, 
fileSelect, password
text alignment controls text layout in text fields alignment
button 
alignment
controls alignment of icon on 
button face
buttonAlignX, 
buttonAlignY
button icon 
scaling
relative scaling of an icon to fit 
inside a button face
buttonFitBounds, 
buttonScaleHow, 
buttonScaleWhen
highlight mode indicates how a button will 
appear when pushed
highlight
glyph style
for checkbox and radio buttons style
number of 
items
number of items in a combo 
box or list box
numItems
editable
whether the user can type in a 
combo box
editable
multiple 
selection
whether multiple listbox items 
may be selected
multipleSelection
T
ABLE
6.2
Format Options
Format
Description
Field Properties
C# Create PDF from Word Library to convert docx, doc to PDF in C#.
Easy to create searchable and scanned PDF files from Word. Able to get word count in PDF pages. Change Word hyperlink to PDF hyperlink and bookmark.
create bookmarks pdf file; pdf create bookmarks
VB.NET PDF Convert to Tiff SDK: Convert PDF to tiff images in vb.
Qualified Tiff files are exported with high resolution in VB.NET. Create multipage Tiff image files from PDF in VB.NET project. Support
creating bookmarks in pdf files; edit pdf bookmarks
Using Acrobat JavaScript in Forms
Forms Essentials
6
94
Acrobat JavaScript Scripting Guide
Button Properties
We will begin by creating a button named 
myButton
:
var f = this.addField("myButton", "button", 0, [200, 250, 250, 400]);
To create a blue border along the edges of its surrounding rectangle, we will set its 
strokeColor
property:
f.strokeColor = color.blue;
In addition, you may select from one of the following choices to specify its border style: 
solid (
border.s
), beveled (
border.b
), dashed (
border.d
), inset (
border.i
), or 
underline (
border.u
). In this case we will make the border appear beveled by setting its 
borderStyle
property:
f.borderStyle = border.b;
To set the line thickness (in points) of the border, set its 
lineWidth
property:
f.lineWidth = 1;
To set its background color to yellow, we will set its 
fillColor
property:
f.fillColor = color.yellow;
To specify the text that appears on the button, invoke its 
buttonSetCaption
method:
f.buttonSetCaption("Click Here");
You may set the text size, color, and font:
f.textSize = 16;
f.textColor = color.red;
f.textFont = font.Times;
To create a tooltip that appears when the mouse hovers over the button, set its 
userName
property:
f.userName = "This is a button tooltip for myButton.";
In addition to the text, it is also possible to specify the relative positioning of the icon and 
text on the button’s face. In this case, we will set the layout so that the icon appears to the 
left of the text:
f.buttonPosition = position.iconTextH;
To specify whether the button should be visible either on screen or when printing, set its 
display
property:
f.display = display.visible;
To set the button’s appearance in response to user interaction, set its 
highlight
property to one of the following values: none 
(
highlight.n
)
, invert 
(
highlight.i
)
push 
(
highlight.p
)
, or outline 
(
highlight.o
)
.
In this example , we will specify that 
the button appears to be pushed:
f.highlight = highlight.p;
C# Create PDF from Tiff Library to convert tif images to PDF in C#
Create PDF from Tiff. |. Home ›› XDoc.PDF ›› C# PDF: Create PDF from Tiff. Create PDF from Tiff in both .NET WinForms and ASP.NET application.
create bookmarks pdf files; add bookmark pdf file
C# Create PDF from Excel Library to convert xlsx, xls to PDF in C#
C#.NET PDF SDK- Create PDF from Word in Visual C#. Online C#.NET Tutorial for Create PDF from Microsoft Office Excel Spreadsheet Using .NET XDoc.PDF Library.
how to add a bookmark in pdf; bookmarks pdf file
Acrobat JavaScript Scripting Guide
95
Using Acrobat JavaScript in Forms
Forms Essentials
6
It is possible to specify the scaling characteristics of the icon within the button face. You 
may determine when scaling takes place by setting the button’s 
buttonScaleWhen
property to one of the following values: always (
scaleWhen.always
), never 
(
scaleWhen.never
), if the icon is too big (
scaleWhen.tooBig
), or if the icon is too 
small (
scaleWhen.tooSmall
). In this case, we will specify that the button always scales:
f.buttonScaleWhen = scaleWhen.always;
You may also determine whether the scaling will be proportional by setting the 
buttonScaleHow
property to one of the following values: 
buttonScaleHow.proportional
or 
buttonScaleHow.anamorphic
. In this case, 
we will specify that the button scales proportionally:
f.buttonScaleHow = buttonScaleHow.proportional;
To guarantee that the icon scales within the bounds of the rectangular region for the 
button, set the 
buttonFitBounds
property:
f.buttonFitBounds = true;
You can specify the alignment characteristics of the icon by setting its 
buttonAlignX
and 
buttonAlignY
properties. This is done by specifying the percentage of the unused 
horizontal space from the left or the vertical space from the bottom that is distributed. A 
value of 
50
would mean that the 50 percent of the unused space would be distributed to 
the left or bottom of the icon (centered). We will center our icon in both dimensions:
f.buttonAlignX = 50;
f.buttonAlignY = 50;
Now that you have prepared the space within the button for the icon, you can import an 
icon into the document and place it within the button’s area. To import an icon, invoke the 
doc
object’s 
importIcon
method. To place the icon in the button, invoke the button 
object’s 
setIcon
method. Assuming you have already made the icon available in the 
document and that its variable name is 
myIcon
, the following code would cause the icon 
to appear on the button’s face:
f.setIcon(myIcon);
To rotate the button counterclockwise, set its 
rotation
property:
f.rotation = 90;
Finally, you will undoubtedly wish to associate an action to be executed when the button is 
clicked. You may do this by invoking the button’s 
setAction
method, which requires a 
trigger (an indication of the type of mouse event) and an associated script. The possible 
triggers are 
MouseUp
MouseDown
MouseEnter
MouseExit
OnFocus
, and 
OnBlur
The following code displays a greeting when the button is clicked:
f.setAction("MouseUp", "app.alert(‘Hello’);" );
C# Create PDF from PowerPoint Library to convert pptx, ppt to PDF
C#.NET PDF SDK- Create PDF from PowerPoint in C#. How to Use C#.NET PDF Control to Create PDF from Microsoft PowerPoint Presentation in .NET Project.
how to create bookmark in pdf with; how to create bookmark in pdf automatically
C# Create PDF from images Library to convert Jpeg, png images to
Create PDF from Images. |. Home ›› XDoc.PDF ›› C# PDF: Create PDF from Images. C#.NET PDF - Create PDF from Images in C# with XDoc.NET PDF Control.
bookmarks pdf documents; create bookmark pdf
Using Acrobat JavaScript in Forms
Forms Essentials
6
96
Acrobat JavaScript Scripting Guide
Checkbox Properties
The checkbox field supports many of the same properties as the button, and actions are 
handled in the same manner. The properties common to bothform fields are:
userName
readonly
display
rotation
strokeColor
fillColor
lineWidth
borderStyle
textSize
textColor
In the case of 
textFont
, however, the font is always set to 
Adobe Pi
.
You may choose from six different glyph styles (the appearance of the check symbol that 
appears when the user clicks in the check box): check (
style.ch
), cross (
style.cr
), 
diamond (
style.di
), circle (
style.ci
), star (
style.st
), and square (
style.sq
). For 
example, the following code causes a check to appear when the user clicks in the check 
box:
f.style = style.ch;
When the user selects a check box, an export value may be associated with the option 
invoking the 
field
object’s 
setExportValues
property. For example, the code below 
associates the export value 
"buy"
with the check box:
f.setExportValues(["buy"]);
If there are several check box fields, you may wish to indicate that one particular form field 
is always checked by default. To do this, you must do two things:
1. Invoke the field’s 
defaultIsChecked
method. Note that since there may be several 
check boxes that belong to the same group, the method requires that you specify the 
zero-based index of the particular check box.
2. Reset the field to ensure that the default is applied by invoking the 
doc
object’s 
resetForm
method.
This process is shown in the following code:
f.defaultIsChecked(0); // 0 means that check box #0 is checked
this.resetForm([f.name]);
Acrobat JavaScript Scripting Guide
97
Using Acrobat JavaScript in Forms
Forms Essentials
6
Combo Box Properties
The combo box has the same properties as the button and check box fields. Its primary 
differences lie in its nature. Since the combo box maintains an item list in which the user 
may be allowed to enter custom text, it offers several properties that support its formatting 
options.
If you would like the user to be permitted to enter custom text, set the field’s 
editable
property, as shown in the following code:
f.editable = true;
You may decide whether the user’s custom text will be checked for spelling by setting its 
doNotSpellCheck
property. The following code indicates that the spelling is not 
checked:
f.doNotSpellCheck = true;
A combo box may interact with the user in one of two ways: either a selection automatically 
results in a response, or the user first makes their selection and then takes a subsequent 
action, such as clicking a Submit button. 
In the first case, as soon as the user clicks on an item in the combo box, an action may 
automatically be triggered. If you would like to design your combo box this way, then set its 
commitOnSelChange
property to 
true
. Otherwise, set the value to 
false
. The 
following code commits the selected value immediately:
f.commitOnSelChange = true;
To set the export values for the combo box items, invoke its 
setItems
method, which can 
be used to set both the user and export values. In this case, the user value (the value that 
appears in the combo box) is the first value in every pair, and the export value is the second. 
The following code results in the full state names appearing in the combo box, with 
abbreviated state names as their corresponding export values:
f.setItems( ["Ohio", "OH"], ["Oregon", "OR"], ["Arizona", "AZ"] );
In many cases, it is desirable to maintain a sorted collection of values in a combo box. In 
order to do this, you will need to write your own sorting script. Recall that the JavaScript 
Array
object has a 
sort
method that takes an optional argument which may be a 
comparison function. 
This means that you must first define a 
compare
function that accepts two parameters. 
The function must return a negative value when the first parameter is less than the second, 
0 if the two parameters are equivalent, and a positive value if the first parameter is greater. 
Using Acrobat JavaScript in Forms
Forms Essentials
6
98
Acrobat JavaScript Scripting Guide
In the following example, we define a 
compare
function that accepts two parameters, 
both of which are user/export value pairs, and compares their user values. For example, if 
the first parameter is
["Ohio", "OH"]
and the second parameter is 
["Arizona", "AZ"]
the 
compare
function returns 1, since 
"Ohio" 
is greater than 
"Arizona"
:
function compare (a,b)
{
if (a[0] < b[0]) return -1; // index 0 means user value
if (a[0] > b[0]) return 1;
return 0;
}
Create a temporary array of values and populate it with the user/export value pairs in your 
combo box field. The following code creates the array, iterates through the combo box 
items, and copies them into the array:
var arr = new Array();
var f = this.getField("myCombobox");
for (var i = 0; i < f.numItems; i++)
arr[i] = [f.getItemAt(i,false), f.getItemAt(i)];
At this point you may invoke the 
Array
object’s 
sort
method and replace the items in the 
combo box field:
arr.sort(compare); // sort the array using your compare method
f.clearItems();
f.setItems(arr);
To specify whether the combo box automatically formats its entries as numbers, 
percentage values, or other specialized formats, you may use the functions shown below in 
Table 6.3. Their definitions are located in the file 
Javascripts\aform.js
:
In all cases, invoke the method and pass in the 
"Format"
trigger name as the first 
parameter, followed by a script containing a call to one of the functions. For example, the 
code below sets up the Number format:
f.setAction("Format", ‘AFNumberFormat(2,0,0,0,"\u20ac",true)’);
N
OTE
:
You may also create Custom formatting.
T
ABLE
6.3
Combobox Formatting Functions
Format
Function
Number
AFNumber_Format
Percentage
AFPercent_Format
Date
AFDate_FormatEx
Time
AFTime_Format
Special
AFSpecialFormat
Acrobat JavaScript Scripting Guide
99
Using Acrobat JavaScript in Forms
Forms Essentials
6
Listbox Properties
A list box has many of the same properties as buttons and combo boxes, except for the fact 
that the user may not enter custom text and, consequently, that spellchecking is not 
available. 
However, the user may select multiple entries. To enable this feature, set its 
multipleSelection
property to 
true
, as shown in the code below:
f.multipleSelection = true;
To set up an action associated with a selected item, invoke its 
setAction
method and 
pass in the
"Keystroke"
trigger name as the first parameter, as shown in the code below:
f.setAction( "Keystroke", "myListboxJavascript();" );
Radio Button Properties
The unique nature of radio buttons is that they are always created in sets, and represent a 
collection of mutually exclusive choices. This means that when you create a set of radio 
buttons, you must give all of them identical names and access them with zero-based 
numeric indices, as you learned earlier in Creating Acrobat Form Fields.
Radio buttons have many of the same properties as buttons and check boxes.
Signature Properties
Signature fields have many of the same properties as buttons. You may set the action of a 
signature field by invoking its 
setAction
method and passing in the 
"Format"
trigger 
name as the first parameter. When the user signs the form, you may reformat other form 
fields with the script you pass into the 
setAction
method.
Once a document is signed, you may wish to lock certain form fields within the document. 
You may do so by creating a script containing a call to the signature field’s 
setLock
method and passing that script as the second parameter to the signature field’s 
setAction
method. 
The 
setLock
method requires a 
Lock
object, which you will obtain by invoking the form 
field’s 
getLock
method. Once you obtain the 
Lock
object, set its 
action
and 
fields
properties. The 
action
property can be set to one of 3 values: 
"All"
(lock all fields), 
"exclude"
(lock all fields except for these), or 
"include"
(lock only these fields). The 
fields
property is an array of fields.
For example, suppose you created a signature and would like to lock the form field whose 
name is 
myField
after the user signs the document. The following code would lock 
myField
:
var oLock = f.getLock();
oLock.action = "include";
oLock.fields = new Array("myField");
f.setLock(oLock);
To actually sign a document, you must do two things: choose a security handler, and then 
invoke the signature field’s 
signatureSign
method. The following code is an example of 
how to choose a handler and actually sign the document:
Using Acrobat JavaScript in Forms
Forms Essentials
6
100
Acrobat JavaScript Scripting Guide
var ppklite = security.getHandler("Adobe.PPKLite");
var oParams = {
password: "myPassword", 
cDIPath: "/C/signatures/myName.pfx" // digital signature profile
};
ppklite.login(oParams);
f.signatureSign(ppklite,
{
password: "myPassword",
location: "San Jose, CA",
reason: "I am approving this document",
contactInfo: "userName@adobe.com",
appearance: "Fancy"
}
); //end of signature
Text Field Properties
The text field has many of the same properties as buttons and combo boxes. In addition, it 
offers the following specialized properties shown below in Table 6.4:
T
ABLE
6.4
Text Field Formatting
Property
Description
Example
alignment
justify text
f.alignment = "center";
defaultValue
set a default text string
f.defaultValue = "Name: ";
multiline
allow multiple lines in the 
area
f.multiline = true;
doNotScroll
permit scrolling of long text f.doNotScroll = true;
richText
set rich text formatting
f.richText = true;
charLimit
limit on number of 
characters in area
f.charLimit = 40;
password
use special formatting to 
protect the user’s password
f.password = true;
fileSelect
format field as a file 
pathname
f.fileSelect = true;
doNotSpellCheck
set spell checking
f.doNotSpellCheck = true;
comb
comb of characters subject 
to limitation set by 
charLimit
f.comb = true;
Documents you may be interested
Documents you may be interested