FormComponentTProperties, TValue Class |
Namespace: Kentico.Forms.Web.Mvc
public abstract class FormComponent<TProperties, TValue> : FormComponent where TProperties : new(), FormComponentProperties<TValue>
The FormComponentTProperties, TValue type exposes the following members.
Name | Description | |
---|---|---|
FormComponentTProperties, TValue |
Initializes a new instance of the FormComponentTProperties, TValue class.
|
Name | Description | |
---|---|---|
BaseProperties |
Gets the form component's properties as its base type.
(Overrides FormComponentBaseProperties.) | |
CustomAutopostHandling |
If true, prevents built-in visibility condition handling for this component.
(Inherited from FormComponent.) | |
Definition |
Gets or sets the definition under which the form component is registered in the system.
(Inherited from FormComponent.) | |
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.) | |
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.) | |
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.) | |
Properties |
Gets the form component's properties.
| |
PropertiesType |
Gets the properties type of the form component.
(Inherited from FormComponent.) | |
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.) |
Name | Description | |
---|---|---|
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. | |
GetDisplayName |
Returns non-localized string representing component name.
Component Name is returned in case of empty Label.
(Inherited from FormComponent.) | |
GetModelPropertyCustomAttributesT |
Gets a collection of custom attributes applied to the model's property
this form component represents.
(Inherited from FormComponent.) | |
GetObjectValue |
Gets the value of the form component. The GetValue method can be used
directly to obtain the typed value.
(Overrides FormComponentGetObjectValue.) | |
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.
| |
LoadProperties |
Loads properties of the form component. The actual properties type must match the PropertiesType.
(Overrides FormComponentLoadProperties(FormComponentProperties).) | |
ModifyMetadata |
Modifies modelMetadata according to the current object.
(Inherited from FormComponent.) | |
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 FormComponentSetObjectValue(Object).) | |
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.
| |
Validate |
Determines whether the specified object is valid.
Only invoked if validation by validation attributes passes for all fields.
(Inherited from FormComponent.) |
Name | Description | |
---|---|---|
GetBizFormComponentContext |
Gets BizFormComponentContext of a form component, if such a context was bound to the component.
(Defined by FormComponentExtensions.) |