IPropertyRuleRenderingOptions Plugin Supplementary Type

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

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

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

Definition

interface IPropertyRuleRenderingOptions
{
	string DateFormatString { get;  }
	string DateTimeFormatString { get;  }
	string FormId { get;  }
	Object InitialValue { get;  }
	[[Property Plugin Supplementary Type|Property]] Property { get;  }
	[[PropertyRule Plugin Supplementary Type|PropertyRule]] Rule { get;  }
	string TimeFormatString { get;  }
	string UniqueId { get;  }
	string ValidUrlPattern { get;  }
	string ResolveResource(string resourceName, string defaultText);
}

Properties

Name	Type	Description
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.
InitialValue	`Object`	The initial value of the property, prior to the change triggering the rule execution.
Property	`[[Property Plugin Supplementary Type\|Property]]`	The property on which the rule is rendering.
Rule	`[[PropertyRule Plugin Supplementary Type\|PropertyRule]]`	The rule 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 rule should be extended from this one.
ValidUrlPattern	`string`	The regular expression pattern that can be used to validate a URL.

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