AgileApps Support Wiki Pre Release

Difference between revisions of "Referencing Form Fields in JavaScript"

From AgileApps Support Wiki
imported>Aeric
imported>Aeric
Line 75: Line 75:
| Checkbox  
| Checkbox  
|  
|  
getCheckBoxState(_sdForm, field)
getCheckBoxState(_sdForm, ''field'')
<br>''Returns:'' true or false
<br>''Returns:'' true or false
|
|
setCheckboxState(_sdForm, field, state)
setCheckboxState(_sdForm, ''field'', ''state'')
<br>''state:'' true or false  
<br>''state:'' true or false  
   
   
Line 84: Line 84:
| Currency  
| Currency  
|
|
getTextFieldValue(_sdForm, field)
getTextFieldValue(_sdForm, ''field'')
<br>''Returns:'' String containing value
<br>''Returns:'' String containing value
|
|
setTextFieldValue(_sdForm, field, value)
setTextFieldValue(_sdForm, ''field'', ''value'')
<br>''value:''  String containing new value
<br>''value:''  String containing new value


Line 98: Line 98:
_sdForm[0].''fieldname''.value
_sdForm[0].''fieldname''.value
<br>''-or-''
<br>''-or-''
<br>getTextFieldValue(_sdForm, field)
<br>getTextFieldValue(_sdForm, ''field'')
<br>''Returns:'' String containing value
<br>''Returns:'' String containing value
|
|
setTextFieldValue(_sdForm, field, value)
setTextFieldValue(_sdForm, ''field'', ''value'')
<br>''value:''  String containing new value
<br>''value:''  String containing new value


Line 109: Line 109:
_sdForm[0].''fieldname''.value
_sdForm[0].''fieldname''.value
<br>''-or-''  
<br>''-or-''  
<br>getTextFieldValue(_sdForm, field)
<br>getTextFieldValue(_sdForm, ''field'')
<br>''Returns:'' String containing value
<br>''Returns:'' String containing value
|
|
setTextFieldValue(_sdForm, field, value)
setTextFieldValue(_sdForm, ''field'', ''value'')
<br>''value:'' String containing new value
<br>''value:'' String containing new value


Line 118: Line 118:
| Dependent Picklist  
| Dependent Picklist  
|
|
getPickListSelectedValue(_sdForm, field)
getPickListSelectedValue(_sdForm, ''field'')
<br>''Returns:'' selected String containing value
<br>''Returns:'' selected String containing value
|
|
setPickListValue(_sdForm, field, value)
setPickListValue(_sdForm, ''field'', ''value'')
<br>''value:''  String containing new value
<br>''value:''  String containing new value


Line 127: Line 127:
| Email Address
| Email Address
|
|
getTextFieldValue(_sdForm, field)
getTextFieldValue(_sdForm, ''field'')
<br>''Returns:'' String containing value
<br>''Returns:'' String containing value
|
|
setTextFieldValue(_sdForm, field, value)
setTextFieldValue(_sdForm, ''field'', ''value'')
<br>''value:'' String containing new value
<br>''value:'' String containing new value


Line 142: Line 142:
| Global Picklist
| Global Picklist
|
|
getPickListSelectedValue(_sdForm, field)
getPickListSelectedValue(_sdForm, ''field'')
<br>''Returns:'' selected String containing value
<br>''Returns:'' selected String containing value
|
|
setPickListValue(_sdForm, field, value)
setPickListValue(_sdForm, ''field'', ''value'')
<br>''value:''  String containing new value
<br>''value:''  String containing new value


