Table of Contents

Class BizFormInfo

Namespace
CMS.OnlineForms
Assembly
CMS.OnlineForms.dll

BizFormInfo stores information about form builder components configuration and other settings available in general side panel. FormClassInfo stores the form definition of the form. BizFormItem stores the data that visitors fill on the website.

[InfoCache(InfoCacheBy.ID|InfoCacheBy.Name, LoadEagerly = true, Priority = InfoCachePriority.NotRemovable)]
public class BizFormInfo : AbstractInfo<BizFormInfo, IBizFormInfoProvider>, IExtensible, IInfo, IAdvancedDataContainer, ICMSObject, IHierarchicalDataContainer, IDataContainer, ISimpleDataContainer, IVirtualHierarchicalObject, IHierarchicalObject, INameIndexable, IMacroObject, IInfoWithId, IInfoWithGuid, IInfoWithName
Inheritance
object
BizFormInfo
Implements
Inherited Members
Extension Methods

Constructors

BizFormInfo()

Constructor - Creates an empty BizFormInfo object.

public BizFormInfo()

BizFormInfo(DataRow)

Constructor - Creates a new BizFormInfo object from the given DataRow.

public BizFormInfo(DataRow dr)

Parameters

dr DataRow

Fields

BIZFORM_PREFIX

Prefix for data object type.

public const string BIZFORM_PREFIX = "bizform."

Field Value

string

OBJECT_TYPE

Object type

public const string OBJECT_TYPE = "cms.form"

Field Value

string

TYPEINFO

Type information.

public static ObjectTypeInfo TYPEINFO

Field Value

ObjectTypeInfo

Properties

AuthorizedRoles

Hashtable of roles the form is allowed for. RoleId is key and RoleName is value.

public SafeDictionary<int, string> AuthorizedRoles { get; }

Property Value

SafeDictionary<int, string>

Form

Form definition.

public virtual FormInfo Form { get; }

Property Value

FormInfo

FormAccess

Form access.

[DatabaseField]
public virtual FormAccessEnum FormAccess { get; set; }

Property Value

FormAccessEnum

FormBuilderLayout

MVC form builder layout serialized in JSON.

[DatabaseField]
public virtual string FormBuilderLayout { get; set; }

Property Value

string

FormClassID

Class id.

[DatabaseField]
public virtual int FormClassID { get; set; }

Property Value

int

FormDisplayName

Form display name.

[DatabaseField]
public virtual string FormDisplayName { get; set; }

Property Value

string

FormGUID

Form GUID.

[DatabaseField]
public virtual Guid FormGUID { get; set; }

Property Value

Guid

FormID

Form id.

[DatabaseField]
public virtual int FormID { get; set; }

Property Value

int

FormItems

Gets or sets items count.

[DatabaseField]
public virtual int FormItems { get; set; }

Property Value

int

FormLastModified

Object last modified.

[DatabaseField]
public virtual DateTime FormLastModified { get; set; }

Property Value

DateTime

FormLogActivity

Indicates if bizform activity is logged.

[DatabaseField]
public virtual bool FormLogActivity { get; set; }

Property Value

bool

FormName

Form code name.

[DatabaseField]
public virtual string FormName { get; set; }

Property Value

string

FormReportFields

Report fields.

[DatabaseField]
public virtual string FormReportFields { get; set; }

Property Value

string

FormSubmitButtonImage

Submit image button.

[DatabaseField]
public virtual string FormSubmitButtonImage { get; set; }

Property Value

string

FormSubmitButtonText

Submit button text.

[DatabaseField]
public virtual string FormSubmitButtonText { get; set; }

Property Value

string

Methods

ClearAuthorizedRoles()

Sets Hashtable with authorized roles to NULL -> enforce hashtable reload next time the data are needed.

public void ClearAuthorizedRoles()

DeleteObject()

Deletes the object using appropriate provider.

protected override void DeleteObject()

GetAutomaticCodeName()

Gets the automatic code name for the object

protected override string GetAutomaticCodeName()

Returns

string

InsertAsCloneInternal(CloneSettings, CloneResult, BaseInfo)

Inserts cloned object to DB.

protected override void InsertAsCloneInternal(CloneSettings settings, CloneResult result, BaseInfo originalObject)

Parameters

settings CloneSettings

Cloning settings

result CloneResult

Cloning result

originalObject BaseInfo

Original source BaseInfo (object being cloned)

IsFormAllowedForRole(int)

Indicates whether form is allowed for specified role.

public bool IsFormAllowedForRole(int roleId)

Parameters

roleId int

Role id

Returns

bool

IsFormAllowedForUser(UserInfo)

Indicates whether specified user is authorized for specified form.

public bool IsFormAllowedForUser(UserInfo user)

Parameters

user UserInfo

User info

Returns

bool

IsFormAllowedForUser(string)

Indicates whether specified user is authorized for specified form.

public bool IsFormAllowedForUser(string userName)

Parameters

userName string

User name

Returns

bool

RegisterProperties()

Registers the properties of this object

protected override sealed void RegisterProperties()

RemoveObjectDependencies(bool, bool)

Removes object dependencies. First tries to execute removedependencies query, if not found, automatic process is executed.

protected override void RemoveObjectDependencies(bool deleteAll = false, bool clearHashtables = true)

Parameters

deleteAll bool

If false, only required dependencies are deleted, dependencies with default value are replaced with default value and nullable values are replaced with null

clearHashtables bool

If true, hashtables of all objecttypes which were potentionally modified are cleared

SetObject()

Updates the object using appropriate provider.

protected override void SetObject()