User manual ADOBE ACROBAT FORMS JAVASCRIPT OBJECT SPECIFICATION

[. . . ] bc Adobe® Acrobat® Technical Note # 5186 Acrobat Forms JavaScript Object Specification Version 4. 0 Revised: January 27, 1999 © 1999 Adobe Systems Incorporated. The information in this document is furnished for informational use only, is subject t change without notice, and should not be construed as a commitment by Adobe Systems Incorporated. Adobe Systems Incorporated assumes no responsibility or liability for any errors or inaccuracies that may appear in this document. The software described in this document is furnished under license and may only be used or copied in accordance with the terms of such license. [. . . ] 2 - value was committed because of hitting the enter key. 3 - value was committed by tabbing to a new field. For example, to automatically display an alert dialog after a field has been committed add the following to the field's format script: if (event. commitKey != 0) app. alert("Thank you for your new field value. "); modifier Type: Boolean Event: Keystroke, Mouse events Access: R This property is a boolean that specifies whether the modifier key is down during a particular event. The modifier key on the Microsoft Windows platform is Control and on the Macintosh platform is Option or Command. The modifier property is not supported on UNIX. rc Type: Boolean Event: Keystroke, Validate Access: R/W This property is used for validation. It indicates whether a particular event in the event chain should succeed. Set rc to false to prevent a change from occurring or a value from committing. By default rc is true. Acrobat Forms - JavaScript Object Specification 33 For each event, except the mouse related events, the static event object is populated with the following data. In most events, it is important for JavaScript to set the rc (return code) property to indicate that the event can proceed. selEnd Type: Integer Event: Keystroke Access: R/W This property specifies the ending position of the current text selection during a keystroke event. selStart Type: Integer Event: Keystroke Access: R/W This property specifies the starting position of the current text selection during a keystroke event. shift Type: Boolean Event: Keystroke, Mouse events Access: R This property is a boolean that specifies whether the shift key is down during a particular event. target Type: Object Event: All events Access: R This property contains the target object that triggered the event. In all mouse events it is the field object that triggered the event. In other events like page open and close it is the document or this Object. value Type: Various Event: Validate, Calculate, Format, SelChange Access: R/W For the validate event, value is the value that the field contains when it is committed. The current field value is the value property for the field. For example, the following JavaScript verifies that the field value is between zero and 100. Example: if (event. value < 0 || event. value > 100) { app. beep(0); Acrobat Forms - JavaScript Object Specification 34 app. alert("Invalid value for field " + event. target. name); event. rc = false; } For a calculate event, JavaScript should set this property. This is the value that the field should take upon completion of the event. For example, the following JavaScript sets the calculated value of the field to the value of the SubTotal field plus tax. var f = this. getField("SubTotal"); event. value = f. value * 1. 0725; For a format event, JavaScript should set this property. This is the value used when generating the appearance for the field. By default, it contains the value that the user has committed. For example, the following JavaScript formats the field as a currency type of field. event. value = util. printf("$%. 2f", event. value); willCommit Type: Boolean Event: Keystroke Access: R Use this property to verify the current keystroke event before the data is committed. This is useful to check the target form field values and for example verify if character data instead of numeric data was entered. JavaScript sets this property to true after the last keystroke event and before the field is validated. Example: var value = event. value if (event. willCommit) // Final value checking. [. . . ] For example, after authoring a form may be posted on a Web site. In order to preserve the form integrity it needs to be shielded from any changes to its formulae or internal data routines. If the changing the document restriction is selected, the user can fill-in form fields and add annotations but cannot author or modify form fields or change the background text using the TouchUp plug-in. In addition, once a form has been filled in, it is often desirable to lock the entire document so that it cannot be changed whatsoever. In filling out a tax or other sensitive form, the user may wish to save the document so that no further changes to the document are allowed. [. . . ]