Difference between revisions of "JavaScript Field Type Reference"

From AgileApps Support Wiki
imported>Aeric
 
imported>Aeric
 
(13 intermediate revisions by the same user not shown)
Line 1: Line 1:
#REDIRECT [[Referencing Form Fields in JavaScript#Field Type Reference]]
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>
 
{{Note|<br>Form data is in [[User Format]]. Data entered into the Form must be in that format, as well. Data going to and from the platform, on the other hand, must be in [[Database Format]].
:''Learn more:'' [[Localization#JavaScript Programming]]  }}
{{Note|JavaScript functions mentioned in the table does not support [[Web Forms]]. }}
:{| 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
 
|-
| [[Date Format|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
 
|-
| [[Date Format|Date 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
 
|-
| [[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
 
|-
| [[External Lookup]] || align="center"|n/a || align="center"|n/a
 
|-
| File Field || align="center"|n/a || align="center"|n/a
 
|-
| [[Formula Fields|Formula]] || align="center"|n/a || align="center"|n/a
 
|-
| Geolocation
|
getTextFieldValue(_sdForm, ''field'')
<br>''Returns:'' A string containing a latitude and longitude,<br> &nbsp;&nbsp;&nbsp;&nbsp;separated by a comma and a space.<br>Ex: <tt>37.403930662906106, -121.97971165820213</tt>
|
setTextFieldValue(_sdForm, ''field'', ''value'')
<br>''value:''  A string containing the new geolocation value
 
|-
| [[Global Picklist]]
|
getPickListSelectedValue(_sdForm, ''field'')
<br>''Returns:'' selected String containing value
|
setPickListValue(_sdForm, ''field'', ''value'')
<br>''value:''  String containing new value
 
|-
| Image Field || 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'')
<br>''Returns:'' An array of values, one for each checked box
 
getMultiCheckBoxValue(_sdForm, ''field'',  index)
<br>''index:''  0 for the first checkbox,
<br> &nbsp; &nbsp; &nbsp; 1 for the second, and so on.
<br>''Returns:'' The value of the box if selected, else an empty string
 
|
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");
 
|-
| [[Date Format|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
|}
<noinclude>
 
[[Category:JavaScript]]
[[Category:Field Types]]
</noinclude>

Latest revision as of 09:58, 27 February 2017

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

Notepad.png

Note:
Form data is in User Format. Data entered into the Form must be in that format, as well. Data going to and from the platform, on the other hand, must be in Database Format.

Learn more: Localization#JavaScript Programming

Notepad.png

Note: JavaScript functions mentioned in the table does not support Web Forms.

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

Example:
setCheckboxState(_sdForm, "item_approved", true);

Currency

getTextFieldValue(_sdForm, field)
Returns: String containing value

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

Date

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

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

Date time

_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

External Lookup n/a n/a
File Field n/a n/a
Formula n/a n/a
Geolocation

getTextFieldValue(_sdForm, field)
Returns: A string containing a latitude and longitude,
    separated by a comma and a space.
Ex: 37.403930662906106, -121.97971165820213

setTextFieldValue(_sdForm, field, value)
value: A string containing the new geolocation value

Global Picklist

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

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

Image Field 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)
Returns: An array of values, one for each checked box

getMultiCheckBoxValue(_sdForm, field, index)
index: 0 for the first checkbox,
      1 for the second, and so on.
Returns: The value of the box if selected, else an empty string

setMultiCheckBoxValue(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 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

Example:
setPickListValue(_sdForm, "status", "Closed");

Radio Buttons

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

setRadioButtonValue(_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 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

Example:
setTextFieldValue(_sdForm, "first_name", "Adam");

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