Table of Contents

Namespace Kentico.Forms.Web.Mvc

Classes

AnotherBoolFieldVisibilityCondition

Form component visibility condition specifying dependency on another field of boolean type whose value is equal to the ExpectedValue.

AnotherFieldVisibilityCondition<TValue>

Inherit this class to implement visibility condition which needs value of another field in order to function.

AnotherIntFieldVisibilityCondition

Form component visibility condition specifying dependency on another field of integer type whose value satisfies condition based on ComparisonType and CompareToValue.

AnotherPropertyVisibilityCondition<TValue>

Visibility condition which indicates a dependency on another property where the property is specified by name.

AnotherStringFieldVisibilityCondition

Form component visibility condition specifying dependency on another field of string type whose value satisfies condition based on ComparisonType and CompareToValue.

BindablePropertyAttribute

Use this attribute to enable value binding for a form component property.

BizFormComponentContext

Context for form components being rendered as a representation of a biz form.

BoolComparisonTypeSelectorComponent

Selector component for boolean comparison.

BoolIsSetValidationRule

Rule used to validate that a boolean type component's value (e.g. checkbox) is true.

CheckBoxComponent

Represents a checkbox form component.

CheckBoxProperties

Represents properties of a CheckBoxComponent.

CompareToFieldSelectorComponent

Selector component for selecting a field to compare against in validation rules based on comparison to another field.

CompareToFieldSelectorProperties

Represents properties of a CompareToFieldSelectorComponent.

CompareToFieldValidationRule<TValue>

Inherit this class to implement validation rule which needs value of another field in order to function.

ComparisonTypeSelectorComponent<TComparisonEnum>

Selector component for enums specifying comparison type. The selected value is represented by its corresponding underlying type value.

ComparisonTypeSelectorProperties<TComparisonEnum>

Represents properties of a ComparisonTypeSelectorComponent<TComparisonEnum>.

ConfigurationsXmlSerializer<TConfiguration>

Base class for ValidationRuleConfigurationsXmlSerializer and VisibilityConditionConfigurationXmlSerializer.

ConsentAgreementComponent

Represents a consent agreement form component.

ConsentAgreementProperties

Represents properties of a ConsentAgreementComponent.

ConsentSelectorComponent

Provides drop-down list for selecting text of ConsentInfo.

ControllerExtensions

Class containing extension methods for Microsoft.AspNetCore.Mvc.Controller.

DecimalNumericCompareToFieldValidationRule

Rule is used to compare two fields of decimal value types.

DefaultValueEditingComponentAttribute

Attribute to be used with DefaultValue property overrides to specify the editing form component. Sets the system properties such as Label or Order to proper values.

DoubleNumericCompareToFieldValidationRule

Rule is used to compare two fields of double value types.

DropDownComponent

Represents component displaying drown down list.

DropDownProperties

Represents properties of a DropDownComponent.

EditableAreaConfiguration

Represents the editable area configuration within a FormBuilderConfiguration instance.

EditablePropertiesBindingContext

Class containing necessary data to perform model binding for editable properties form components.

EditingComponentAttribute

Denotes a property that can be edited using the specified form component. Use the optional properties of the attribute to configure the basic properties of the form component assigned or use EditingComponentPropertyAttribute to further configure the form component.

EditingComponentConfigurationAttribute

Allows to configure a form component instance, specified by the EditingComponentAttribute.

EditingComponentOrder

Contains constants describing order of editable properties within FormComponentProperties.

EditingComponentPropertyAttribute

Attribute specifying form component property's value. The attribute is to be used in conjunction with EditingComponentAttribute to further configure an assigned component.

ElementRenderingConfiguration

Configuration describing rendering of an optional wrapping HTML element around Form builder's element or custom HTML code.

EmailInputComponent

Represents an email input component.

EmailInputProperties

Represents properties of a EmailInputComponent.

EmailValidationRule

Rule used to validate email addresses.

ErrorPage

View model for rendering an error page.

FileUploadEndpointParameters

Defines parameters to Kentico.Forms.Web.Mvc.Internal.KenticoFormFileUploaderController.PostFile(int, string, string) endpoint for file upload from this form component.

