Table of Contents

Interface IFormComponentPropertiesMapper

Namespace
Kentico.Forms.Web.Mvc
Assembly
Kentico.Content.Web.Mvc.dll

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

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

Methods

FromFieldInfo(FormFieldInfo)

Maps an instance of FormFieldInfo to corresponding FormComponentProperties. To extract identifier of corresponding FormComponentDefinition use GetComponentIdentifier(FormFieldInfo).

FormComponentProperties FromFieldInfo(FormFieldInfo formFieldInfo)

Parameters

formFieldInfo FormFieldInfo

Form field to be mapped.

Returns

FormComponentProperties

Returns an instance of FormComponentProperties which corresponds to given form field.

Exceptions

ArgumentNullException

Thrown when formFieldInfo is null.

GetComponentIdentifier(FormFieldInfo)

Gets FormComponentDefinition identifier stored in formFieldInfo.

string GetComponentIdentifier(FormFieldInfo formFieldInfo)

Parameters

formFieldInfo FormFieldInfo

Form field info for which to obtain FormComponentDefinition's identifier.

Returns

string

Return identifier obtained from formFieldInfo.

Exceptions

ArgumentNullException

Thrown when formFieldInfo is null.

ToFormFieldInfo(FormComponentProperties, string)

Maps an instance of FormComponentProperties to corresponding FormFieldInfo.

FormFieldInfo ToFormFieldInfo(FormComponentProperties formComponentProperties, string componentIdentifier)

Parameters

formComponentProperties FormComponentProperties

Form component properties to be mapped.

componentIdentifier string

Identifier of corresponding FormComponentDefinition to be stored along with formComponentProperties.

Returns

FormFieldInfo

Returns an instance of FormFieldInfo which corresponds to given properties and type identifier.

Exceptions

ArgumentNullException

Thrown when formComponentProperties is null.

See Also

FormComponentProperties
FormFieldInfo