core_v2_dynamicForm Script API

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

Velocity

#set($stringResponse = $core_v2_dynamicForm.GetHasValueScript($uniqueId))

JavaScript

var stringResponse = core_v2_dynamicForm.GetHasValueScript(uniqueId);

Parameters

Name	Type	Description	Required	Default	Options
uniqueId	`String`	Unique Id	Required

Returns

String

GetTypeScript

Renders a JavaScript function which accepts a field in a dynamic form and returns the type of that field

Velocity

#set($stringResponse = $core_v2_dynamicForm.GetTypeScript($uniqueId))

JavaScript

var stringResponse = core_v2_dynamicForm.GetTypeScript(uniqueId);

Parameters

Name	Type	Description	Required	Default	Options
uniqueId	`String`	Unique Id	Required

Returns

String

GetValueScript

Renders a JavaScript function which accepts a field in a dynamic form and returns the value of that field

Velocity

#set($stringResponse = $core_v2_dynamicForm.GetValueScript($uniqueId))

JavaScript

var stringResponse = core_v2_dynamicForm.GetValueScript(uniqueId);

Parameters

Name	Type	Description	Required	Default	Options
uniqueId	`String`	Unique Id	Required

Returns

String

GetValuesScript

Renders a JavaScript expression which extracts the current values of a rendered dynamic form

Velocity

#set($stringResponse = $core_v2_dynamicForm.GetValuesScript($uniqueId))

JavaScript

var stringResponse = core_v2_dynamicForm.GetValuesScript(uniqueId);

Parameters

Name	Type	Description	Required	Default	Options
uniqueId	`String`	Form Id	Required

Returns

String

RenderForm

RenderForm Overload 1

Renders a dynamic form based on dynamic configuration XML

Velocity

#set($stringResponse = $core_v2_dynamicForm.RenderForm($uniqueId, $configurationXml))

JavaScript

var stringResponse = core_v2_dynamicForm.RenderForm(uniqueId, configurationXml);

Parameters

Name	Type	Description	Required	Default	Options
uniqueId	`String`	Unique Id	Required
configurationXml	`String`	Configuration Xml	Required

RenderForm Overload 2

Renders a dynamic form based on dynamic configuration XML

Velocity

#set($stringResponse = $core_v2_dynamicForm.RenderForm($uniqueId, $configurationXml, "%{ EnableFileEmbedding = $enableFileEmbeddingArg, GroupFooterHtmlFormat = $groupFooterHtmlFormatArg, GroupHeaderHtmlFormat = $groupHeaderHtmlFormatArg, HidePropertiesWithoutValues = $hidePropertiesWithoutValuesArg, PropertyFooterHtmlFormat = $propertyFooterHtmlFormatArg, PropertyHeaderHtmlFormat = $propertyHeaderHtmlFormatArg, SubGroupFooterHtmlFormat = $subGroupFooterHtmlFormatArg, SubGroupHeaderHtmlFormat = $subGroupHeaderHtmlFormatArg }"))

JavaScript

var stringResponse = core_v2_dynamicForm.RenderForm(uniqueId, configurationXml, { EnableFileEmbedding: enableFileEmbeddingArg, GroupFooterHtmlFormat: groupFooterHtmlFormatArg, GroupHeaderHtmlFormat: groupHeaderHtmlFormatArg, HidePropertiesWithoutValues: hidePropertiesWithoutValuesArg, PropertyFooterHtmlFormat: propertyFooterHtmlFormatArg, PropertyHeaderHtmlFormat: propertyHeaderHtmlFormatArg, SubGroupFooterHtmlFormat: subGroupFooterHtmlFormatArg, SubGroupHeaderHtmlFormat: subGroupHeaderHtmlFormatArg });

Parameters

Name	Type	Description	Required	Default
uniqueId	`String`	Unique Id	Required
configurationXml	`String`	Configuration Xml	Required
options	Options	Set of optional parameters including:	Required
EnableFileEmbedding	`Boolean`	Enables storage of temporary files within Url, UrlList, and Html properties. When enabled, the caller is responsible for detecting and storing temporarily stored files referenced in these properties.	Optional	False
GroupFooterHtmlFormat	`String`	Group Footer Html Format	Optional
GroupHeaderHtmlFormat	`String`	Group Header Html Format	Optional
HidePropertiesWithoutValues	`Boolean`	Hide Properties Without Values	Optional	False
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