FileUploaderComponent

Represents a file uploader form component. The component is designed for use in Forms application only.

FileUploaderProperties

Represents properties of a FileUploaderComponent.

FormBuilderBindingContext

Class represents information to perform form component values binding.

FormBuilderBundlesOptions

Contains configurations of bundles used by the Form builder feature.

FormBuilderConfiguration

Represents the configuration of a Form builder instance.

FormBuilderDefinitionProvider<TDefinition>

Retrieves list of registered object definitions for Form Builder.

FormBuilderFilters

Represents the form component filter collections.

FormBuilderModelManager

Model binder used for binding values when submitting forms built via Form builder.

FormBuilderOptions

Options for Kentico Form Builder feature.

FormBuilderPage

View model for rendering Form builder page.

FormBuilderProperties

View model for displaying Form builder properties panel.

FormBuilderRoutes

Provides Form builder route templates and their names.

FormComponent

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.

FormComponentConfiguration

Represents the configuration of a form component within a ZoneConfiguration instance.

FormComponentConfigurator<TFormComponent>

Represents a FormComponent configurator which is used to configure a form component instance defined by EditingComponentAttribute.

FormComponentContext

Represents a base class for form components contexts.

FormComponentDefinition

Definition of a registered form component.

FormComponentDefinitionEnumerableExtensions

Class provides extension methods for enumerables of form component definitions.

FormComponentDefinitionProvider

Retrieves list of registered component definitions for Form builder.

FormComponentExtensions

Extension methods for FormComponent class.

FormComponentMetadata

Metadata describing a form component for the client.

FormComponentProperties

Defines properties which are common to all form components. Do not inherit this class directly, inherit the FormComponentProperties<TValue> class instead.

FormComponentPropertiesMapper

Contains mapping methods for conversions between form component properties and form field definition.

FormComponentProperties<TValue>

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

FormComponentVisibilityEvaluator

Evaluator of form component visibility conditions.

FormComponent<TProperties, TValue>

Represents a base class for a form component. Inherit this class to define a custom form component.

FormComponentsMetadata

Metadata describing Form builder components for the client.

FormExtensions

Contains helper methods for rendering HTML for forms built using Form builder.

FormFeaturedFieldDefinition

Represents definition of featured field.

FormFeaturedFieldMetadata

Metadata describing a form featured field for the client.

FormFieldRenderingConfiguration

Configuration describing rendering of optional wrapping HTML elements for Form builder's form field.

FormItemEdit

View model for rendering Form item edit view.

FormProvider

Contains methods for forms and their fields retrieval.

FormSectionViewModel<TPropertiesType>

View model for a section with properties.

FormSerializerSettings

Represents serializer settings used to de/serialize FormBuilder objects.

GetFormFieldRenderingConfigurationEventArgs

Arguments of event represented by GetFormFieldRenderingConfigurationHandler.

GetFormFieldRenderingConfigurationHandler

Handler for event raised when FormFieldRenderingConfiguration is being retrieved.

HiddenGuidInputComponent

Represents a hidden input form component.

HiddenGuidInputProperties

Represents properties of a HiddenGuidInputProperties.

HtmlHelperExtensions

Provides system extension methods for HtmlHelperExtensionPoint.

IEnumerableExtensions

Extensions methods for System.Collections.Generic.IEnumerable<T> interface.

IntInputComponent

Represents a numeric input form component.

IntInputProperties

Represents properties of a IntInputComponent.

IntNumericCompareToFieldValidationRule

Rule is used to compare two fields of integer value types.

InvalidComponent

Represents an invalid form component.

InvalidComponentProperties

Represents properties of an InvalidComponent.

MaximumIntValueValidationRule

Rule validates that user input value is not greater than specified value. Variant for int value types.

MaximumLengthValidationRule

Rule validates that user input value is not longer than specified value.

MessageExtensions

Contains helper methods for rendering HTML for alert messages.

MinimumIntValueValidationRule

Rule validates that user input value is not lower than specified value. Variant for int value types.

