context_v2_propertyTemplate Script API

Former Member — Fri, 13 May 2022 19:24:53 GMT

Current Revision posted to API Documentation by Former Member on 05/13/2022 19:24:53

This extension is only available when rendering a macro as a custom property template for a configuration property. It is not generally available for use by widgets, embeddables, or automations.

Properties
ResolveResource

Properties

Name	Access	Type	Description
CanStoreUrlContents	Read	`Boolean`	Returns true if the configuration store for this property supports storing referenced URL contents. When URL contents can be stored, local CFS URL references in HTML, Url, UrlList, and configured Custom properties will be saved with this configuration data.
DateFormatString	Read	`String`	The .net format string used to format a DateTime object into a date string.
DateTimeFormatString	Read	`String`	The .net format string used to format a DateTime object into a date-and-time string.
FormId	Read	`String`	The client identifier used by the form. This ID can be used with the dynamicForm jQuery plugin to interace with other properties within the same configuration form.
JsonApi	Read	`String`	The JSON private API to interface with the overall form: { register: function({ hasValue: function() { /* return true or false / } val: function(val) { / if val is defined, set the value of the property. if not, return the current value / } }), changed: function(val) { / notify the form of changes to this property's value */ } } This API should be rendered by the template and used to interact with the overall form. The register function should be called by this property template and define the hasValue and val functions. When the value of this property is changed by the rendering of this template, the changed function should be called.
Property	Read	`[[Property Script API Type\|Property]]`	The property to render.
SerializedValue	Read	`String`	The current value of the property as serialized value.
TimeFormatString	Read	`String`	The .net format string used to format a DateTime object into a time string.
UniqueId	Read	`String`	The unique identifier to use for client rendering. Any additional identifiers required by the rendering of the property should be extended from this one.
ValidUrlPattern	Read	`String`	The regular expression pattern that can be used to validate a URL.
Value	Read	`Object`	The current value of the property.

Methods

ResolveResource

Resolves a language resource name to a string or defaults to the provided text if the resource is not available.

Velocity

#set($stringResponse = $context_v2_propertyTemplate.ResolveResource($resourceName, $defaultText))

JavaScript

var stringResponse = context_v2_propertyTemplate.ResolveResource(resourceName, defaultText);

Parameters

Name	Type	Description	Required	Default	Options
resourceName	`String`	Resource Name	Required
defaultText	`String`	Default Text	Required

Returns

String