Difference between revisions of "Referencing Form Fields in JavaScript"
From AgileApps Support Wiki
imported>Aeric |
imported>Aeric |
||
Line 1: | Line 1: | ||
__TOC__ | __TOC__ | ||
== | ==Referencing the Current Form== | ||
In the HTML document object model (DOM), the current form is named <tt>_sdForm</tt>.<br> | In the HTML document object model (DOM), the current form is named <tt>_sdForm</tt>.<br> | ||
This line of code gets a reference to it and puts it in the <tt>form</tt> variable: | This line of code gets a reference to it and puts it in the <tt>form</tt> variable: | ||
Line 7: | Line 7: | ||
|} | |} | ||
==Accessing Fields== | |||
To find the name of a field in the platform: | To find the name of a field in the platform: | ||
# Go to '''[[File:GearIcon.png]] > Customization > Objects > {object} > Fields''' | # Go to '''[[File:GearIcon.png]] > Customization > Objects > {object} > Fields''' | ||
# Find the label of the field you're interested in | # Find the label of the field you're interested in | ||
# Get its name from the '''Field Name''' column<br>That name can then be used in the JavaScript code. | # Get its name from the '''Field Name''' column<br>That name can then be used in the JavaScript code. | ||
Fields of type <tt>TextField</tt>, <tt>TextArea</tt>, <tt>Date</tt>, <tt>DateTime</tt>, <tt>Time</tt>, and <tt>URL</tt> can be accessed using <tt>_sdForm[0]</tt>. For example, this line of code gets a reference to the <tt>first_name</tt> field, and puts it in the variable <tt>elem</tt>: | Fields of type <tt>TextField</tt>, <tt>TextArea</tt>, <tt>Date</tt>, <tt>DateTime</tt>, <tt>Time</tt>, and <tt>URL</tt> can be accessed using <tt>_sdForm[0]</tt>. For example, this line of code gets a reference to the <tt>first_name</tt> field, and puts it in the variable <tt>elem</tt>: | ||
Line 56: | Line 58: | ||
</pre> | </pre> | ||
|} | |} | ||
==Field Type Reference== | |||
This |
Revision as of 22:06, 27 June 2013
Referencing the Current Form
In the HTML document object model (DOM), the current form is named _sdForm.
This line of code gets a reference to it and puts it in the form variable:
var form = document._sdForm;
Accessing Fields
To find the name of a field in the platform:
- Go to > Customization > Objects > {object} > Fields
- Find the label of the field you're interested in
- Get its name from the Field Name column
That name can then be used in the JavaScript code.
Fields of type TextField, TextArea, Date, DateTime, Time, and URL can be accessed using _sdForm[0]. For example, this line of code gets a reference to the first_name field, and puts it in the variable elem:
var elem = _sdForm[0].first_name;
Fields have two properties that you can access in JavaScript:
- name: the name of the field
- value: the value of the field
So this line retrieves the value of the first_name field:
var fName = elem.value;
As does this longer version:
var fName = _sdForm[0].first_name.value;
The values returned are:
- Boolean - for Checkbox fields
- Array of String - For a Multi Select Picklist, where each string is the value of an item in the picklist.
- String - for all other fields, including Lookup fields
Updating Fields
The method used to update a field depends on the field type. All of the methods have the general form:
set...Value(_sdForm, field, value);
Here are examples of the different methods:
setTextFieldValue(_sdForm, ”first_name”, ”Adam”); setPickListValue(_sdForm, ”first_name”, ”Adam”); setMultiPickListValue(_sdForm, ”first_name”, [”new”,”closed”]); // value is an array of strings setRadioButtonValue(_sdForm, ”first_name”, ”Adam”); setCheckboxState((_sdForm, ”first_name”, true); // checked setCheckboxState((_sdForm, ”first_name”, false); // unchecked setLookupValue(_sdForm, "project_number", "123456", "My Project"); // where 123456 is the record ID of the target record // "My Project" is the value of the record locator field(s) for that record
Field Type Reference
This