FormComponentProperties<TValue> Class

Defines properties which are common to all form components. Inherit this class to create properties of custom form components.

Inheritance Hierarchy

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

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<TValue> : FormComponentProperties

Type Parameters

TValue

Value type of the form component this properties are designed for. Determines the DefaultValue type.

The FormComponentProperties<TValue> type exposes the following members.

Constructors

	Name	Description
Protected method	FormComponentProperties<TValue>	Initializes a new instance of the FormComponentProperties<TValue> class using the data type, size and precision given. Specifying the size and precision is optional and depends on whether the dataType requires them.

Properties

	Name	Description
Public property	DataType	Gets or sets the underlying field data type. (Inherited from FormComponentProperties.)
Public property	DefaultValue	When overridden in a derived class, gets or sets the default value of the form component and underlying field. Use the DefaultValueEditingComponentAttribute to specify a form component for editing.
Public property	ExplanationText	Gets or sets the explanation text of the form component. (Inherited from FormComponentProperties.)
Public property	Guid	Gets or sets the underlying field GUID. (Inherited from FormComponentProperties.)
Public property	Label	Gets or sets the label of the form component. (Inherited from FormComponentProperties.)
Public property	Name	Gets or sets the underlying field name. (Inherited from FormComponentProperties.)
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. (Inherited from FormComponentProperties.)
Public property	Precision	Gets or sets the underlying field precision. (Inherited from FormComponentProperties.)
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. (Inherited from FormComponentProperties.)
Public property	Size	Gets or sets the underlying field size. (Inherited from FormComponentProperties.)
Public property	SmartField	Gets or sets value indicating whether the underlying field is smart field. False by default. (Inherited from FormComponentProperties.)
Public property	Tooltip	Gets or sets the tooltip of the form component. (Inherited from FormComponentProperties.)
Public property	ValidationRuleConfigurations	Gets or sets validation rule configurations assigned to the form component. (Inherited from FormComponentProperties.)
Public property	VisibilityConditionConfiguration	Gets or sets visibility condition configuration assigned to the form component. (Inherited from FormComponentProperties.)

Methods

	Name	Description
Public method	GetDefaultValue	Gets the default value. The DefaultValue property can be used directly to obtain the typed default value. (Overrides FormComponentProperties.GetDefaultValue().)
Public method	SetDefaultValue	Sets the default value to value. The value must be of type TValue or an exception is thrown. The DefaultValue property can be used directly to set the typed default value. (Overrides FormComponentProperties.SetDefaultValue(Object).)