FormComponent<TProperties, TValue> Class

Represents a base class for a form component. Inherit this class to define a custom form component.

Inheritance Hierarchy

System.Object
  Kentico.Forms.Web.Mvc.FormComponent
    Kentico.Forms.Web.Mvc.FormComponent<TProperties, 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 FormComponent<TProperties, TValue> : FormComponent
where TProperties : new(), FormComponentProperties<TValue>

Type Parameters

TProperties

Properties type of the form component.

TValue

Value type of the form component.

The FormComponent<TProperties, TValue> type exposes the following members.

Constructors

	Name	Description
Protected method	FormComponent<TProperties, TValue>	Initializes a new instance of the FormComponent<TProperties, TValue> class.

Properties

	Name	Description
Public property	BaseProperties	Gets the form component's properties as its base type. (Overrides FormComponent.BaseProperties.)
Public property	CustomAutopostHandling	If true, prevents built-in visibility condition handling for this component. (Inherited from FormComponent.)
Public property	Definition	Gets or sets the definition under which the form component is registered in the system. (Inherited from FormComponent.)
Public property	HasDependingFields	Gets or sets a value indicating whether there are another form components whose visibility condition depends on this component's value. (Inherited from FormComponent.)
Public property	LabelForPropertyName	Gets the name of the property representing the editing field in the resulting HTML markup. The name is used to infer a proper label for attribute value in the rendered HTML markup. Defaults to first found property annotated with BindablePropertyAttribute. (Inherited from FormComponent.)
Public property	Name	Gets or sets the name of the corresponding form field. The name is used as a prefix when naming the HTML input. (Inherited from FormComponent.)
Public property	Properties	Gets the form component's properties.
Public property	PropertiesType	Gets the properties type of the form component. (Inherited from FormComponent.)
Public property	ShowPartialValidationMessages	Also shows validation errors of partial values of the component. If false, each individual component should contain validation message in its partial view. (Inherited from FormComponent.)

Methods

	Name	Description
Public method	BindContext	Binds contextual information to the form component. The actual type of context depends on where the component is being used. The component can throw an exception if being used in a context for which it is not designed. The base implementation provided by this class must be called prior to throwing an exception, however. (Inherited from FormComponent.)
Public method	GetDisplayName	Returns non-localized string representing component name. Component Name is returned in case of empty Label. (Inherited from FormComponent.)
Public method	GetModelPropertyCustomAttributes<T>	Gets a collection of custom attributes applied to the model's property this form component represents. (Inherited from FormComponent.)
Public method	GetObjectValue	Gets the value of the form component. The GetValue() method can be used directly to obtain the typed value. (Overrides FormComponent.GetObjectValue().)
Public method	GetValue	Gets the value of the form component. Implement in a subclass to return value of a desired property. Method can also be used to return a value composed of multiple properties if required.
Public method	LoadProperties	Loads properties of the form component. The actual properties type must match the PropertiesType. (Overrides FormComponent.LoadProperties(FormComponentProperties).)
Public method	ModifyMetadata	Modifies modelMetadata according to the current object. (Inherited from FormComponent.)
Public method	SetObjectValue	Sets the value of the form component. The value must be of proper type or an exception is thrown. The SetValue(TValue) method can be used directly to set the typed default value. (Overrides FormComponent.SetObjectValue(Object).)
Public method	SetValue	Sets the value of the form component. Implement in a subclass to set value of a desired property. Method can also be used to decompose passed value into several properties rendered in the resulting form component markup.
Public method	Validate	Determines whether the specified object is valid. Only invoked if validation by validation attributes passes for all fields. (Inherited from FormComponent.)

Extension Methods

	Name	Description
Public Extension Method	GetBizFormComponentContext	Gets BizFormComponentContext of a form component, if such a context was bound to the component. (Defined by FormComponentExtensions.)

Remarks

Properties which are expected to have automatically bound values after form submit, have to be annotated with BindablePropertyAttribute.