Table of Contents

Class FormComponentClientProperties<TValue>

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

Defines client properties which are common to all UI form components.

public abstract class FormComponentClientProperties<TValue> : IFormComponentClientProperties, IFormItemClientProperties

Type Parameters

TValue
Inheritance
object
FormComponentClientProperties<TValue>
Implements
Derived
Extension Methods

Properties

AdditionalActions 

public IEnumerable<AdditionalActionClientProperties> AdditionalActions { get; set; }

Property Value

IEnumerable<AdditionalActionClientProperties>

ComponentName

Gets or sets the name of the client component.

public string ComponentName { get; set; }

Property Value

string

Disabled

Gets or sets whether the component should be disabled.

public virtual bool Disabled { get; set; }

Property Value

bool

ExplanationText

Gets or sets the explanation text of the form component.

public virtual string ExplanationText { get; set; }

Property Value

string

ExplanationTextAsHtml

Indicates that explanation text is rendered as HTML.

public 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.

public 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.

public bool HasDependencies { get; set; }

Property Value

bool

InactiveMessage

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

public virtual string InactiveMessage { get; set; }

Property Value

string

Label

Gets or sets the label of the form component.

public virtual string Label { get; set; }

Property Value

string

Name

Gets or sets the underlying field name.

public virtual 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.

public virtual bool Required { get; set; }

Property Value

bool

StatusText

Gets or sets the status text of the form component.

public virtual string StatusText { get; set; }

Property Value

string

Tooltip

Gets or sets the tooltip of the form component.

public virtual string Tooltip { get; set; }

Property Value

string

TooltipAsHtml

Indicates that tooltip is rendered as HTML.

public 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.

public IEnumerable<ValidationRuleClientProperties> ValidationRules { get; set; }

Property Value

IEnumerable<ValidationRuleClientProperties>

Value 

public virtual TValue Value { get; set; }

Property Value

TValue