BizFormHelper.CreateBizFormInfo Method

Creates a new BizFormInfo and initializes it using given display name, name and site ID. Does not set the info to the database. The method is used by CreateInternal(String, String, String, SiteInfo) to supply the BizFormInfo instance.

If formName is not specified or its value equals CODENAME_AUTOMATIC, a new code name is created based on display name.

The form name is sanitized via GetIdentifier(Object) and can be safely used as part of the resulting table name.

Namespace: CMS.OnlineForms
Assembly: CMS.OnlineForms (in CMS.OnlineForms.dll) Version: 12.0.0

Syntax

protected virtual BizFormInfo CreateBizFormInfo(
	string formDisplayName,
	string formName,
	SiteInfo siteInfo
)

Parameters

formDisplayName

Type: System.String
Display name of the form.

formName

Type: System.String
Name of the form, or null.

siteInfo

Type: CMS.SiteProvider.SiteInfo
Site of the form.

Return Value

Type: BizFormInfo
Returns a new BizFormInfo instance initialized with given values.

Exceptions

Exception	Condition
ArgumentNullException	Thrown when formDisplayName is null.
ArgumentException	Thrown when formDisplayName is an empty string.

Remarks

The resulting BizFormInfo has FormEmailAttachUploadedDocs and FormLogActivity enabled by default.