Class EventDataDialogField
Utility class to generate a field for dialog to use in CRMScript triggers.
Constructors
EventDataDialogField()
Initializes a new instance of the EventDataDialogField class.
Declaration
EventDataDialogFieldMethods
addListItem(String)
Adds individual items to list.
Declaration
Void addListItem(String item)Examples
EventDataDialogDefinition dialog;
EventDataDialogField field;
field.setId("myList");
field.setType("list");
field.addListItem("Value 1");
field.addListItem("Value 2");
dialog.addField(field);Parameters
| Type | Name | Description |
| String | id | Value for list item. |
Returns
| Type | Description |
| Void |
getAdditionalInfo()
Returns additional info for the named list.
Declaration
String getAdditionalInfo()Examples
EventDataDialogDefinition dialog;
EventDataDialogField field;
field.setType("list");
field.setListListName("ejcategory");
field.setAddtionalInfo("hierarchy=true&shortNames=true&onlyOwnCategories=true&excludeHistory=true&shortTooltip=true");
print(field.getAdditionalInfo());Returns
| Type | Description |
| String |
getAllowBlank()
Returns true if field is allowed to be empty instead of 0.
Declaration
Bool getAllowBlank()Examples
EventDataDialogDefinition dialog;
EventDataDialogField field;
field.setType("list");
field.setListListName("ejcategory");
field.setAllowBlank(false);
print(field.getAllowBlank().toString());Returns
| Type | Description |
| Bool |
getAllowRootSelection()
Returns true if root selection is allowed.
Declaration
Bool getAllowRootSelection()Examples
EventDataDialogDefinition dialog;
EventDataDialogField field;
field.setType("list");
field.setListListName("ejcategory");
field.setAllowRootSelection(false);
print(field.getAllowRootSelection().toString());Returns
| Type | Description |
| Bool |
getDays()
Returns true if days is enabled, used with timespan field type.
Declaration
Bool getDays()Examples
EventDataDialogDefinition dialog;
EventDataDialogField field;
field.setType("timespan");
field.setDays(false);
print(field.getDays().toString());Returns
| Type | Description |
| Bool |
getDefault()
Returns default value set.
Declaration
String getDefault()Examples
EventDataDialogDefinition dialog;
EventDataDialogField field;
field.setType("list");
field.setListListName("ejcategory");
field.setDefault("1");
print(field.getDefault());Returns
| Type | Description |
| String |
getDefaultFloat()
Returns default float value set. Only use for float field type.
Declaration
Float getDefaultFloat()Examples
EventDataDialogDefinition dialog;
EventDataDialogField field;
field.setType("list");
field.setListListName("ejcategory");
field.setDefaultFloat(3.14);
print(field.getDefaultFloat().toString(2));Returns
| Type | Description |
| Float |
getForceFlatList()
Force flat list if using list name.
Declaration
Bool getForceFlatList()Examples
EventDataDialogDefinition dialog;
EventDataDialogField field;
field.setType("list");
field.setListName("associate");
field.setForceFlatList(false);
print(field.getForceFlatList().toString());Returns
| Type | Description |
| Bool |
getId()
Returns identifier for field.
Declaration
String getId()Examples
EventDataDialogDefinition dialog;
EventDataDialogField field;
field.setType("list");
field.setListName("associate");
field.setId("assoc");
print(field.getId());Returns
| Type | Description |
| String |
getHideEmptyRootsInSearch()
If true, hide empty roots in search. Default is false. Only applies when showFullPath is true and field type is list.
Declaration
Bool getHideEmptyRootsInSearch()Examples
EventDataDialogDefinition dialog;
EventDataDialogField field;
field.setType("list");
field.setListName("associate");
field.setHideEmptyRootsInSearch(true);
print(field.getHideEmptyRootsInSearch().toString());Returns
| Type | Description |
| Bool |
getHours()
Returns true if hours is enabled, used with timespan field type.
Declaration
Bool getHours()Examples
EventDataDialogDefinition dialog;
EventDataDialogField field;
field.setType("timespan");
field.setHours(false);
print(field.getHours().toString());Returns
| Type | Description |
| Bool |
getLabel()
Returns label for field.
Declaration
String getLabel()Examples
EventDataDialogDefinition dialog;
EventDataDialogField field;
field.setType("list");
field.setListName("associate");
field.setLabel("My label");
print(field.getLabel());Returns
| Type | Description |
| String |
getListName()
Returns listname for field.
Declaration
String getListName()Examples
EventDataDialogDefinition dialog;
EventDataDialogField field;
field.setType("list");
field.setListName("associate");
print(field.getListName());Returns
| Type | Description |
| String |
getMandatory()
If true, field has to have a valid value.
Declaration
Bool getMandatory()Examples
EventDataDialogDefinition dialog;
EventDataDialogField field;
field.setType("list");
field.setListName("associate");
field.setMandatory(true);
print(field.getMandatory().toString());Returns
| Type | Description |
| Bool |
getMinutes()
Returns true if minutes is enabled, used with timespan field type.
Declaration
Bool getMinutes()Examples
EventDataDialogDefinition dialog;
EventDataDialogField field;
field.setType("timespan");
field.setMinutes(false);
print(field.getMinutes().toString());Returns
| Type | Description |
| Bool |
getPlaceholder()
Returns placeholder text for field.
Declaration
String getPlaceholder()Examples
EventDataDialogDefinition dialog;
EventDataDialogField field;
field.setType("list");
field.setListName("associate");
field.setPlaceholder("Select associate");
print(field.getPlaceholder());Returns
| Type | Description |
| String |
getSeconds()
Returns true if seconds is enabled, used with timespan field type.
Declaration
Bool getSeconds()Examples
EventDataDialogDefinition dialog;
EventDataDialogField field;
field.setType("timespan");
field.setSeconds(false);
print(field.getSeconds().toString());Returns
| Type | Description |
| Bool |
getShowAllChildrenInSearch()
Show all children when searching. Default is false. Only applies if showFullPath is true and field type is list.
Declaration
Bool getShowAllChildrenInSearch()Examples
EventDataDialogDefinition dialog;
EventDataDialogField field;
field.setType("list");
field.setListName("ejcategory");
field.setShowAllChildrenInSearch(true);
print(field.getShowAllChildrenInSearch().toString());Returns
| Type | Description |
| Bool |
getShowFullPath()
If true, list is preloaded so that the full path is shown.
Declaration
Bool getShowFullPath()Examples
EventDataDialogDefinition dialog;
EventDataDialogField field;
field.setType("list");
field.setListName("ejcategory");
field.setShowFullPath(true);
print(field.getShowFullPath().toString());Returns
| Type | Description |
| Bool |
getType()
Returns what type of field.
Declaration
String getType()Examples
EventDataDialogDefinition dialog;
EventDataDialogField field;
field.setType("list");
field.setListName("associate");
print(field.getType());Returns
| Type | Description |
| String |
setAdditionalInfo(String)
Sets additional info for the named list.
Declaration
Void setAdditionalInfo(String info)Examples
EventDataDialogDefinition dialog;
EventDataDialogField field;
field.setType("list");
field.setListListName("ejcategory");
field.setAddtionalInfo("hierarchy=true&shortNames=true&onlyOwnCategories=true&excludeHistory=true&shortTooltip=true");
print(field.getAdditionalInfo());Parameters
| Type | Name | Description |
| String | info | Additional info. |
Returns
| Type | Description |
| Void |
setAllowBlank(Bool)
Set to true if field is allowed to be empty instead of 0.
Declaration
Void setAllowBlank(Bool allowBlank)Examples
EventDataDialogDefinition dialog;
EventDataDialogField field;
field.setType("list");
field.setListListName("ejcategory");
field.setAllowBlank(false);
print(field.getAllowBlank().toString());Parameters
| Type | Name | Description |
| Bool | allowBlank | Allowing field to be empty instead of 0 if true. |
Returns
| Type | Description |
| Void |
setAllowRootSelection(Bool)
Set to true if root selection is allowed.
Declaration
Void setAllowRootSelection(Bool allowRoot)Examples
EventDataDialogDefinition dialog;
EventDataDialogField field;
field.setType("list");
field.setListListName("ejcategory");
field.setAllowRootSelection(false);
print(field.getAllowRootSelection().toString());Parameters
| Type | Name | Description |
| Bool | allowRoot | Allowing root selection if true. |
Returns
| Type | Description |
| Void |
setDays(Bool)
Set to true if days is enabled, used with timespan field type.
Declaration
Void setDays(Bool enable)Examples
EventDataDialogDefinition dialog;
EventDataDialogField field;
field.setType("timespan");
field.setDays(false);
print(field.getDays().toString());Parameters
| Type | Name | Description |
| Bool | enable | Enabling days if true. |
Returns
| Type | Description |
| Void |
setDefault(String)
Sets default value for field.
Declaration
Void setDefault(String default)Examples
EventDataDialogDefinition dialog;
EventDataDialogField field;
field.setType("list");
field.setListListName("ejcategory");
field.setDefault("1");
print(field.getDefault());Parameters
| Type | Name | Description |
| String | default | Default value for field. |
Returns
| Type | Description |
| Void |
setDefaultFloat(Float)
Sets default float value. Only use for float field type.
Declaration
Void setDefaultFloat(Float default)Examples
EventDataDialogDefinition dialog;
EventDataDialogField field;
field.setType("list");
field.setListListName("ejcategory");
field.setDefaultFloat(3.14);
print(field.getDefaultFloat().toString(2));Parameters
| Type | Name | Description |
| Float | default | Default value for field. |
Returns
| Type | Description |
| Void |
setForceFlatList(Bool)
Force flat list if using list name.
Declaration
Void setForceFlatList(Bool enable)Examples
EventDataDialogDefinition dialog;
EventDataDialogField field;
field.setType("list");
field.setListName("associate");
field.setForceFlatList(false);
print(field.getForceFlatList().toString());Parameters
| Type | Name | Description |
| Bool | enable | Force flat list if true. |
Returns
| Type | Description |
| Void |
setLabel(String)
Sets label for field.
Declaration
Void setLabel(String label)Examples
EventDataDialogDefinition dialog;
EventDataDialogField field;
field.setType("list");
field.setListName("associate");
field.setLabel("My label");
print(field.getLabel());Parameters
| Type | Name | Description |
| String | enable | Label for field. |
Returns
| Type | Description |
| Void |
setListName(String)
Set listname for field.
Declaration
Void setListName(String listName)Examples
EventDataDialogDefinition dialog;
EventDataDialogField field;
field.setType("list");
field.setListName("associate");
print(field.getListName());Parameters
| Type | Name | Description |
| String | listName | Listname for field. |
Returns
| Type | Description |
| Void |
setId(String)
Set identifier for field.
Declaration
Void setId(String identifier)Examples
EventDataDialogDefinition dialog;
EventDataDialogField field;
field.setType("list");
field.setListName("associate");
field.setId("assoc");
print(field.getId());Parameters
| Type | Name | Description |
| String | identifier | Identifier for field. |
Returns
| Type | Description |
| Void |
setHideEmptyRootsInSearch(Bool)
If true, hide empty roots in search. Default is false. Only applies when showFullPath is true and field type is list.
Declaration
Void setHideEmptyRootsInSearch(Bool enable)Examples
EventDataDialogDefinition dialog;
EventDataDialogField field;
field.setType("list");
field.setListName("associate");
field.setHideEmptyRootsInSearch(true);
print(field.getHideEmptyRootsInSearch().toString());Parameters
| Type | Name | Description |
| Bool | enable | If true, hide empty roots in search. |
Returns
| Type | Description |
| Void |
setHours(Bool)
Returns true if hours is enabled, used with timespan field type.
Declaration
Void setHours(Bool enable)Examples
EventDataDialogDefinition dialog;
EventDataDialogField field;
field.setType("timespan");
field.setHours(false);
print(field.getHours().toString());Parameters
| Type | Name | Description |
| Bool | enable | If true, hours are enabled. |
Returns
| Type | Description |
| Void |
setMandatory(Bool)
If true, field has to have a valid value.
Declaration
Void setMandatory(Bool mandatory)Examples
EventDataDialogDefinition dialog;
EventDataDialogField field;
field.setType("list");
field.setListName("associate");
field.setMandatory(true);
print(field.getMandatory().toString());Parameters
| Type | Name | Description |
| Bool | mandatory | If true, field is mandatory. |
Returns
| Type | Description |
| Void |
setMinutes(Bool)
Returns true if minutes is enabled, used with timespan field type.
Declaration
Void setMinutes(Bool enable)Examples
EventDataDialogDefinition dialog;
EventDataDialogField field;
field.setType("timespan");
field.setMinutes(false);
print(field.getMinutes().toString());Parameters
| Type | Name | Description |
| Bool | enable | If true, minutes are enabled. |
Returns
| Type | Description |
| Void |
setPlaceholder(String)
Sets placeholder text for field.
Declaration
Void setPlaceholder(String placeholder)Examples
EventDataDialogDefinition dialog;
EventDataDialogField field;
field.setType("list");
field.setListName("associate");
field.setPlaceholder("Select associate");
print(field.getPlaceholder());Parameters
| Type | Name | Description |
| String | placeholder | Placeholder text for field. |
Returns
| Type | Description |
| Void |
setSeconds(Bool)
Returns true if seconds is enabled, used with timespan field type.
Declaration
Void setSeconds(Bool enable)Examples
EventDataDialogDefinition dialog;
EventDataDialogField field;
field.setType("timespan");
field.setSeconds(false);
print(field.getSeconds().toString());Parameters
| Type | Name | Description |
| Bool | enable | If true, seconds are enabled. |
Returns
| Type | Description |
| Void |
setShowAllChildrenInSearch(Bool)
Show all children when searching. Default is false. Only applies if showFullPath is true and field type is list.
Declaration
Void setShowAllChildrenInSearch(Bool enable)Examples
EventDataDialogDefinition dialog;
EventDataDialogField field;
field.setType("list");
field.setListName("ejcategory");
field.setShowAllChildrenInSearch(true);
print(field.getShowAllChildrenInSearch().toString());Parameters
| Type | Name | Description |
| Bool | enable | If true, shows all children when searching. |
Returns
| Type | Description |
| Void |
setShowFullPath(Bool)
If true, list is preloaded so that the full path is shown.
Declaration
Void setShowFullPath(Bool enable)Examples
EventDataDialogDefinition dialog;
EventDataDialogField field;
field.setType("list");
field.setListName("ejcategory");
field.setShowFullPath(true);
print(field.getShowFullPath().toString());Parameters
| Type | Name | Description |
| Bool | enable | If true, list is preloaded and shows full path. |
Returns
| Type | Description |
| Void |
setType(String)
Sets what type of field.
Declaration
Void setType(String type)Examples
EventDataDialogDefinition dialog;
EventDataDialogField field;
field.setType("list");
field.setListName("associate");
print(field.getType());Parameters
| Type | Name | Description |
| String | type | Type of field. |
Returns
| Type | Description |
| Void |