Class FormTableInfo

Table 'form': A form which can be published on a webpage and submitted by visitors

Inheritance

System.Object

TableInfo

FormTableInfo

Implements

System.ICloneable

Inherited Members

TableInfo.ToString()

TableInfo.RegisterFields(FieldInfo[])

TableInfo.FieldInfoFromSoField(SoField)

TableInfo.Clone()

TableInfo.IsSameTable(TableInfo)

TableInfo.FindField(String)

TableInfo.ProtAll

TableInfo.HashCheckFields

TableInfo.TableName

TableInfo.DbName

TableInfo.IsDictionaryTable

TableInfo.All

TableInfo.Item[String]

TableInfo.PrimaryKeyField

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: SuperOffice.CRM.Data

Assembly: SoDataBase.dll

Syntax

[DatabaseTable("form")]
public class FormTableInfo : TableInfo, ICloneable

Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling .

Fields

DictionaryTableName

Conceptual name of table Form in the database dictionary: form

Declaration

public const string DictionaryTableName = "form"

Field Value

Type	Description
System.String

Properties

Active

Field 'active' in table 'form': Dictionary type Bool, .NET type: System.Int16

Indicates if this form is active and available for customers

Declaration

public UInt16FieldInfo Active { get; }

Property Value

Type	Description
UInt16FieldInfo

Config

Field 'config' in table 'form': Dictionary type Clob, .NET type: System.String

The JSON-formatted config of this form

Declaration

public StringFieldInfo Config { get; }

Property Value

Type	Description
StringFieldInfo

Definition

Definition of the table as described in the deployed runtime dictionary

Declaration

public override SoTable Definition { get; }

Property Value

Type	Description
SoTable

Overrides

TableInfo.Definition

Description

Field 'description' in table 'form': Dictionary type String[4001], .NET type: System.String

Detailed description

Declaration

public StringFieldInfo Description { get; }

Property Value

Type	Description
StringFieldInfo

DictionaryTableNumber

Table number for table Form in the database dictionary; potentially changes between databases, but always the same over the lifetime of any single database

Declaration

public int DictionaryTableNumber { get; }

Property Value

Type	Description
System.Int32

Expires

Field 'expires' in table 'form': Dictionary type DateTime, .NET type: System.DateTime

After this datetime, the form will become inactive

Declaration

public DateTimeFieldInfo Expires { get; }

Property Value

Type	Description
DateTimeFieldInfo

FolderId

Field 'folder_id' in table 'form': Dictionary type FK, .NET type: System.Int32

The folder which this form belongs to. -1 indicates that the shipment is on the root

Declaration

public Int32FieldInfo FolderId { get; }

Property Value

Type	Description
Int32FieldInfo

FolderId_InnerJoin_SPictureFolder

Generated join from the foreign key FolderId in this table, to its target table SPictureFolderTableInfo.

Declaration

public TargetedInnerJoin<SPictureFolderTableInfo> FolderId_InnerJoin_SPictureFolder { get; }

Property Value

Type	Description
TargetedInnerJoin<SPictureFolderTableInfo>

FormId

Field 'form_id' in table 'form': Dictionary type PK, .NET type: System.Int32

Primary key

Declaration

public Int32FieldInfo FormId { get; }

Property Value

Type	Description
Int32FieldInfo

FormKey

Field 'form_key' in table 'form': Dictionary type String[33], .NET type: System.String

A short string used as unique id to access this form

Declaration

public StringFieldInfo FormKey { get; }

Property Value

Type	Description
StringFieldInfo

GroupId

Field 'group_id' in table 'form': Dictionary type FK, .NET type: System.Int32

The group which this form belongs to.

Declaration

public Int32FieldInfo GroupId { get; }

Property Value

Type	Description
Int32FieldInfo

GroupId_InnerJoin_UserGroup

Generated join from the foreign key GroupId in this table, to its target table UserGroupTableInfo.

Declaration

public TargetedInnerJoin<UserGroupTableInfo> GroupId_InnerJoin_UserGroup { get; }

Property Value

Type	Description
TargetedInnerJoin<UserGroupTableInfo>

LeftOuterJoin_FormSubmission_FormId

Generated left outer join from the primary key FormId on this table, to FormSubmission.FormId.

Declaration

public TargetedLeftOuterJoin<FormSubmissionTableInfo> LeftOuterJoin_FormSubmission_FormId { get; }

Property Value

Type	Description
TargetedLeftOuterJoin<FormSubmissionTableInfo>

MaxSubmits

Field 'maxSubmits' in table 'form': Dictionary type Int, .NET type: System.Int32

After this number of submits, the form will become inactive

Declaration

public Int32FieldInfo MaxSubmits { get; }

Property Value

