Table of Contents

Class FormComponentAttribute

Namespace
Kentico.Xperience.Admin.Base.FormAnnotations
Assembly
Kentico.Xperience.Admin.Base.Shared.dll

Defines a base class for form component attributes.

[MapProperties]
[AttributeUsage(AttributeTargets.Property, AllowMultiple = false, Inherited = false)]
public abstract class FormComponentAttribute : Attribute
Inheritance
object
Attribute
FormComponentAttribute
Derived
Extension Methods

Constructors

FormComponentAttribute() 

protected FormComponentAttribute()

Properties

Disabled

Indicates whether the component is disabled.

[Obsolete("Use EditMode set to FormEditMode.Disabled instead.")]
public bool Disabled { get; set; }

Property Value

bool

EditMode

Gets or sets the edit mode of the form component.

public FormEditMode EditMode { get; set; }

Property Value

FormEditMode

ExplanationText

The form component explanation text.

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

InactiveMessage

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

public string InactiveMessage { get; set; }

Property Value

string

Label

The form component label.

public string Label { get; set; }

Property Value

string

Order

Gets or sets the form component order weight in the form.

public int Order { get; set; }

Property Value

int

Tooltip

The form component tooltip.

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