IRuledConfigurablePlugin (v2) Plugin Type

Plugin that exposes one or more custom configuration property rules for use in configuring itself.

IRuledConfigurablePlugin is defined in the Telligent.Evolution.Extensibility.Version2 namespace of Telligent.Evolution.Platform.dll

Definition

interface IRuledConfigurablePlugin : IConfigurablePlugin, IPlugin
{
	void ExecutePropertyRule(string ruleName, IPropertyRuleExecutionOptions options);
	bool PropertyRuleExists(string ruleName);
	void RenderPropertyRule(string ruleName, TextWriter writer, IPropertyRuleRenderingOptions options);
}

Methods

void ExecutePropertyRule(string ruleName, IPropertyRuleExecutionOptions options);

Executes a local rule on the server-side.

Parameters

Name	Type	Description	Required	Default	Options
ruleName	`string`	Rule Name	Required
options	`IPropertyRuleExecutionOptions`	Options	Required

bool PropertyRuleExists(string ruleName);

Identifies if the rule name is supported by this plugin.

Parameters

Name	Type	Description	Required	Default	Options
ruleName	`string`	Rule Name	Required

Return Type

bool

void RenderPropertyRule(string ruleName, TextWriter writer, IPropertyRuleRenderingOptions options);

Renders a local rule to the client-side.

Parameters

Name	Type	Description	Required
ruleName	`string`	Rule Name	Required
writer	`TextWriter`	Writer	Required
options	`IPropertyRuleRenderingOptions`	Options	Required

Recommended