Functions
# Create / Edit / Clone Pages Detail Page (Canvas) Detail Page (Standard)
getApiName() → {String}
Get the API name of subform field
api_name
Examples
SampleCopycopied
var field_obj = ZDK.Page.getSubform("CFSubform").getField('Custom_Lookup1');
field_obj.getApiName();Output
Custom_Lookup1# Create / Edit / Clone Pages Detail Page (Canvas) Detail Page (Standard)
setCriteria(criteria, config)
Set the criteria for lookup/picklist fields
Note: Detail/Canvas detail page supports only lookup fields.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
criteria |
String | criteria for filtering lookup records |
|
config |
Object |
<optional> |
config for lookup field criteria |
Examples
Lookup supports a maximum of five criteria, each using the starts_with and equals operators. The 'id' field supports the in operator.Copycopied
var field_obj = ZDK.Page.getSubform("CFSubform").getField('Custom_Lookup1');
field_obj.setCriteria("((Last_Name:equals:Burns)and(First_Name:starts_with:M))", {filterOnSearch: true});Picklist supports a maximum of five criteria, each using the starts_with, equals, ends_with, contains, not_equals and in operators.Copycopied
var field_obj = ZDK.Page.getSubform("CFSubform").getField('CFPicklist');
field_obj.setCriteria("((id:in:12111113441,12111113443))");Picklist sample with valueCopycopied
var field_obj = ZDK.Page.getSubform("CFSubform").getField('CFPicklist');
field_obj.setCriteria("(actual_value:starts_with:Industry)");Date field range supports only one criterion with between operator.Copycopied
var field_obj = ZDK.Page.getSubform("CFSubform").getField('Date_1');
field_obj.setCriteria("(value:between:2023-04-18,2023-04-25)");
Dynamic CriteriaCopycopied
var field_obj = ZDK.Page.getSubform("CFSubform").getField('Custom_Lookup1');
field_obj.setCriteria("((Last_Name:equals:{{CFSubform.Single_Line_1}}))", {filterOnSearch: true});# Create / Edit / Clone Pages Detail Page (Canvas) Detail Page (Standard)
setReadOnly(value)
Set the readonly attribute of subform field
Parameters:
| Name | Type | Description |
|---|---|---|
value |
Boolean | readonly property (true|false) |
Example
SampleCopycopied
var field_obj = ZDK.Page.getSubform("CFSubform").getField('Custom_Lookup1');
field_obj.setReadOnly(true);# Create / Edit / Clone Pages
setMandatory(value)
Set the mandatory attribute of subform field
Parameters:
| Name | Type | Description |
|---|---|---|
value |
Boolean | mandatory property (true|false) |
Example
SampleCopycopied
var field_obj = ZDK.Page.getSubform("CFSubform").getField('Custom_Lookup1');
field_obj.setMandatory(true);# Create / Edit / Clone Pages Detail Page (Canvas) Detail Page (Standard)
addInfo(message)
Set the info icon to a subform field
Parameters:
| Name | Type | Description |
|---|---|---|
message |
String | message/info to be added |
Example
SampleCopycopied
var field_obj = ZDK.Page.getSubform("CFSubform").getField('Custom_Lookup1');
field_obj.addInfo("This lookup is filtered by Name");# Create / Edit / Clone Pages Detail Page (Canvas) Detail Page (Standard)
setVisibility(value)
Show/Hide subform field.
Parameters:
| Name | Type | Description |
|---|---|---|
value |
Boolean | visibility property for the subform field (true|false) |
Example
SampleCopycopied
var field_obj = ZDK.Page.getSubform("CFSubform").getField('Custom_Lookup1');
field_obj.setVisibility(false);