Type	Description
Int32FieldInfo

Name

Field 'name' in table 'form': Dictionary type String[4001], .NET type: System.String

The name of this form

Declaration

public StringFieldInfo Name { get; }

Property Value

Type	Description
StringFieldInfo

NewTicket

Field 'new_ticket' in table 'form': Dictionary type Bool, .NET type: System.Int16

True if this form creates a new ticket

Declaration

public UInt16FieldInfo NewTicket { get; }

Property Value

Type	Description
UInt16FieldInfo

Recipe

Field 'recipe' in table 'form': Dictionary type Clob, .NET type: System.String

The JSON-formatted recipe of this form

Declaration

public StringFieldInfo Recipe { get; }

Property Value

Type	Description
StringFieldInfo

Registered

Field 'registered' in table 'form': Dictionary type UtcDateTime, .NET type: System.DateTime

Registered when

Declaration

public DateTimeFieldInfo Registered { get; }

Property Value

Type	Description
DateTimeFieldInfo

RegisteredAssociateId

Field 'registered_associate_id' in table 'form': Dictionary type FK, .NET type: System.Int32

Registered by whom

Declaration

public Int32FieldInfo RegisteredAssociateId { get; }

Property Value

Type	Description
Int32FieldInfo

RegisteredAssociateId_InnerJoin_Associate

Generated join from the foreign key RegisteredAssociateId in this table, to its target table AssociateTableInfo.

Declaration

public TargetedInnerJoin<AssociateTableInfo> RegisteredAssociateId_InnerJoin_Associate { get; }

Property Value

Type	Description
TargetedInnerJoin<AssociateTableInfo>

ResponseShipmentId

Field 'response_shipment_id' in table 'form': Dictionary type FK, .NET type: System.Int32

The id of the s_shipment that is used to send the response mails

Declaration

public Int32FieldInfo ResponseShipmentId { get; }

Property Value

Type	Description
Int32FieldInfo

ResponseShipmentId_InnerJoin_SShipment

Generated join from the foreign key ResponseShipmentId in this table, to its target table SShipmentTableInfo.

Declaration

public TargetedInnerJoin<SShipmentTableInfo> ResponseShipmentId_InnerJoin_SShipment { get; }

Property Value

Type	Description
TargetedInnerJoin<SShipmentTableInfo>

RuntimeDefinition

Definition of the table as described in the deployed runtime dictionary

Declaration

[Obsolete("Use instance property Definition or static member DictionaryTableNumber", true)]
public static SoTable RuntimeDefinition { get; }

Property Value

Type	Description
SoTable

ScriptId

Field 'script_id' in table 'form': Dictionary type FK, .NET type: System.Int32

The CRMScript Macro which will be run when the form is submitted.

Declaration

public Int32FieldInfo ScriptId { get; }

Property Value

Type	Description
Int32FieldInfo

ScriptId_InnerJoin_Ejscript

Generated join from the foreign key ScriptId in this table, to its target table EjscriptTableInfo.

Declaration

public TargetedInnerJoin<EjscriptTableInfo> ScriptId_InnerJoin_Ejscript { get; }

Property Value

Type	Description
TargetedInnerJoin<EjscriptTableInfo>

Type

Field 'type' in table 'form': Dictionary type Enum, .NET type: FormType

What kind of form is this? Indicates if this is a normal form or a template

Declaration

public FormTypeFieldInfo Type { get; }

Property Value

Type	Description
FormTypeFieldInfo

Updated

Field 'updated' in table 'form': Dictionary type UtcDateTime, .NET type: System.DateTime

Last updated when

Declaration

public DateTimeFieldInfo Updated { get; }

Property Value

Type	Description
DateTimeFieldInfo

UpdatedAssociateId

Field 'updated_associate_id' in table 'form': Dictionary type FK, .NET type: System.Int32

Last updated by whom

Declaration

public Int32FieldInfo UpdatedAssociateId { get; }

Property Value

Type	Description
Int32FieldInfo

UpdatedAssociateId_InnerJoin_Associate

Generated join from the foreign key UpdatedAssociateId in this table, to its target table AssociateTableInfo.

Declaration

public TargetedInnerJoin<AssociateTableInfo> UpdatedAssociateId_InnerJoin_Associate { get; }

Property Value

Type	Description
TargetedInnerJoin<AssociateTableInfo>

UpdatedCount

Field 'updatedCount' in table 'form': Dictionary type UShort, .NET type: System.Int16

Number of updates made to this record

Declaration

public UInt16FieldInfo UpdatedCount { get; }

Property Value

Type	Description
UInt16FieldInfo

Implements

System.ICloneable

Extension Methods

EnumUtil.MapEnums<From, To>(From)

Converters.MapEnums<From, To>(From)