Click or drag to resize
FormComponentPropertiesTValue Class
Defines properties which are common to all form components. Inherit this class to create properties of custom form components.
Inheritance Hierarchy
SystemObject
  Kentico.Forms.Web.MvcFormComponentProperties
    Kentico.Forms.Web.MvcFormComponentPropertiesTValue
      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 FormComponentProperties<TValue> : FormComponentProperties

Type Parameters

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

The FormComponentPropertiesTValue type exposes the following members.

Constructors
  NameDescription
Protected methodFormComponentPropertiesTValue
Initializes a new instance of the FormComponentPropertiesTValue class using the data type, size and precision given. Specifying the size and precision is optional and depends on whether the dataType requires them.
Top
Properties
  NameDescription
Public propertyDataType
Gets or sets the underlying field data type.
(Inherited from FormComponentProperties.)
Public propertyDefaultValue
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 propertyExplanationText
Gets or sets the explanation text of the form component.
(Inherited from FormComponentProperties.)
Public propertyGuid
Gets or sets the underlying field GUID.
(Inherited from FormComponentProperties.)
Public propertyLabel
Gets or sets the label of the form component.
(Inherited from FormComponentProperties.)
Public propertyName
Gets or sets the underlying field name.
(Inherited from FormComponentProperties.)
Public propertyPlaceholder
Gets or sets the value displayed as placeholder in the input. Override and annotate with EditingComponentAttribute to make this property editable in properties panel.
(Inherited from FormComponentProperties.)
Public propertyPrecision
Gets or sets the underlying field precision.
(Inherited from FormComponentProperties.)
Public propertyRequired
Gets or sets value indicating whether the underlying field is required. False by default. If false, the form component's implementation must accept nullable input.
(Inherited from FormComponentProperties.)
Public propertySize
Gets or sets the underlying field size.
(Inherited from FormComponentProperties.)
Public propertySmartField
Gets or sets value indicating whether the underlying field is smart field. False by default.
(Inherited from FormComponentProperties.)
Public propertyTooltip
Gets or sets the tooltip of the form component.
(Inherited from FormComponentProperties.)
Public propertyValidationRuleConfigurations
Gets or sets validation rule configurations assigned to the form component.
(Inherited from FormComponentProperties.)
Public propertyVisibilityConditionConfiguration
Gets or sets visibility condition configuration assigned to the form component.
(Inherited from FormComponentProperties.)
Top
Methods
  NameDescription
Public methodGetDefaultValue
Gets the default value. The DefaultValue property can be used directly to obtain the typed default value.
(Overrides FormComponentPropertiesGetDefaultValue.)
Public methodSetDefaultValue
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.
(Overrides FormComponentPropertiesSetDefaultValue(Object).)
Top
See Also
Inheritance Hierarchy
SystemObject
  Kentico.Forms.Web.MvcFormComponentProperties
    Kentico.Forms.Web.MvcFormComponentPropertiesTValue
      Kentico.Components.Web.Mvc.FormComponentsAttachmentSelectorProperties
      Kentico.Components.Web.Mvc.FormComponents.InternalPageSelectorPropertiesBaseTValue
      Kentico.Components.Web.Mvc.FormComponentsMediaFilesSelectorProperties
      Kentico.Components.Web.Mvc.FormComponentsRichTextComponentProperties
      Kentico.Components.Web.Mvc.FormComponentsUrlSelectorProperties
      Kentico.Components.Web.Mvc.SelectorsObjectSelectorPropertiesBaseTItem
      Kentico.Content.Web.MvcMultiSelectorProperties
      Kentico.Forms.Web.MvcCheckBoxProperties
      Kentico.Forms.Web.MvcCompareToFieldSelectorProperties
      Kentico.Forms.Web.MvcComparisonTypeSelectorPropertiesTComparisonEnum
      Kentico.Forms.Web.MvcConsentAgreementProperties
      Kentico.Forms.Web.MvcEmailInputProperties
      Kentico.Forms.Web.MvcFileUploaderProperties
      Kentico.Forms.Web.MvcHiddenGuidInputProperties
      Kentico.Forms.Web.MvcIntInputProperties
      Kentico.Forms.Web.MvcInvalidComponentProperties
      Kentico.Forms.Web.MvcRecaptchaProperties
      Kentico.Forms.Web.MvcSelectorProperties
      Kentico.Forms.Web.MvcTextAreaProperties
      Kentico.Forms.Web.MvcTextInputProperties
      Kentico.Forms.Web.MvcUSPhoneProperties