Table of Contents

Class FormComponent

Namespace
Kentico.Forms.Web.Mvc
Assembly
Kentico.Content.Web.Mvc.dll

Represents a base class for a form component containing members used by the system. Do not inherit this class directly, inherit the FormComponent<TProperties, TValue> class instead.

public abstract class FormComponent
Inheritance
object
FormComponent
Derived
FormComponent<TProperties, TValue>
Extension Methods

Remarks

Properties which are expected to have automatically bound values after form submit, have to be annotated with BindablePropertyAttribute. Implements the System.ComponentModel.DataAnnotations.IValidatableObject to support custom validation.

Constructors

FormComponent(Type)

Initializes a new instance of the FormComponent class for the specified properties type.

protected FormComponent(Type propertiesType)

Parameters

propertiesType Type

Properties type of the form component.

Exceptions

ArgumentNullException

Thrown when propertiesType is null.

ArgumentException

Thrown when propertiesType specifies a type which does not inherit FormComponentProperties.

Properties

BaseProperties

Gets the form component's properties as its base type.

[ValidateNever]
public abstract FormComponentProperties BaseProperties { get; }

Property Value

FormComponentProperties

CustomAutopostHandling

If true, prevents built-in visibility condition handling for this component.

public virtual bool CustomAutopostHandling { get; }

Property Value

bool
See Also

Definition

Gets or sets the definition under which the form component is registered in the system.

public FormComponentDefinition Definition { get; set; }

Property Value

FormComponentDefinition

HasDependingFields

Gets or sets a value indicating whether there are another form components whose visibility condition depends on this component's value.

public virtual bool HasDependingFields { get; set; }

Property Value

bool
See Also

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.

public virtual string LabelForPropertyName { get; }

Property Value

string
See Also

Name

Gets or sets the name of the corresponding form field. The name is used as a prefix when naming the HTML input.

public virtual string Name { get; set; }

Property Value

string
See Also

PropertiesType

Gets the properties type of the form component.

public Type PropertiesType { get; }

Property Value

Type

ShowPartialValidationMessages

Also shows validation errors of partial values of the component. If false, each individual component should contain validation message in its partial view.

public bool ShowPartialValidationMessages { get; set; }

Property Value

bool

Methods

BindContext(FormComponentContext)

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. 

public virtual void BindContext(FormComponentContext context)

Parameters

context FormComponentContext

GetDisplayName()

Returns non-localized string representing component name. Component Name is returned in case of empty Label.

public string GetDisplayName()

Returns

string

GetModelPropertyCustomAttributes<T>(bool)

Gets a collection of custom attributes applied to the model's property this form component represents.

public IEnumerable<T> GetModelPropertyCustomAttributes<T>(bool inherit) where T : Attribute

Parameters

inherit bool

A value indicating whether to inspect the ancestors of model's property.

Returns

IEnumerable<T>

Returns a collection of the custom attributes, or null if this form component was not instantiated for a model.

Type Parameters

T

The type of attribute to search for.

Remarks

The enumeration is available for form components created for a strongly typed model only. Form components representing forms built using the Form builder do not have a strongly typed model bound (i.e. null is returned).

GetObjectValue()

Gets the value of the form component.

public abstract object GetObjectValue()

Returns

object

Returns the value of the form component.

LoadProperties(FormComponentProperties)

Loads properties of the form component. The actual properties type must match the PropertiesType.

public abstract void LoadProperties(FormComponentProperties properties)

Parameters

properties FormComponentProperties

Form component properties to be loaded.

SetObjectValue(object)

Sets the value of the form component. The value must be of proper type or an exception is thrown.

public abstract void SetObjectValue(object value)

Parameters

value object

Value to be set.

Validate(ValidationContext)

Determines whether the specified object is valid. Only invoked if validation by validation attributes passes for all fields.

public virtual IEnumerable<ValidationResult> Validate(ValidationContext validationContext)

Parameters

validationContext ValidationContext

The validation context.

Returns

IEnumerable<ValidationResult>

A collection that holds failed-validation information.