Difference between revisions of "JavaScript Field Type Reference for New AgileApps User Interface"
imported>Aeric |
imported>Aeric |
||
Line 272: | Line 272: | ||
Yes | Yes | ||
| | | | ||
Use the following script to set custom field icons: | Use the following script to set custom field icons:<br> | ||
var arrayOfCustomIconObject = [ | var arrayOfCustomIconObject = [ <br> | ||
{ | { <br> | ||
value: "1", //picklist value | value: "1", //picklist value <br> | ||
url: "<''Enter the path for the image''. For example, https://cdn1.iconfinder.com/data/icons/ui-colored-3-of-3/100/UI_3_-20-512.png>", | url: "<''Enter the path for the image''. <br> | ||
altText: '<''Type the text you want to display as a hover text. For example, SAG_Footer''>' | For example, https://cdn1.iconfinder.com/data/icons/ui-colored-3-of-3/100/UI_3_-20-512.png>", <br> | ||
}, | altText: '<''Type the text you want to display as a hover text. For example, SAG_Footer''>' <br> | ||
{ | }, <br> | ||
value: "2", | { <br> | ||
url: "<''Enter the path for the image''. For example,https://cdn2.iconfinder.com/data/icons/right-and-wrong/48/wrong-2-512.png>", | value: "2", <br> | ||
altText: '<''Type the text you want to display as a hover text. For example, AAC-logo''>', | url: "<''Enter the path for the image''. <br> | ||
iconPosition: 'left' | For example,https://cdn2.iconfinder.com/data/icons/right-and-wrong/48/wrong-2-512.png>", <br> | ||
}, | altText: '<''Type the text you want to display as a hover text. For example, AAC-logo''>', <br> | ||
{ | iconPosition: 'left' <br> | ||
value: "3", | }, <br> | ||
url: "<''Enter the path for the image''. For example, https://companies.mybroadband.co.za/files/2015/07/Software-AG-logo.jpg>", | { <br> | ||
altText: '<''Type the text you want to display as a hover text. For example, SAG_Footer''>', | value: "3", <br> | ||
iconPosition: 'right' | url: "<''Enter the path for the image''. <br> | ||
} | For example, https://companies.mybroadband.co.za/files/2015/07/Software-AG-logo.jpg>", <br> | ||
]; | altText: '<''Type the text you want to display as a hover text. For example, SAG_Footer''>',<br> | ||
iconPosition: 'right' <br> | |||
} <br> | |||
];<br> | |||
| | | | ||
|- | |- |
Revision as of 11:36, 4 September 2018
The following table shows how to access and update the different field types for the revamped AgileApps user interface, 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
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
Note: JavaScript functions mentioned in the table does not support Web Forms.
Type Getter Setter New UI Support Scripts supported only with New UI Auto Number n/a 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);Yes
Currency getTextFieldValue(_sdForm, field)
Returns: String containing valuesetTextFieldValue(_sdForm, field, value)
value: String containing new valueYes
Date _sdForm.fieldname.value
-or-
getTextFieldValue(_sdForm, field)
Returns: String containing valuesetTextFieldValue(_sdForm, field, value)
value: String containing new valueYes
Date time _sdForm.fieldname.value
-or-
getTextFieldValue(_sdForm, field)
Returns: String containing valuesetTextFieldValue(_sdForm, field, value)
value: String containing new valueYes
Dependent Picklist getPickListSelectedValue(_sdForm, field)
Returns: selected String containing valuesetPickListValue(_sdForm, field, value)
value: String containing new valueYes
Email Address getTextFieldValue(_sdForm, field)
Returns: String containing valuesetTextFieldValue(_sdForm, field, value)
value: String containing new valueYes
External Lookup n/a n/a n/a
File Field n/a n/a n/a
Formula n/a 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.97971165820213setTextFieldValue(_sdForm, field, value)
value: A string containing the new geolocation valueYes
Global Picklist getPickListSelectedValue(_sdForm, field)
Returns: selected String containing valuesetPickListValue(_sdForm, field, value)
value: String containing new valueYes
Image Field n/a 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 displayYes
Multiple Checkboxes getMultiCheckBoxValue(_sdForm, field)
Returns: An array of values, one for each checked boxgetMultiCheckBoxValue(_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 stringsetMultiCheckBoxValue(form, field, [value1, ...])
Argument: Array of values to set
Example:
setMultiCheckBoxValue(_sdForm, field, ["A", "B"])
(Checkboxes for all other values are turned off)Yes
Multi Object Lookup getLookupFieldValue(_sdForm, field)
Returns: String containing objectID:recordIDgetLookupFieldText(_sdForm, field)
Returns: String containing the text to displaysetLookupValue(form, field, value, text)
value: String containing objectID:recordID
text: String containing the text to displayYes
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"] )Yes
Number _sdForm.fieldname.value
-or-
getTextFieldValue(_sdForm, field)
Returns: String containing valuesetTextFieldValue(_sdForm, field, value)
value: String containing new value, or a numberYes
Number with decimals sdForm.fieldname.value
-or-
getTextFieldValue(_sdForm, field)
Returns: String containing valuesetTextFieldValue(_sdForm, field, value)
value: String containing new value, or a floatYes
Percentage sdForm.fieldname.value
-or-
getTextFieldValue(_sdForm, field)
Returns: String containing valuesetTextFieldValue(_sdForm, field, value)
value: String containing new valueYes
Phone/Fax sdForm.fieldname.value
-or-
getTextFieldValue(_sdForm, field)
Returns: String containing valuesetTextFieldValue(_sdForm, field, value)
value: String containing new valueYes
Picklist getPickListSelectedValue(_sdForm, field)
Returns: selected String containing valuesetPickListValue(_sdForm, field, value)
value: String containing new value
Example:
setPickListValue(_sdForm, "status", "Closed");Yes
setFieldCustomIcons(_sdForm, field, arrayOfCustomIconObject)
Yes
Use the following script to set custom field icons:
var arrayOfCustomIconObject = [
{
value: "1", //picklist value
url: "<Enter the path for the image.
For example, https://cdn1.iconfinder.com/data/icons/ui-colored-3-of-3/100/UI_3_-20-512.png>",
altText: '<Type the text you want to display as a hover text. For example, SAG_Footer>'
},
{
value: "2",
url: "<Enter the path for the image.
For example,https://cdn2.iconfinder.com/data/icons/right-and-wrong/48/wrong-2-512.png>",
altText: '<Type the text you want to display as a hover text. For example, AAC-logo>',
iconPosition: 'left'
},
{
value: "3",
url: "<Enter the path for the image.
For example, https://companies.mybroadband.co.za/files/2015/07/Software-AG-logo.jpg>",
altText: '<Type the text you want to display as a hover text. For example, SAG_Footer>',
iconPosition: 'right'
}
];
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