BizFormHelper Class

Provides helper methods for biz forms.

Inheritance Hierarchy

System.Object
  CMS.Base.CoreMethods
    CMS.Base.AbstractHelper
      CMS.Base.AbstractHelper<BizFormHelper>
        CMS.OnlineForms.BizFormHelper

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

Syntax

public class BizFormHelper : AbstractHelper<BizFormHelper>

The BizFormHelper type exposes the following members.

Constructors

	Name	Description
Public method	BizFormHelper

Methods

	Name	Description
Public method Static member	Create	Creates a new biz form by creating the underlying database table and setting the corresponding BizFormInfo and DataClassInfo. The database table name is prefixed using GetFormTablePrefix(String) and processed by GetFullTableName(TableManager, String, String) which truncates excessive table names. 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). The form name is used as table name if tableName is not specified or its value equals to CODENAME_AUTOMATIC.
Protected method	CreateBizFormInfo	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.
Protected method	CreateInternal	Creates a new biz form by creating the underlying database table and setting the corresponding BizFormInfo and DataClassInfo. The database table name is prefixed using GetFormTablePrefix(String) and processed by GetFullTableName(TableManager, String, String) which truncates excessive table names. 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). The form name is used as table name if tableName is not specified or its value equals to CODENAME_AUTOMATIC.
Public method Static member	GetFormTablePrefix	Gets prefix for biz form table name. The prefix is a string in format Form_[siteName]_. The site name is sanitized via GetIdentifier(Object).
Protected method	GetFormTablePrefixInternal	Gets prefix for biz form table name. The prefix is a string in format Form_[siteName]_. The site name is sanitized via GetIdentifier(Object).
Public method Static member	GetFullTableName	Gets table name including prefix for biz form table. Both tableNamePrefix and tableName must be sanitized strings suitable for a table name. If the resulting table name is longer than 60 characters, it is truncated and appended an ordinal number to ensure uniqueness.
Protected method	GetFullTableNameInternal	Gets table name including prefix for biz form table. Both tableNamePrefix and tableName must be sanitized strings suitable for a table name. If the resulting table name is longer than 60 characters, it is truncated and appended an ordinal number to ensure uniqueness.
Public method	SetAsDefaultHelper	Sets this object as the default helper (Inherited from AbstractHelper<HelperType>.)