MinimumLengthValidationRule

Rule validates that user input value is not shorther than specified value.

NameComponent

Represents component for name property.

NeverVisibleVisibilityCondition

Form component visibility condition which hides the form component.

NumericCompareToFieldValidationRule<TValue>

Shared validation rule implementation used to compare two fields of numeric value types.

NumericComparisonTypeSelectorComponent

Selector component for numeric comparison.

PropertiesPanel

View model for rendering a properties panel of a FormComponent.

PropertiesPanelComponentContext

Context for form components being rendered in the properties panel of the Form builder application.

RadioButtonsComponent

Represents component displaying radio buttons selector.

RadioButtonsProperties

Represents properties of a RadioButtonsComponent.

RecaptchaComponent

Represents a reCAPTCHA form component.

RecaptchaProperties

Represents properties of a RecaptchaComponent.

RegisterComponentAttribute

Basic implementation allowing to register definition of Form builder feature component.

RegisterFormComponentAttribute

Registers a form component to Form builder.

RegisterFormSectionAttribute

Registers a section to Form builder.

RegisterFormValidationRuleAttribute

Registers a form component validation rule to Form builder.

RegisterFormVisibilityConditionAttribute

Registers a form component visibility condition to Form builder.

RegularExpressionValidationRule

Represents regular expression validation rule.

SaveBizFormItemEventArgs

Arguments of event represented by SaveBizFormItemHandler.

SaveBizFormItemHandler

Handler for event raised in BizFormComponentContext when a biz form item is being saved.

SectionConfiguration

Represents the section configuration within an EditableAreaConfiguration instance.

SectionDefinition

Definition of registered section for Form builder.

SectionDefinitionProvider

Retrieves list of registered section definitions for Form Builder.

SectionMetadata

Metadata of a section definition.

SelectorFormComponent<TProperties>

Provides basic component support for selectors.

SelectorProperties

Provides basic component support for selectors.

StringCompareToFieldValidationRule

Rule is used to compare two fields of string value types.

StringComparisonTypeSelectorComponent

Selector component for string comparison.

SubmitButtonConfiguration

Represents configuration of a submit button.

TextAreaComponent

Represents a text area form component.

TextAreaProperties

Represents properties of a TextAreaComponent.

TextInputComponent

Represents a single line input form component.

TextInputProperties

Represents properties of a TextInputComponent.

USPhoneComponent

Represents an US phone number input component.

USPhoneProperties

Represents properties of a USPhoneComponent.

UpdatableFormModelBinder

Model binder used for binding contextual data required when updating form's markup e.g. applying visibility conditions.

UpdatableFormModelBinderAttribute

Annotate a parameter of a controller action with this attribute to use UpdatableFormModelBinder for its value binding.

UpdatableMvcForm

Represents updatable MVC form.

ValidationRule

Represents a base class for a form component validation rule. Do not inherit this class directly, inherit the ValidationRule<TValue> class instead.

ValidationRuleActivator

Contains methods for creating ValidationRules.

ValidationRuleConfiguration

Encapsulates ValidationRule with its ValidationRuleDefinition identifier.

ValidationRuleConfigurationsXmlSerializer

XML serializer for collection of ValidationRuleConfigurations.

ValidationRuleDefinition

Definition of a registered form component validation rule.

ValidationRuleDefinitionProvider

Retrieves list of registered component validation rule definitions for Form builder.

ValidationRuleEditingComponentOrder

Contains constants describing order of editable properties within ValidationRule.

ValidationRuleForm

View model for rendering a ValidationRule configuration.

ValidationRuleMetadata

Metadata describing a validation rule for the client.

ValidationRule<TValue>

Represents a base class for a form component validation rule. Inherit this class to create custom validation rules.

ViewDataDictionaryExtensions

Contains helper methods for adding and getting Form builder related configuration data to and from Microsoft.AspNetCore.Mvc.ViewFeatures.ViewDataDictionary.

VisibilityCondition

Represents a base class for a form component visibility condition.

VisibilityConditionActivator

Contains methods for creating VisibilityConditions.

VisibilityConditionAttribute