Line 154: Line 154:
| Lookup
| Lookup
|
|
getLookupFieldValue(_sdForm, field)
getLookupFieldValue(_sdForm, ''field'')
<br>''Returns:'' String containing record ID
<br>''Returns:'' String containing record ID
<br>
<br>
<br>getLookupFieldText(_sdForm, field)
<br>getLookupFieldText(_sdForm, ''field'')
<br>''Returns:'' String containing the displayed text
<br>''Returns:'' String containing the displayed text
|
|
setLookupValue(_sdForm, field, value, text)
setLookupValue(_sdForm, ''field'', ''value'', text)
<br>''value:''  String containing record ID
<br>''value:''  String containing record ID
<br>''text:'' String containing the text to display
<br>''text:'' String containing the text to display
Line 167: Line 167:
| Multiple Checkboxes
| Multiple Checkboxes
|
|
getMultiCheckBoxValue(_sdForm, field,  indexes)
getMultiCheckBoxValue(_sdForm, ''field'',  indexes)
<br>''indexes:''  Array of indexes for checked boxes  
<br>''indexes:''  Array of indexes for checked boxes  
<br> - Index values start from 0 for first checkbox,
<br> - Index values start from 0 for first checkbox,
<br> &nbsp; 1 for second, etc.
<br> &nbsp; 1 for second, etc.
|
|
setMultiCheckBoxValue(form, field, value)
setMultiCheckBoxValue(form, ''field'', ''value'')
<br>''value:''  Array of New Values  
<br>''value:''  Array of New Values  
<br>''Example:''
<br>''Example:''
<br>setMultiCheckBoxValue(_sdForm, field, [“A”, ”B”] )
<br>setMultiCheckBoxValue(_sdForm, ''field'', [“A”, ”B”] )


|-
|-
Line 183: Line 183:
| Multi Select Picklist
| Multi Select Picklist
|
|
getMultiPickListSelectedValue(_sdForm, field)
getMultiPickListSelectedValue(_sdForm, ''field'')
<br>''Returns:'' Array of values
<br>''Returns:'' Array of values
<br>''Example:'' output = [“A”, ”C”]
<br>''Example:'' output = [“A”, ”C”]
|
|
setMultiPickListValue(_sdForm, field, value)
setMultiPickListValue(_sdForm, ''field'', ''value'')
<br>''value:''  Array of New Values  
<br>''value:''  Array of New Values  
<br>''Example:''  
<br>''Example:''  
<br>setMultiPickListValue(_sdForm, field,  [“A”, ”B”] )
<br>setMultiPickListValue(_sdForm, ''field'',  [“A”, ”B”] )


|-
|-
Line 197: Line 197:
_sdForm[0].''fieldname''.value
_sdForm[0].''fieldname''.value
<br>''-or-''
<br>''-or-''
<br>getTextFieldValue(_sdForm, field)
<br>getTextFieldValue(_sdForm, ''field'')
<br>''Returns:'' String containing value
<br>''Returns:'' String containing value
|
|
setTextFieldValue(_sdForm, field, value)
setTextFieldValue(_sdForm, ''field'', ''value'')
<br>''value:'' String containing new value,  or a number
<br>''value:'' String containing new value,  or a number


Line 208: Line 208:
sdForm[0].''fieldname''.value
sdForm[0].''fieldname''.value
<br>''-or-''
<br>''-or-''
<br>getTextFieldValue(_sdForm, field)
<br>getTextFieldValue(_sdForm, ''field'')
<br>''Returns:'' String containing value
<br>''Returns:'' String containing value
|
|
setTextFieldValue(_sdForm, field, value)
setTextFieldValue(_sdForm, ''field'', ''value'')
<br>''value:''  String containing new value,  or a float
<br>''value:''  String containing new value,  or a float


Line 219: Line 219:
sdForm[0].''fieldname''.value
sdForm[0].''fieldname''.value
<br>''-or-''
<br>''-or-''
<br>getTextFieldValue(_sdForm, field)
<br>getTextFieldValue(_sdForm, ''field'')
<br>''Returns:'' String containing value
<br>''Returns:'' String containing value
|
|
setTextFieldValue(_sdForm, field, value)
setTextFieldValue(_sdForm, ''field'', ''value'')
<br>''value:''  String containing new value
<br>''value:''  String containing new value


Line 230: Line 230:
sdForm[0].''fieldname''.value
sdForm[0].''fieldname''.value
<br>''-or-''
<br>''-or-''
<br>getTextFieldValue(_sdForm, field)
<br>getTextFieldValue(_sdForm, ''field'')
<br>''Returns:'' String containing value
<br>''Returns:'' String containing value
|
|
setTextFieldValue(_sdForm, field, value)
setTextFieldValue(_sdForm, ''field'', ''value'')
<br>''value:''  String containing new value
<br>''value:''  String containing new value


