Table of Contents

Class BizFormItem

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)]
public class BizFormItem : AbstractInfoBase<BizFormItem>, IExtensible, IInfo, IAdvancedDataContainer, ICMSObject, IHierarchicalDataContainer, IDataContainer, ISimpleDataContainer, IVirtualHierarchicalObject, IHierarchicalObject, INameIndexable, IMacroObject
Inheritance
object
BizFormItem
Implements
Inherited Members
Extension Methods

Constructors

BizFormItem()

Constructor

[Obsolete("This constructor is meant for system purposes, it shouldn't be used directly.")]
public BizFormItem()

BizFormItem(string, DataRow)

Base constructor for inherited classes and internal purposes

public BizFormItem(string className, DataRow dr = null)

Parameters

className string

Class name of the document

dr DataRow

Data row with the data

Properties

BizFormClassName

Gets class name of BizForm item.

public virtual string BizFormClassName { get; }

Property Value

string

BizFormInfo

BizForm which this item belongs to.

public BizFormInfo BizFormInfo { get; }

Property Value

BizFormInfo

DataClassInfo

DataClass info

protected DataClassInfo DataClassInfo { get; }

Property Value

DataClassInfo

FormInserted

Gets or sets BizForm item insertion date.

public DateTime FormInserted { get; set; }

Property Value

DateTime

FormUpdated

Gets or sets date of modification of BizForm item.

public DateTime FormUpdated { get; set; }

Property Value

DateTime

ItemID

Gets or sets BizForm item ID.

public int ItemID { get; set; }

Property Value

int

ObjectDisplayName

Object display name.

protected override string ObjectDisplayName { get; set; }

Property Value

string

ObjectParent

Gets or sets BizForm which this item belongs to.

protected override BaseInfo ObjectParent { get; set; }

Property Value

BaseInfo

Methods

Clone()

Creates a clone of BizForm item

public override BizFormItem Clone()

Returns

BizFormItem

DeleteData()

Deletes the object from the database while invoking the Delete event.

protected override void DeleteData()

DeleteDataAsync(CancellationToken)

Asynchronously deletes the object from the database while invoking the Delete event.

protected override Task DeleteDataAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

The cancellation instruction.

Returns

Task

DeleteObject()

Deletes the object using appropriate provider.

protected override void DeleteObject()

GetValue(string)

Gets BizForm item value.

public override object GetValue(string columnName)

Parameters

columnName string

Returns

object

Initialize(string, IDataContainer)

Initializes the object created with default constructor. Use it to load existing item from data row.

protected void Initialize(string className, IDataContainer data)

Parameters

className string

Class name

data IDataContainer

Data container containing all page data

Initialize(string, DataRow)

Initializes the object created with default constructor. Use it to load existing item from data row.

protected void Initialize(string className, DataRow dr)

Parameters

className string

Class name

dr DataRow

Data row containing all page data

InsertData()

Inserts the object to the database while invoking the Insert event.

protected override void InsertData()

InsertDataAsync(CancellationToken)

Asynchronously inserts the object to the database while invoking the Insert event.

protected override Task InsertDataAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

The cancellation instruction.

Returns

Task

New(string, DataRow)

Creates new BizFormItem instance which must inherit the BizFormItem class.

public static BizFormItem New(string className, DataRow dataRow = null)

Parameters

className string

Class name in format application.class

dataRow DataRow

Data row containing both tree node and coupled table

Returns

BizFormItem

NewObject(LoadDataSettings)

Creates a new object from the given DataRow

protected override BaseInfo NewObject(LoadDataSettings settings)

Parameters

settings LoadDataSettings

Data settings

Returns

BaseInfo

New<ItemType>(string, IDataContainer)

Creates new document instance.

public static ItemType New<ItemType>(string className, IDataContainer data) where ItemType : BizFormItem, new()

Parameters

className string

Class name in format application.class

data IDataContainer

Data container containing both tree node and coupled table

Returns

ItemType

Type Parameters

ItemType

New<ItemType>(string, DataRow)

Creates new document instance.

public static ItemType New<ItemType>(string className, DataRow dataRow) where ItemType : BizFormItem, new()

Parameters

className string

Class name in format application.class

dataRow DataRow

Data row containing both tree node and coupled table

Returns

ItemType

Type Parameters

ItemType

SetObject()

Updates the object using appropriate provider.

protected override void SetObject()

SetValue(string, object)

Sets value of column.

public override bool SetValue(string columnName, object value)

Parameters

columnName string

Column name

value object

Column value

Returns

bool

TryGetValue(string, out object)

Returns value of column.

public override bool TryGetValue(string columnName, out object value)

Parameters

columnName string

Column name

value object

Returns the value

Returns

bool

Returns true if the operation was successful (the value was present)

UpdateData()

Updates the object in the database while invoking the Update event.

protected override void UpdateData()

UpdateDataAsync(CancellationToken)

Asynchronously updates the object in the database while invoking the Update event.

protected override Task UpdateDataAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

The cancellation instruction.

Returns

Task