Supported Document JavaScript

In Xodo PDF Studio when creating custom functions/actions for specific items such as form fields, bookmarks, or document actions you will need to use JavaScript for the commands. JavaScript can perform calculations, button actions (adding images, submitting forms, or populating other fields), validate field input, and set field formatting, among many other things.

Note: Xodo PDF Studio only supports Acroform (non-LiveCycle) JavaScript in PDF forms.

You will need to have advance knowledge in programming JavaScript in order to create the actions for the buttons. For additional details on how to use these functions, take a look at the tutorials and lessons on this site http://www.w3schools.com/js/js_intro.asp

Xodo PDF Studio supports the following JavaScript commands for each of the below items.

 

Annotation

Properties:

author
page
points
strokeColor
type
width

Doc

Methods:

addAnnot
addField
calculateNow
closeDoc
flattenPages
getAnnots3D
getDataObjectContents
getField
getNthFieldName
getOCGs
getPageBox
getPageRotation
getTemplate
gotoNamedDest
importAnFDF
mailDoc
print
resetForm
spawnPageFromTemplate
submitForm

Properties:

URL
calculate
info
numFields
numPages

Field

Methods:

buttonGetCaption
buttonImportIcon
buttonSetCaption
checkThisBox
clearItems
deleteItemAt
getArray
getItemAt
insertItemAt
isBoxChecked
setAction
setFocus
setItems
signatureInfo

Properties:

borderColor
borderStyle
borderWidth
calcOrderIndex
charLimit
comb
commitOnSelChange
currentValueIndices
defaultValue
delay
display
doNotScroll
doNotSpellCheck
doc
editable
exportValues
fileSelect
fillColor
hidden
lineWidth
multiline
multipleSelection
name
numItems
page
password
readonly
rect
required
strokeColor
style
submitName
textColor
type
userName
value
valueAsString

Global

Methods:

setPersistent

Identity

Properties:

corporation
email
loginName
name

Matrix2D

Methods:

fromRotated
transform

MenuItem

Properties:

bEnabled
bMarked
cName
cReturn
oSubMenu

OCG

Methods:

getIntent
setAction
setIntent

Properties:

initState
locked
name
state

ReadStream

Methods:

read

SignatureInfo

Properties:

date
reason

Template

Methods:

spawn

Util

Methods:

printd
printf
printx
scand
stringFromStream