Line 239: Line 239:
| Picklist
| Picklist
|
|
getPickListSelectedValue(_sdForm, field)
getPickListSelectedValue(_sdForm, ''field'')
<br>''Returns:'' selected String containing value
<br>''Returns:'' selected String containing value
|
|
setPickListValue(_sdForm, field, value)
setPickListValue(_sdForm, ''field'', ''value'')
<br>''value:''  String containing new value
<br>''value:''  String containing new value


Line 248: Line 248:
| Radio Buttons
| Radio Buttons
|
|
getRadioButtonValue(_sdForm, field)
getRadioButtonValue(_sdForm, ''field'')
<br>''Returns:'' String containing selected value
<br>''Returns:'' String containing selected value
|
|
setRadioButtonValue(_sdForm, field, value)
setRadioButtonValue(_sdForm, ''field'', ''value'')
<br>''value:'' String containing new value to select
<br>''value:'' String containing new value to select


Line 262: Line 262:
_sdForm[0].''fieldname''.value
_sdForm[0].''fieldname''.value
<br>''-or-''
<br>''-or-''
<br>getTextFieldValue(_sdForm, field)
<br>getTextFieldValue(_sdForm, ''field'')
<br>''Returns:'' String containing value
<br>''Returns:'' String containing value
|
|
setTextFieldValue(_sdForm, field, value)
setTextFieldValue(_sdForm, ''field'', ''value'')
<br>''value:''  String containing new value
<br>''value:''  String containing new value


Line 273: Line 273:
_sdForm[0].''fieldname''.value
_sdForm[0].''fieldname''.value
<br>''-or-''
<br>''-or-''
<br>getTextFieldValue(_sdForm, field)
<br>getTextFieldValue(_sdForm, ''field'')
<br>''Returns:'' String containing value
<br>''Returns:'' String containing value
|
|
setTextFieldValue(_sdForm, field, value)
setTextFieldValue(_sdForm, ''field'', ''value'')
<br>''value:''  String containing new value
<br>''value:''  String containing new value


Line 284: Line 284:
_sdForm[0].''fieldname''.value
_sdForm[0].''fieldname''.value
<br>''-or-''  
<br>''-or-''  
<br>getTextFieldValue(_sdForm, field)
<br>getTextFieldValue(_sdForm, ''field'')
<br>''Returns:'' String containing value
<br>''Returns:'' String containing value
|
|
setTextFieldValue(_sdForm, field, value)
setTextFieldValue(_sdForm, ''field'', ''value'')
<br>''value:''  String containing new value
<br>''value:''  String containing new value


Line 295: Line 295:
_sdForm[0].''fieldname''.value
_sdForm[0].''fieldname''.value
<br>''-or-''
<br>''-or-''
<br>getTextFieldValue(_sdForm, field)
<br>getTextFieldValue(_sdForm, ''field'')
<br>''Returns:'' String containing value
<br>''Returns:'' String containing value
|
|
setTextFieldValue(_sdForm, field, value)
setTextFieldValue(_sdForm, ''field'', ''value'')
<br>''value:''  String containing new value
<br>''value:''  String containing new value
|}
|}

Revision as of 01:00, 28 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 = _sdForm;

Accessing Fields

To find the name of a field in the platform:

  1. Go to GearIcon.png > Customization > Objects > {object} > Fields
  2. Find the label of the field you're interested in
  3. Get its name from the Field Name column
    That name can then be used in the JavaScript code.

All fields can be accessed using the platform's JavaScript functions, as described in the Field Types section below. The most commonly accessed field types (TextField, TextArea, Date, DateTime, Time, and URL) can also 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 fName_field:

var fName_field = _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 field:

var fName = fName_field.value;

As does this longer version:

var fName = _sdForm[0].first_name.value;

Other fields can be accessed using the platform's JavaScript functions.
For a complete list, see the Field Types section below.

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 some common 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

For a complete list, see the Field Type Reference section that follows

Field Type Reference

The following table shows how to access and update the different field types, where:

  • _sdForm is a reference to the current form
  • field is a string containing the name of the field
Type Getter Setter
Auto Number n/a n/a
Checkbox

getCheckBoxState(_sdForm, field)
Returns: true or false

