Enables scripted content fragments to render and interact with the configured content editor.
Methods
GetHasValueScript
Renders a JavaScript function which accepts a field in a dynamic form and returns whether the field has a value
Usage
#set($stringResponse = $core_v2_dynamicForm.GetHasValueScript($uniqueId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
uniqueId | string | Unique Id | Required |
Return Type
string
GetTypeScript
Renders a JavaScript function which accepts a field in a dynamic form and returns the type of that field
Usage
#set($stringResponse = $core_v2_dynamicForm.GetTypeScript($uniqueId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
uniqueId | string | Unique Id | Required |
Return Type
string
GetValueScript
Renders a JavaScript function which accepts a field in a dynamic form and returns the value of that field
Usage
#set($stringResponse = $core_v2_dynamicForm.GetValueScript($uniqueId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
uniqueId | string | Unique Id | Required |
Return Type
string
GetValuesScript
Renders a JavaScript expression which extracts the current values of a rendered dynamic form
Usage
#set($stringResponse = $core_v2_dynamicForm.GetValuesScript($uniqueId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
uniqueId | string | Form Id | Required |
Return Type
string
RenderForm
Renders a dynamic form based on dynamic configuration XML
Usage
#set($stringResponse = $core_v2_dynamicForm.RenderForm($uniqueId, $configurationXml, $data))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
uniqueId | string | Unique Id | Required | ||
configurationXml | string | Configuration Xml | Required | ||
data | QueryString | Data to pre-fill in the form | Required |
Return Type
string
RenderForm
Renders a dynamic form based on dynamic configuration XML
Usage
#set($stringResponse = $core_v2_dynamicForm.RenderForm($uniqueId, $configurationXml, $data, "%{GroupFooterHtmlFormat = $groupFooterHtmlFormatArg, GroupHeaderHtmlFormat = $groupHeaderHtmlFormatArg, HidePropertiesWithoutValues = $hidePropertiesWithoutValuesArg, PropertyFooterHtmlFormat = $propertyFooterHtmlFormatArg, PropertyHeaderHtmlFormat = $propertyHeaderHtmlFormatArg, SubGroupFooterHtmlFormat = $subGroupFooterHtmlFormatArg, SubGroupHeaderHtmlFormat = $subGroupHeaderHtmlFormatArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
uniqueId | string | Unique Id | Required | ||
configurationXml | string | Configuration Xml | Required | ||
data | QueryString | Data to pre-fill in the form | Required | ||
GroupFooterHtmlFormat | string | Group Footer Html Format | Optional | ||
GroupHeaderHtmlFormat | string | Group Header Html Format | Optional | ||
HidePropertiesWithoutValues | bool | Hide Properties Without Values | Optional | ||
PropertyFooterHtmlFormat | string | Property Footer Html Format | Optional | ||
PropertyHeaderHtmlFormat | string | Property Header Html Format | Optional | ||
SubGroupFooterHtmlFormat | string | Sub Group Footer Html Format | Optional | ||
SubGroupHeaderHtmlFormat | string | Sub Group Header Html Format | Optional |
Return Type
string
RenderForm
Renders a dynamic form based on dynamic configuration XML
Usage
#set($stringResponse = $core_v2_dynamicForm.RenderForm($uniqueId, $configurationXml))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
uniqueId | string | Unique Id | Required | ||
configurationXml | string | Configuration Xml | Required |
Return Type
string
RenderForm
Renders a dynamic form based on dynamic configuration XML
Usage
#set($stringResponse = $core_v2_dynamicForm.RenderForm($uniqueId, $configurationXml, "%{GroupFooterHtmlFormat = $groupFooterHtmlFormatArg, GroupHeaderHtmlFormat = $groupHeaderHtmlFormatArg, HidePropertiesWithoutValues = $hidePropertiesWithoutValuesArg, PropertyFooterHtmlFormat = $propertyFooterHtmlFormatArg, PropertyHeaderHtmlFormat = $propertyHeaderHtmlFormatArg, SubGroupFooterHtmlFormat = $subGroupFooterHtmlFormatArg, SubGroupHeaderHtmlFormat = $subGroupHeaderHtmlFormatArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
uniqueId | string | Unique Id | Required | ||
configurationXml | string | Configuration Xml | Required | ||
GroupFooterHtmlFormat | string | Group Footer Html Format | Optional | ||
GroupHeaderHtmlFormat | string | Group Header Html Format | Optional | ||
HidePropertiesWithoutValues | bool | Hide Properties Without Values | Optional | ||
PropertyFooterHtmlFormat | string | Property Footer Html Format | Optional | ||
PropertyHeaderHtmlFormat | string | Property Header Html Format | Optional | ||
SubGroupFooterHtmlFormat | string | Sub Group Footer Html Format | Optional | ||
SubGroupHeaderHtmlFormat | string | Sub Group Header Html Format | Optional |
Return Type
string