Contexts

Event-level scripts are the most common type of JavaScript in PDF documents. They execute when users interact with form fields, buttons, and other interactive elements.

Accessing event scripts

In Revu, add event scripts through the Properties panel:

1. Select a form field or button.

2. Open the Properties panel.

3. On the Actions tab, choose the trigger event (Mouse Up, On Focus, Validate, etc.).

4. Select Run a JavaScript as the action.

5. Enter your JavaScript code.

The 'this' object

In event-level scripts, this refers to the Doc object of the current PDF:

// In a button's Mouse Up event
console.println(this.numPages)  // Number of pages in the document
var field = this.getField("TextField1")  // Access a form field
this.print()  // Open the print dialog

The 'event' object

Event scripts have access to a special event object containing information about the current interaction:

// In a text field's Keystroke event
console.println(event.value)  // Current field value
console.println(event.change)  // The keystroke being entered
event.rc = false  // Cancel the event

Document-level scripts execute automatically when a PDF opens. They're ideal for initialization code and defining functions that will be used throughout the document.

Accessing document scripts

Create document-level scripts in Revu:

1. Go to Forms > JavaScript.

2. Select Document JavaScript from the dropdown menu.

3. Select Add to create a new script.

4. Name your script.

5. Enter your JavaScript code.

Purpose

Document-level scripts typically do the following:

• Define reusable functions for the entire document

• Initialize form field values

• Create document-wide variables

• Set up the document environment

The 'this' object

In document-level scripts, this also refers to the Doc object:

// Document-level script
console.println("Document: " + this.documentFileName)

// Define a function available to all events in this document
function formatCurrency(value) {
    return "$" + Number(value).toFixed(2)
}

// Initialize a field
this.getField("DateField").value = util.printd("mm/dd/yyyy", new Date())

Scope

Variables and functions defined in document-level scripts are available to all event scripts within that document:

// Document-level script
var taxRate = 0.08

function calculateTax(amount) {
    return amount * taxRate
}

// Any event script in the same document can use these
var tax = calculateTax(100)
console.println("Tax rate is: " + taxRate)

Folder-level scripts are JavaScript files stored outside of PDFs, making their functions available to all PDFs opened in Revu.

Location

Folder-level scripts are stored in:

Any .js file in this directory loads automatically when Revu starts.

Purpose

Folder-level scripts provide the following:

• Utility functions used across multiple PDFs

• Company-wide standards and validations

• Shared libraries of common functions

• Trusted functions for privileged operations

The 'this' object

In folder-level scripts, this is undefined, not a document. To work with documents, you must pass them as parameters:

// Folder-level script (utilities.js)
// 'this' is undefined, not a document

// Global function available to all PDFs
function globalFormatDate(date) {
    return util.printd("yyyy-mm-dd", date)
}

// Function that accepts a [Doc](../chapter_5/Doc.md) object as parameter
function countFieldsInDocument(doc) {
    // Must receive the document explicitly
    return doc.numFields
}

Using folder-level functions from a PDF:

// In a PDF's event script
var formatted = globalFormatDate(new Date())  // Call global function
var fieldCount = countFieldsInDocument(this)  // Pass 'this' (the Doc) explicitly