Table of Contents

Class FormComponentProperties<TValue>

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

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

public abstract class FormComponentProperties<TValue> : FormComponentProperties

Type Parameters

TValue

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

Inheritance
object
FormComponentProperties<TValue>
Derived
Inherited Members
Extension Methods

Constructors

FormComponentProperties(string, int, int)

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.

protected FormComponentProperties(string dataType, int size = -1, int precision = -1)

Parameters

dataType string

Default data type of values (typically a constant from FieldDataType).

size int

Default size of values.

precision int

Default precision of values.

See Also

Properties

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 abstract TValue DefaultValue { get; set; }

Property Value

TValue

Methods

GetDefaultValue()

Gets the default value. The DefaultValue property can be used directly to obtain the typed default value.

public override object GetDefaultValue()

Returns

object

Returns the default value.

SetDefaultValue(object)

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.

public override void SetDefaultValue(object value)

Parameters

value object

Value to be set as the default value.

See Also

EditingComponentAttribute
EditingComponentPropertyAttribute
EditingComponentOrder