Methods for the Form Object
The following table shows the methods that are available for the Form object. These methods are used, together with the field.setColor() and field.getColor() methods in the color coding of fields in Detail and Edit pages. For more information about the setColor() and getColor() methods, see the table in Methods for the Field Object.
Method Name |
Return Type |
Description |
Sample Code |
Notes |
---|---|---|---|---|
on(event,customfunction) |
this |
Registers a custom handler for the form. |
|
The custom handler is automatically executed when the form initially loads or refreshes due to any other actions on the screen such as inline editing. The event parameter must be "display". If not, it is ignored and the custom handler is not registered. |
off(event) |
this |
Removes the custom handler for the form. |
|
If the event parameter is not "display", it is ignored and the custom handler is not removed. |
commitValues(callback) |
JSONObject in callback |
Commits values set on Detail pages using the setValue() method. |
|
For information about the callback handler, see Callback Handler for the commitValues() Method. |
getId() |
String |
Returns the row ID of the record on the screen. |
|
The getId() method is supported for Detail and Edit pages. For other types of pages, including New pages, it returns null. |