Denotes that visibility of the decorated property in a form depends either on a value of another property or on a custom visibility condition. The other property value is utilized during evaluation of the given visibility condition to indicate whether the decorated property's form component should be visible in a form. Either predefined visibility condition via ComparisonTypeEnum or a custom visibility condition can be used. When utilizing the dependee property value, the custom visibility condition type must inherit from AnotherPropertyVisibilityCondition<TValue> to ensure correct functionality, otherwise VisibilityCondition can be used.

VisibilityConditionConfiguration

Encapsulates VisibilityCondition with its VisibilityConditionDefinition identifier.

VisibilityConditionConfigurationJsonConverter

Encapsulates Newtonsoft.Json.JsonConverter for visibility condition configuration.

VisibilityConditionConfigurationXmlSerializer

XML serializer for VisibilityConditionConfiguration.

VisibilityConditionDefinition

Definition of a registered form component visibility condition.

VisibilityConditionDefinitionProvider

Retrieves list of registered component visibility condition definitions for Form builder.

VisibilityConditionEditingComponentOrder

Contains constants describing order of editable properties within VisibilityCondition.

VisibilityConditionForm

View model for rendering a VisibilityCondition configuration.

VisibilityConditionPropertyAttribute

The attribute defines the visibility condition's property and its value.

ZoneConfiguration

Represents the zone configuration within a SectionConfiguration instance.

Interfaces

IBindablePropertiesCache

Implement this interface to create a cache of properties marked with BindablePropertyAttribute per a given type.

IEditablePropertiesCollector

Defines methods for collecting properties editable via FormComponent<TProperties, TValue>s from a model.

IEditingComponentConfigurator

Encapsulates logic for configuring FormComponentProperties of a FormComponent<TProperties, TValue> using attributes.

IFileUploaderLimitService

Contains properties for retrieving limits for FileUploaderComponent.

IFormBuilderDefinition

Definition of a component with markup for Form builder.

IFormBuilderDefinitionProvider<TDefinition>

Provider for retrieval of registered object definitions for Form Builder.

IFormBuilderModelManager

Defines a contract to perform model binding for form components.

IFormComponentActivator

Defines methods for creating form components and their properties.

IFormComponentBinder

Defines contract for binding form components.

IFormComponentConfigurator

Represents a FormComponent configurator.

IFormComponentDefinitionProvider

Provider for retrieval of registered component definitions for Form Builder.

IFormComponentPropertiesMapper

Contains mapping methods for conversions between form component properties and form field definition.

IFormComponentValidator

Implement this interface to perform form builder model validation.

IFormComponentVisibilityEvaluator

Defines interface for evaluator of form component visibility conditions.

IFormFeaturedFieldDefinitionProvider

Provider for retrieval of existing featured field definitions for Form Builder.

IFormFieldValueProvider

Provides values of form fields.

IFormProvider

Contains methods for forms and their fields retrieval.

IFormSectionProperties

Interface of form builder section properties configuration.

IFormSectionPropertiesReader

Service for reading form section properties from request.

ISectionDefinitionProvider

Provider for retrieval of registered section definitions for Form Builder.

IValidationRuleActivator

Defines methods for creating ValidationRules.

IValidationRuleConfigurationsXmlSerializer

XML serializer for collection of ValidationRuleConfigurations.

IValidationRuleDefinitionProvider

Provider for retrieval of registered form component validation rule definitions for Form builder.

IVisibilityConditionActivator

Defines methods for creating VisibilityConditions.

IVisibilityConditionConfigurationXmlSerializer

XML serializer for VisibilityConditionConfiguration.

IVisibilityConditionDefinitionProvider

Provider for retrieval of registered form component visibility condition definitions for Form builder.

Enums

BoolFieldValueTypes

Represents possible boolean values.

ComparisonTypeEnum

Contains the predefined comparison types which are supposed to be utilized for specifying visibility condition of a form component via the VisibilityConditionAttribute.

NumericFieldComparisonTypes

Possible numeric comparison types used in form field validation.

StringFieldComparisonTypes

Possible string comparison types used in form field validation.