Click or drag to resize
BizFormHelper Methods

The BizFormHelper type exposes the following members.

Methods
  NameDescription
Public methodStatic memberCreate

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, String). The form name is used as table name if tableName is not specified or its value equals to CODENAME_AUTOMATIC.

Protected methodCreateBizFormInfo

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, String) and can be safely used as part of the resulting table name.

Protected methodCreateInternal

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, String). The form name is used as table name if tableName is not specified or its value equals to CODENAME_AUTOMATIC.

Public methodStatic memberGetFormTablePrefix
Gets prefix for biz form table name. The prefix is a string in format Form_[siteName]_. The site name is sanitized via GetIdentifier(Object, String).
Protected methodGetFormTablePrefixInternal
Gets prefix for biz form table name. The prefix is a string in format Form_[siteName]_. The site name is sanitized via GetIdentifier(Object, String).
Public methodStatic memberGetFullTableName

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 methodGetFullTableNameInternal

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 methodSetAsDefaultHelper
Sets this object as the default helper
(Inherited from AbstractHelperHelperType.)
Top
See Also