Click or drag to resize
FormComponentTProperties, TValue Class
Represents a base class for a form component. Inherit this class to define a custom form component.
Inheritance Hierarchy
SystemObject
  Kentico.Forms.Web.MvcFormComponent
    Kentico.Forms.Web.MvcFormComponentTProperties, TValue
      More...

Namespace: Kentico.Forms.Web.Mvc
Assembly: Kentico.Content.Web.Mvc (in Kentico.Content.Web.Mvc.dll) Version: 13.0.131
Syntax
C#
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 FormComponentTProperties, TValue type exposes the following members.

Constructors
  NameDescription
Protected methodFormComponentTProperties, TValue
Initializes a new instance of the FormComponentTProperties, TValue class.
Top
Properties
  NameDescription
Public propertyBaseProperties
Gets the form component's properties as its base type.
(Overrides FormComponentBaseProperties.)
Public propertyCustomAutopostHandling
If true, prevents built-in visibility condition handling for this component.
(Inherited from FormComponent.)
Public propertyDefinition
Gets or sets the definition under which the form component is registered in the system.
(Inherited from FormComponent.)
Public propertyHasDependingFields
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 propertyLabelForPropertyName
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 propertyName
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 propertyProperties
Gets the form component's properties.
Public propertyPropertiesType
Gets the properties type of the form component.
(Inherited from FormComponent.)
Public propertyShowPartialValidationMessages
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.)
Top
Methods
  NameDescription
Public methodBindContext

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 methodGetDisplayName
Returns non-localized string representing component name. Component Name is returned in case of empty Label.
(Inherited from FormComponent.)
Public methodGetModelPropertyCustomAttributesT
Gets a collection of custom attributes applied to the model's property this form component represents.
(Inherited from FormComponent.)
Public methodGetObjectValue
Gets the value of the form component. The GetValue method can be used directly to obtain the typed value.
(Overrides FormComponentGetObjectValue.)
Public methodGetValue
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 methodLoadProperties
Loads properties of the form component. The actual properties type must match the PropertiesType.
(Overrides FormComponentLoadProperties(FormComponentProperties).)
Public methodModifyMetadata
Modifies modelMetadata according to the current object.
(Inherited from FormComponent.)
Public methodSetObjectValue
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).)
Public methodSetValue
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 methodValidate
Determines whether the specified object is valid. Only invoked if validation by validation attributes passes for all fields.
(Inherited from FormComponent.)
Top
Extension Methods
  NameDescription
Public Extension MethodGetBizFormComponentContext
Gets BizFormComponentContext of a form component, if such a context was bound to the component.
(Defined by FormComponentExtensions.)
Top
Remarks
Properties which are expected to have automatically bound values after form submit, have to be annotated with BindablePropertyAttribute.
See Also
Inheritance Hierarchy
SystemObject
  Kentico.Forms.Web.MvcFormComponent
    Kentico.Forms.Web.MvcFormComponentTProperties, TValue
      Kentico.Components.Web.Mvc.FormComponentsAttachmentSelector
      Kentico.Components.Web.Mvc.FormComponents.InternalPageSelectorBaseTProperties, TValue
      Kentico.Components.Web.Mvc.FormComponentsMediaFilesSelector
      Kentico.Components.Web.Mvc.FormComponentsRichTextComponent
      Kentico.Components.Web.Mvc.FormComponentsUrlSelector
      Kentico.Components.Web.Mvc.Selectors.InternalObjectSelectorComponentBaseTProperties, TSelectorItem
      Kentico.Content.Web.MvcMultiSelectorFormComponentTProperties
      Kentico.Forms.Web.MvcCheckBoxComponent
      Kentico.Forms.Web.MvcCompareToFieldSelectorComponent
      Kentico.Forms.Web.MvcComparisonTypeSelectorComponentTComparisonEnum
      Kentico.Forms.Web.MvcConsentAgreementComponent
      Kentico.Forms.Web.MvcEmailInputComponent
      Kentico.Forms.Web.MvcFileUploaderComponent
      Kentico.Forms.Web.MvcHiddenGuidInputComponent
      Kentico.Forms.Web.MvcIntInputComponent
      Kentico.Forms.Web.MvcInvalidComponent
      Kentico.Forms.Web.MvcRecaptchaComponent
      Kentico.Forms.Web.MvcSelectorFormComponentTProperties
      Kentico.Forms.Web.MvcTextAreaComponent
      Kentico.Forms.Web.MvcTextInputComponent
      Kentico.Forms.Web.MvcUSPhoneComponent