FormComponentProperties Class

Defines properties which are common to all form components. Do not inherit this class directly, inherit the FormComponentProperties<TValue> class instead.

Inheritance Hierarchy

System.Object
  Kentico.Forms.Web.Mvc.FormComponentProperties
    Kentico.Forms.Web.Mvc.FormComponentProperties<TValue>

Namespace: Kentico.Forms.Web.Mvc
Assembly: Kentico.Content.Web.Mvc (in Kentico.Content.Web.Mvc.dll) Version: 13.0.131

Syntax

public abstract class FormComponentProperties

The FormComponentProperties type exposes the following members.

Constructors

	Name	Description
Protected method	FormComponentProperties	Initializes a new instance of the FormComponentProperties class using the data type, size and precision given.

Properties

	Name	Description
Public property	DataType	Gets or sets the underlying field data type.
Public property	ExplanationText	Gets or sets the explanation text of the form component.
Public property	Guid	Gets or sets the underlying field GUID.
Public property	Label	Gets or sets the label of the form component.
Public property	Name	Gets or sets the underlying field name.
Public property	Placeholder	Gets or sets the value displayed as placeholder in the input. Override and annotate with EditingComponentAttribute to make this property editable in properties panel.
Public property	Precision	Gets or sets the underlying field precision.
Public property	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 property	Size	Gets or sets the underlying field size.
Public property	SmartField	Gets or sets value indicating whether the underlying field is smart field. False by default.
Public property	Tooltip	Gets or sets the tooltip of the form component.
Public property	ValidationRuleConfigurations	Gets or sets validation rule configurations assigned to the form component.
Public property	VisibilityConditionConfiguration	Gets or sets visibility condition configuration assigned to the form component.

Methods

	Name	Description
Public method	GetDefaultValue	When overridden in a derived class, gets the default value.
Public method	SetDefaultValue	When overridden in a derived class, sets the default value to value. The value must be of proper type or an exception is thrown.