Class FormProvider

Namespace

Kentico.Forms.Web.Mvc

Assembly

Kentico.Content.Web.Mvc.dll

Contains methods for forms and their fields retrieval.

public class FormProvider : IFormProvider

Inheritance

object

FormProvider

Implements

IFormProvider

Extension Methods

DataExtensions.With<T>(T, Action<T>)

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

FormProvider(IFormComponentDefinitionProvider, IFormComponentActivator, IFormComponentPropertiesMapper)

Initializes a new instance of the FormProvider class.

public FormProvider(IFormComponentDefinitionProvider formComponentDefinitionProvider, IFormComponentActivator formComponentActivator, IFormComponentPropertiesMapper formComponentPropertiesMapper)

Parameters

formComponentDefinitionProvider IFormComponentDefinitionProvider

Provider for registered form components retrieval.

formComponentActivator IFormComponentActivator

Activator for form components.

formComponentPropertiesMapper IFormComponentPropertiesMapper

Mapper for form component properties.

Methods

CreateFormComponent(FormFieldInfo, BizFormComponentContext)

Creates a new form component instance based on its description in the form field.

protected virtual FormComponent CreateFormComponent(FormFieldInfo formFieldInfo, BizFormComponentContext context)

Parameters

formFieldInfo FormFieldInfo

Form field describing the form component to create.

context BizFormComponentContext

Contextual information specifying where the form component is being used.

Returns

FormComponent

Returns an instance of the form component as described in the form field.

Remarks

A component instance is created using the Kentico.Forms.Web.Mvc.FormComponentActivator and IFormComponentPropertiesMapper passed when initializing this provider. A proper Name is filled in the created component and SetObjectValue(object) method is called to set default value.

GetFormComponents(BizFormInfo, BizFormComponentContext)

Gets a list of form components which represent the model to be rendered in a view.

public virtual List<FormComponent> GetFormComponents(BizFormInfo bizFormInfo, BizFormComponentContext bizFormComponentContext = null)

Parameters

bizFormInfo BizFormInfo

Biz form for which to return a list of corresponding form components.

bizFormComponentContext BizFormComponentContext

Biz form component context, which is set in created components. If FormInfo is null, it is set to bizFormInfo.

Returns

List<FormComponent>

Returns a list of form components.

Exceptions

ArgumentNullException

Thrown when bizFormInfo is null.

GetFormInfo(BizFormInfo)

Gets FormInfo for the specified bizFormInfo.

protected virtual FormInfo GetFormInfo(BizFormInfo bizFormInfo)

Parameters

bizFormInfo BizFormInfo

Form to return FormInfo for.

Returns

FormInfo

Returns an instance of FormInfo which corresponds to form given.

Remarks

Returned instance of FormInfo should not be modified as it is cached within FormHelper.

Exceptions

ArgumentNullException

Thrown when bizFormInfo is null.

SetBizFormItemData(BizFormItem, List<FormComponent>)

Sets data from visibleFormComponents to given formItem.

protected virtual void SetBizFormItemData(BizFormItem formItem, List<FormComponent> visibleFormComponents)

Parameters

formItem BizFormItem

Form item to which data is set.

visibleFormComponents List<FormComponent>

Collection of visible form components from which to set data inside formItem.

SetContact(FormInfo, BizFormItem, Guid)

Sets the current contact identifier to given item.

protected void SetContact(FormInfo formInfo, BizFormItem item, Guid contactGuid)

Parameters

formInfo FormInfo

item BizFormItem

contactGuid Guid

SetFormData(BizFormInfo, List<FormComponent>, Guid?)

Sets data of a form represented by a list of its components.

public virtual BizFormItem SetFormData(BizFormInfo bizFormInfo, List<FormComponent> formComponents, Guid? contactGuid)

Parameters

bizFormInfo BizFormInfo

Biz form whose data are to be set.

formComponents List<FormComponent>

Form components containing values to be set.

contactGuid Guid?

Guid of current contact, can be null.

Returns

BizFormItem

Returns the biz form item set.

Remarks

The SaveBizFormItem event is invoked on all form components which have been initialized using an instance of BizFormComponentContext.

Exceptions

ArgumentNullException

Thrown when bizFormInfo or formComponents is null.

UpdateFormData(BizFormInfo, int, List<FormComponent>, Guid?)

Updates form data of already existing BizFormItem.

public virtual BizFormItem UpdateFormData(BizFormInfo bizFormInfo, int bizFormItemId, List<FormComponent> formComponents, Guid? contactGuid)

Parameters

bizFormInfo BizFormInfo

Form to be updated.

bizFormItemId int

Identifier of form record to be updated.

formComponents List<FormComponent>

Form components containing values to be set.

contactGuid Guid?

Guid of current contact, can be null.

Returns

BizFormItem

Returns the updated biz form item.

Remarks

The SaveBizFormItem event is invoked on all form components which have been initialized using an instance of BizFormComponentContext.

Exceptions

ArgumentNullException

Thrown when bizFormInfo or formComponents is null.

ArgumentOutOfRangeException

Thrown when bizFormItemId does not specify an existing BizFormItem.