Interface IFormProvider

Namespace

Kentico.Forms.Web.Mvc

Assembly

Kentico.Content.Web.Mvc.dll

Contains methods for forms and their fields retrieval.

[Obsolete("This interface was not intented for a public use and will be removed in the next version.")]
public interface IFormProvider

Extension Methods

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

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Methods

GetFormComponents(BizFormInfo, BizFormComponentContext)

Gets a list of form components as configured in bizFormInfo.

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 propagated into 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.

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

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

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.

Exceptions

ArgumentNullException

Thrown when bizFormInfo or formComponents is null.

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

Updates form data of already existing BizFormItem.

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.

Exceptions

ArgumentNullException

Thrown when bizFormInfo or formComponents is null.

ArgumentOutOfRangeException

Thrown when bizFormItemId does not specify an existing BizFormItem.