Table of Contents

Interface IFormComponentClientProperties

Namespace
Kentico.Xperience.Admin.Base.Forms
Assembly
Kentico.Xperience.Admin.Base.dll

Represents the system properties of a form component.

public interface IFormComponentClientProperties : IFormItemClientProperties
Extension Methods

Remarks

The system uses this interface to process form component properties. For defining custom properties, inherit the FormComponentClientProperties<TValue> class.

Properties

ComponentName

Gets or sets the name of the client component.

string ComponentName { get; set; }

Property Value

string

Disabled

Gets or sets whether the component should be disabled.

bool Disabled { get; set; }

Property Value

bool

ExplanationText

Gets or sets the explanation text of the form component.

string ExplanationText { get; set; }

Property Value

string

ExplanationTextAsHtml

Indicates that explanation text is rendered as HTML.

bool ExplanationTextAsHtml { get; set; }

Property Value

bool

Remarks

Beware that enabling this property may lead to executing malicious code on client.

Guid

Gets or sets the underlying field GUID.

Guid Guid { get; set; }

Property Value

Guid

HasDependencies

Gets or sets the value indicating whether evaluation of a visibility condition of some other component depends on this component's value.

bool HasDependencies { get; set; }

Property Value

bool

InactiveMessage

Gets or sets the tooltip message displayed when the component is disabled.

string InactiveMessage { get; set; }

Property Value

string

Label

Gets or sets the label of the form component.

string Label { get; set; }

Property Value

string

Name

Gets or sets the underlying field name.

string Name { get; set; }

Property Value

string

Required

Gets or sets value indicating whether the underlying field is required. False by default. If false, the form component's implementation must accept nullable input.

bool Required { get; set; }

Property Value

bool

StatusText

Gets or sets the status text of the form component.

string StatusText { get; set; }

Property Value

string

Tooltip

Gets or sets the tooltip of the form component.

string Tooltip { get; set; }

Property Value

string

TooltipAsHtml

Indicates that tooltip is rendered as HTML.

bool TooltipAsHtml { get; set; }

Property Value

bool

Remarks

Beware that enabling this property may lead to executing malicious code on client.

ValidationRules

Gets the enumeration of the form component's validation rule properties.

IEnumerable<ValidationRuleClientProperties> ValidationRules { get; set; }

Property Value

IEnumerable<ValidationRuleClientProperties>

Value

Gets or sets the value of the form component.

object Value { get; set; }

Property Value

object

See Also

FormComponentClientProperties<TValue>