IPropertyTemplateOptions Plugin Supplementary Type

Ben Tiedt — Fri, 08 Mar 2024 17:13:37 GMT

Current Revision posted to API Documentation by Ben Tiedt on 03/08/2024 17:13:37

IPropertyTemplateOptions is defined in the Telligent.Evolution.Extensibility.Configuration.Version1 namespace of Telligent.Evolution.Platform.dll

Definition

interface IPropertyTemplateOptions
{
	bool CanStoreUrlContents { get;  }
	string DateFormatString { get;  }
	string DateTimeFormatString { get;  }
	string FormId { get;  }
	string JsonApi { get;  }
	[[Property Plugin Supplementary Type|Property]] Property { get;  }
	string TimeFormatString { get;  }
	string UniqueId { get;  }
	string ValidUrlPattern { get;  }
	Object Value { get;  }
	string ResolveResource(string resourceName, string defaultText);
}

Properties

Name	Type	Description
CanStoreUrlContents	`bool`	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	`string`	The .net format string used to format a DateTime object into a date string.
DateTimeFormatString	`string`	The .net format string used to format a DateTime object into a date-and-time string.
FormId	`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	`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	`[[Property Plugin Supplementary Type\|Property]]`	The property to render.
TimeFormatString	`string`	The .net format string used to format a DateTime object into a time string.
UniqueId	`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	`string`	The regular expression pattern that can be used to validate a URL.
Value	`Object`	The current value of the property.

Methods

string ResolveResource(string resourceName, string defaultText);

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

Parameters

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

Return Type

string