Difference between revisions of "JavaScript Field Type Reference"
imported>Aeric (Redirected page to Referencing Form Fields in JavaScript#Field Type Reference) |
imported>Aeric |
||
Line 1: | Line 1: | ||
The following table shows how to access and update the different field types, where: | |||
:* <tt>_sdForm</tt> is the variable that references the current form | |||
:* ''field'' is a string containing the name of the field<br>(as with all strings, literal values must be in quotes) | |||
:* ''value'' is a value you specify (generally a string) | |||
:* <tt>value</tt> is language keyword, typed exactly as shown--as in this line,<br>for example, which gets the value from a field called <tt>email_address</tt>: | |||
::: <tt>_sdForm.email_address.value</tt> | |||
:{| border="1" cellpadding="1" cellspacing="0" | |||
! Type !! Getter !! Setter | |||
|- | |||
| Auto Number || align="center"|n/a || align="center"|n/a | |||
|- | |||
| Checkbox | |||
| | |||
getCheckBoxState(_sdForm, ''field'') | |||
<br>''Returns:'' true or false | |||
| | |||
setCheckboxState(_sdForm, ''field'', ''state'') | |||
<br>''state:'' true or false | |||
<br> | |||
<br>''Example:'' | |||
<br>setCheckboxState(_sdForm, "item_approved", true); | |||
|- | |||
| Currency | |||
| | |||
getTextFieldValue(_sdForm, ''field'') | |||
<br>''Returns:'' String containing value | |||
| | |||
setTextFieldValue(_sdForm, ''field'', ''value'') | |||
<br>''value:'' String containing new value | |||
|- | |||
| Custom Control || align="center"|n/a || align="center"|n/a | |||
|- | |||
| Date | |||
| | |||
_sdForm[0].''fieldname''.value | |||
<br>''-or-'' | |||
<br>getTextFieldValue(_sdForm, ''field'') | |||
<br>''Returns:'' String containing value | |||
| | |||
setTextFieldValue(_sdForm, ''field'', ''value'') | |||
<br>''value:'' String containing new value | |||
|- | |||
| Datetime | |||
| | |||
_sdForm[0].''fieldname''.value | |||
<br>''-or-'' | |||
<br>getTextFieldValue(_sdForm, ''field'') | |||
<br>''Returns:'' String containing value | |||
| | |||
setTextFieldValue(_sdForm, ''field'', ''value'') | |||
<br>''value:'' String containing new value | |||
|- | |||
| Dependent Picklist | |||
| | |||
getPickListSelectedValue(_sdForm, ''field'') | |||
<br>''Returns:'' selected String containing value | |||
| | |||
setPickListValue(_sdForm, ''field'', ''value'') | |||
<br>''value:'' String containing new value | |||
|- | |||
| Email Address | |||
| | |||
getTextFieldValue(_sdForm, ''field'') | |||
<br>''Returns:'' String containing value | |||
| | |||
setTextFieldValue(_sdForm, ''field'', ''value'') | |||
<br>''value:'' String containing new value | |||
|- | |||
| File || align="center"|n/a || align="center"|n/a | |||
|- | |||
| Formula || align="center"|n/a || align="center"|n/a | |||
|- | |||
| Global Picklist | |||
| | |||
getPickListSelectedValue(_sdForm, ''field'') | |||
<br>''Returns:'' selected String containing value | |||
| | |||
setPickListValue(_sdForm, ''field'', ''value'') | |||
<br>''value:'' String containing new value | |||
|- | |||
| Image || align="center"|n/a || align="center"|n/a | |||
|- | |||
| Lookup | |||
| | |||
getLookupFieldValue(_sdForm, ''field'') | |||
<br>''Returns:'' String containing record ID | |||
<br> | |||
<br>getLookupFieldText(_sdForm, ''field'') | |||
<br>''Returns:'' String containing the displayed text | |||
| | |||
setLookupValue(_sdForm, ''field'', ''value'', text) | |||
<br>''value:'' String containing record ID | |||
<br>''text:'' String containing the text to display | |||
|- | |||
| Multiple Checkboxes | |||
| | |||
getMultiCheckBoxValue(_sdForm, ''field'', index) | |||
<br>''index:'' 0 for the first checkbox, | |||
<br> 1 for the second, and so on. | |||
<br>''Returns:'' An array of values for all checked boxes | |||
| | |||
setMultiCheckBoxValue(form, ''field'', [''value1'', ...]) | |||
<br>''Argument:'' Array of values to set | |||
<br> | |||
<br>''Example:'' | |||
<br>setMultiCheckBoxValue(_sdForm, ''field'', ["A", "B"]) | |||
<br>(Checkboxes for all other values are turned off) | |||
|- | |||
| Multi Object Lookup || align="center"|n/a || align="center"|n/a | |||
|- | |||
| Multi Select Picklist | |||
| | |||
getMultiPickListSelectedValue(_sdForm, ''field'') | |||
<br>''Returns:'' Array of strings, with selected values | |||
<br>''Example:'' ["A", "C"] | |||
| | |||
setMultiPickListValue(_sdForm, ''field'', [''value1'', ...]) | |||
<br>''Argument:'' Array of values to select | |||
<br> | |||
<br>''Example:'' | |||
<br>setMultiPickListValue(_sdForm, ''field'', ["A", "B"] ) | |||
|- | |||
| Number | |||
| | |||
_sdForm[0].''fieldname''.value | |||
<br>''-or-'' | |||
<br>getTextFieldValue(_sdForm, ''field'') | |||
<br>''Returns:'' String containing value | |||
| | |||
setTextFieldValue(_sdForm, ''field'', ''value'') | |||
<br>''value:'' String containing new value, or a number | |||
|- | |||
| Number with decimals | |||
| | |||
sdForm[0].''fieldname''.value | |||
<br>''-or-'' | |||
<br>getTextFieldValue(_sdForm, ''field'') | |||
<br>''Returns:'' String containing value | |||
| | |||
setTextFieldValue(_sdForm, ''field'', ''value'') | |||
<br>''value:'' String containing new value, or a float | |||
|- | |||
| Percentage | |||
| | |||
sdForm[0].''fieldname''.value | |||
<br>''-or-'' | |||
<br>getTextFieldValue(_sdForm, ''field'') | |||
<br>''Returns:'' String containing value | |||
| | |||
setTextFieldValue(_sdForm, ''field'', ''value'') | |||
<br>''value:'' String containing new value | |||
|- | |||
| Phone/Fax | |||
| | |||
sdForm[0].''fieldname''.value | |||
<br>''-or-'' | |||
<br>getTextFieldValue(_sdForm, ''field'') | |||
<br>''Returns:'' String containing value | |||
| | |||
setTextFieldValue(_sdForm, ''field'', ''value'') | |||
<br>''value:'' String containing new value | |||
|- | |||
| Picklist | |||
| | |||
getPickListSelectedValue(_sdForm, ''field'') | |||
<br>''Returns:'' selected String containing value | |||
| | |||
setPickListValue(_sdForm, ''field'', ''value'') | |||
<br>''value:'' String containing new value | |||
<br> | |||
<br>''Example:'' | |||
<br> | |||
setPickListValue(_sdForm, "status", "Closed"); | |||
|- | |||
| Radio Buttons | |||
| | |||
getRadioButtonValue(_sdForm, ''field'') | |||
<br>''Returns:'' String containing selected value | |||
| | |||
setRadioButtonValue(_sdForm, ''field'', ''value'') | |||
<br>''value:'' String containing new value to select | |||
<br> | |||
<br>''Example:'' | |||
<br> | |||
setRadioButtonValue(_sdForm, "color", "Black"); | |||
|- | |||
| Rich Text Area || align="center"|n/a || align="center"|n/a | |||
|- | |||
| Rollup Summary Field || align="center"|n/a || align="center"|n/a | |||
|- | |||
| TextArea | |||
| | |||
_sdForm[0].''fieldname''.value | |||
<br>''-or-'' | |||
<br>getTextFieldValue(_sdForm, ''field'') | |||
<br>''Returns:'' String containing value | |||
| | |||
setTextFieldValue(_sdForm, ''field'', ''value'') | |||
<br>''value:'' String containing new value | |||
|- | |||
| TextField | |||
| | |||
_sdForm[0].''fieldname''.value | |||
<br>''-or-'' | |||
<br>getTextFieldValue(_sdForm, ''field'') | |||
<br>''Returns:'' String containing value | |||
| | |||
setTextFieldValue(_sdForm, ''field'', ''value'') | |||
<br>''value:'' String containing new value | |||
<br> | |||
<br>''Example:'' | |||
<br>setTextFieldValue(_sdForm, "first_name", "Adam"); | |||
|- | |||
| Time | |||
| | |||
_sdForm[0].''fieldname''.value | |||
<br>''-or-'' | |||
<br>getTextFieldValue(_sdForm, ''field'') | |||
<br>''Returns:'' String containing value | |||
| | |||
setTextFieldValue(_sdForm, ''field'', ''value'') | |||
<br>''value:'' String containing new value | |||
|- | |||
| URL | |||
| | |||
_sdForm[0].''fieldname''.value | |||
<br>''-or-'' | |||
<br>getTextFieldValue(_sdForm, ''field'') | |||
<br>''Returns:'' String containing value | |||
| | |||
setTextFieldValue(_sdForm, ''field'', ''value'') | |||
<br>''value:'' String containing new value | |||
|} |
Revision as of 02:57, 2 August 2013
The following table shows how to access and update the different field types, where:
- _sdForm is the variable that references the current form
- field is a string containing the name of the field
(as with all strings, literal values must be in quotes) - value is a value you specify (generally a string)
- value is language keyword, typed exactly as shown--as in this line,
for example, which gets the value from a field called email_address:
- _sdForm.email_address.value
Type Getter Setter Auto Number n/a n/a Checkbox getCheckBoxState(_sdForm, field)
Returns: true or falsesetCheckboxState(_sdForm, field, state)
state: true or false
Example:
setCheckboxState(_sdForm, "item_approved", true);Currency getTextFieldValue(_sdForm, field)
Returns: String containing valuesetTextFieldValue(_sdForm, field, value)
value: String containing new valueCustom Control n/a n/a Date _sdForm[0].fieldname.value
-or-
getTextFieldValue(_sdForm, field)
Returns: String containing valuesetTextFieldValue(_sdForm, field, value)
value: String containing new valueDatetime _sdForm[0].fieldname.value
-or-
getTextFieldValue(_sdForm, field)
Returns: String containing valuesetTextFieldValue(_sdForm, field, value)
value: String containing new valueDependent Picklist getPickListSelectedValue(_sdForm, field)
Returns: selected String containing valuesetPickListValue(_sdForm, field, value)
value: String containing new valueEmail Address getTextFieldValue(_sdForm, field)
Returns: String containing valuesetTextFieldValue(_sdForm, field, value)
value: String containing new valueFile n/a n/a Formula n/a n/a Global Picklist getPickListSelectedValue(_sdForm, field)
Returns: selected String containing valuesetPickListValue(_sdForm, field, value)
value: String containing new valueImage n/a n/a Lookup getLookupFieldValue(_sdForm, field)
Returns: String containing record ID
getLookupFieldText(_sdForm, field)
Returns: String containing the displayed textsetLookupValue(_sdForm, field, value, text)
value: String containing record ID
text: String containing the text to displayMultiple Checkboxes getMultiCheckBoxValue(_sdForm, field, index)
index: 0 for the first checkbox,
1 for the second, and so on.
Returns: An array of values for all checked boxessetMultiCheckBoxValue(form, field, [value1, ...])
Argument: Array of values to set
Example:
setMultiCheckBoxValue(_sdForm, field, ["A", "B"])
(Checkboxes for all other values are turned off)Multi Object Lookup n/a n/a Multi Select Picklist getMultiPickListSelectedValue(_sdForm, field)
Returns: Array of strings, with selected values
Example: ["A", "C"]setMultiPickListValue(_sdForm, field, [value1, ...])
Argument: Array of values to select
Example:
setMultiPickListValue(_sdForm, field, ["A", "B"] )Number _sdForm[0].fieldname.value
-or-
getTextFieldValue(_sdForm, field)
Returns: String containing valuesetTextFieldValue(_sdForm, field, value)
value: String containing new value, or a numberNumber with decimals sdForm[0].fieldname.value
-or-
getTextFieldValue(_sdForm, field)
Returns: String containing valuesetTextFieldValue(_sdForm, field, value)
value: String containing new value, or a floatPercentage sdForm[0].fieldname.value
-or-
getTextFieldValue(_sdForm, field)
Returns: String containing valuesetTextFieldValue(_sdForm, field, value)
value: String containing new valuePhone/Fax sdForm[0].fieldname.value
-or-
getTextFieldValue(_sdForm, field)
Returns: String containing valuesetTextFieldValue(_sdForm, field, value)
value: String containing new valuePicklist getPickListSelectedValue(_sdForm, field)
Returns: selected String containing valuesetPickListValue(_sdForm, field, value)
value: String containing new value
Example:
setPickListValue(_sdForm, "status", "Closed");Radio Buttons getRadioButtonValue(_sdForm, field)
Returns: String containing selected valuesetRadioButtonValue(_sdForm, field, value)
value: String containing new value to select
Example:
setRadioButtonValue(_sdForm, "color", "Black");Rich Text Area n/a n/a Rollup Summary Field n/a n/a TextArea _sdForm[0].fieldname.value
-or-
getTextFieldValue(_sdForm, field)
Returns: String containing valuesetTextFieldValue(_sdForm, field, value)
value: String containing new valueTextField _sdForm[0].fieldname.value
-or-
getTextFieldValue(_sdForm, field)
Returns: String containing valuesetTextFieldValue(_sdForm, field, value)
value: String containing new value
Example:
setTextFieldValue(_sdForm, "first_name", "Adam");Time _sdForm[0].fieldname.value
-or-
getTextFieldValue(_sdForm, field)
Returns: String containing valuesetTextFieldValue(_sdForm, field, value)
value: String containing new valueURL _sdForm[0].fieldname.value
-or-
getTextFieldValue(_sdForm, field)
Returns: String containing valuesetTextFieldValue(_sdForm, field, value)
value: String containing new value