setCheckboxState(_sdForm, field, state)
state: true or false

Currency

getTextFieldValue(_sdForm, field)
Returns: String containing value

setTextFieldValue(_sdForm, field, value)
value: String containing new value

Custom Control n/a n/a
Date

_sdForm[0].fieldname.value
-or-
getTextFieldValue(_sdForm, field)
Returns: String containing value

setTextFieldValue(_sdForm, field, value)
value: String containing new value

Datetime

_sdForm[0].fieldname.value
-or-
getTextFieldValue(_sdForm, field)
Returns: String containing value

setTextFieldValue(_sdForm, field, value)
value: String containing new value

Dependent Picklist

getPickListSelectedValue(_sdForm, field)
Returns: selected String containing value

setPickListValue(_sdForm, field, value)
value: String containing new value

Email Address

getTextFieldValue(_sdForm, field)
Returns: String containing value

setTextFieldValue(_sdForm, field, value)
value: String containing new value

File n/a n/a
Formula n/a n/a
Global Picklist

getPickListSelectedValue(_sdForm, field)
Returns: selected String containing value

setPickListValue(_sdForm, field, value)
value: String containing new value

Image n/a n/a
Lookup

getLookupFieldValue(_sdForm, field)
Returns: String containing record ID

getLookupFieldText(_sdForm, field)
Returns: String containing the displayed text

setLookupValue(_sdForm, field, value, text)
value: String containing record ID
text: String containing the text to display

Multiple Checkboxes

getMultiCheckBoxValue(_sdForm, field, indexes)
indexes: Array of indexes for checked boxes
- Index values start from 0 for first checkbox,
  1 for second, etc.

setMultiCheckBoxValue(form, field, value)
value: Array of New Values
Example:
setMultiCheckBoxValue(_sdForm, field, [“A”, ”B”] )

Multi Object Lookup n/a n/a
Multi Select Picklist

getMultiPickListSelectedValue(_sdForm, field)
Returns: Array of values
Example: output = [“A”, ”C”]

setMultiPickListValue(_sdForm, field, value)
value: Array of New Values
Example:
setMultiPickListValue(_sdForm, field, [“A”, ”B”] )

Number

_sdForm[0].fieldname.value
-or-
getTextFieldValue(_sdForm, field)
Returns: String containing value

setTextFieldValue(_sdForm, field, value)
value: String containing new value, or a number

Number with decimals

sdForm[0].fieldname.value
-or-
getTextFieldValue(_sdForm, field)
Returns: String containing value

setTextFieldValue(_sdForm, field, value)
value: String containing new value, or a float

Percentage

sdForm[0].fieldname.value
-or-
getTextFieldValue(_sdForm, field)
Returns: String containing value

setTextFieldValue(_sdForm, field, value)
value: String containing new value

Phone/Fax

sdForm[0].fieldname.value
-or-
getTextFieldValue(_sdForm, field)
Returns: String containing value

setTextFieldValue(_sdForm, field, value)
value: String containing new value

Picklist

getPickListSelectedValue(_sdForm, field)
Returns: selected String containing value

setPickListValue(_sdForm, field, value)
value: String containing new value

Radio Buttons

getRadioButtonValue(_sdForm, field)
Returns: String containing selected value

setRadioButtonValue(_sdForm, field, value)
value: String containing new value to select

Rich Text Area n/a n/a
TextArea

_sdForm[0].fieldname.value
-or-
getTextFieldValue(_sdForm, field)
Returns: String containing value

setTextFieldValue(_sdForm, field, value)
value: String containing new value

TextField

_sdForm[0].fieldname.value
-or-
getTextFieldValue(_sdForm, field)
Returns: String containing value

setTextFieldValue(_sdForm, field, value)
value: String containing new value

Time

_sdForm[0].fieldname.value
-or-
getTextFieldValue(_sdForm, field)
Returns: String containing value

setTextFieldValue(_sdForm, field, value)
value: String containing new value

URL

_sdForm[0].fieldname.value
-or-
getTextFieldValue(_sdForm, field)
Returns: String containing value

setTextFieldValue(_sdForm, field, value)
value: String containing new value

Global JavaScript Variables

No JavaScript variables are currently defined.