RenderForm Overload 3

Renders a dynamic form based on dynamic configuration XML

Velocity

#set($stringResponse = $core_v2_dynamicForm.RenderForm($uniqueId, $configurationXml, $data))

JavaScript

var stringResponse = core_v2_dynamicForm.RenderForm(uniqueId, configurationXml, data);

Parameters

Name	Type	Description	Required
uniqueId	`String`	Unique Id	Required
configurationXml	`String`	Configuration Xml	Required
data	`QueryString`	Data to pre-fill in the form	Required

RenderForm Overload 4

Renders a dynamic form based on dynamic configuration XML

Velocity

#set($stringResponse = $core_v2_dynamicForm.RenderForm($uniqueId, $configurationXml, $data, "%{ EnableFileEmbedding = $enableFileEmbeddingArg, GroupFooterHtmlFormat = $groupFooterHtmlFormatArg, GroupHeaderHtmlFormat = $groupHeaderHtmlFormatArg, HidePropertiesWithoutValues = $hidePropertiesWithoutValuesArg, PropertyFooterHtmlFormat = $propertyFooterHtmlFormatArg, PropertyFooterHtmlFormatOverride_[Template] = $propertyFooterHtmlFormatOverride_[Template]Arg, PropertyHeaderHtmlFormat = $propertyHeaderHtmlFormatArg, PropertyHeaderHtmlFormatOverride_[Template] = $propertyHeaderHtmlFormatOverride_[Template]Arg, SubGroupFooterHtmlFormat = $subGroupFooterHtmlFormatArg, SubGroupHeaderHtmlFormat = $subGroupHeaderHtmlFormatArg }"))

JavaScript

var stringResponse = core_v2_dynamicForm.RenderForm(uniqueId, configurationXml, data, { EnableFileEmbedding: enableFileEmbeddingArg, GroupFooterHtmlFormat: groupFooterHtmlFormatArg, GroupHeaderHtmlFormat: groupHeaderHtmlFormatArg, HidePropertiesWithoutValues: hidePropertiesWithoutValuesArg, PropertyFooterHtmlFormat: propertyFooterHtmlFormatArg, PropertyFooterHtmlFormatOverride_[Template]: propertyFooterHtmlFormatOverride_[Template]Arg, PropertyHeaderHtmlFormat: propertyHeaderHtmlFormatArg, PropertyHeaderHtmlFormatOverride_[Template]: propertyHeaderHtmlFormatOverride_[Template]Arg, SubGroupFooterHtmlFormat: subGroupFooterHtmlFormatArg, SubGroupHeaderHtmlFormat: subGroupHeaderHtmlFormatArg });

Parameters

Name	Type	Description	Required	Default
uniqueId	`String`	Unique Id	Required
configurationXml	`String`	Configuration Xml	Required
data	`QueryString`	Data to pre-fill in the form	Required
options	Options	Set of optional parameters including:	Required
EnableFileEmbedding	`Boolean`	Enables storage of temporary files within Url, UrlList, and Html properties. When enabled, the caller is responsible for detecting and storing temporarily stored files referenced in these properties.	Optional	False
GroupFooterHtmlFormat	`String`	Group Footer Html Format	Optional
GroupHeaderHtmlFormat	`String`	Group Header Html Format	Optional
HidePropertiesWithoutValues	`Boolean`	Hide Properties Without Values	Optional	False
PropertyFooterHtmlFormat	`String`	Property Footer Html Format	Optional
PropertyFooterHtmlFormatOverride_[Template]	`String`	Property Footer Html Format Override _ [ Template ]	Optional
PropertyHeaderHtmlFormat	`String`	Property Header Html Format	Optional
PropertyHeaderHtmlFormatOverride_[Template]	`String`	Property Header Html Format Override _ [ Template ]	Optional
SubGroupFooterHtmlFormat	`String`	Sub Group Footer Html Format	Optional
SubGroupHeaderHtmlFormat	`String`	Sub Group Header Html Format	Optional

Returns

String

ToString

Velocity

#set($stringResponse = $core_v2_dynamicForm.ToString())

JavaScript

var stringResponse = core_v2_dynamicForm.ToString();

Returns

String

Recommended