Show / Hide Table of Contents

Class FormRecordData

POCO (Plain Old CLR Object) class that can be used to hold data corresponding to a row from the form table.

Inheritance
object
FormRecordData
Inherited Members
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class FormRecordData
Remarks

Please use this class instead of a full FormRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding FormTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Constructors

FormRecordData()

POCO (Plain Old CLR Object) class that can be used to hold data corresponding to a row from the form table.

Declaration
public FormRecordData()
Remarks

Please use this class instead of a full FormRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding FormTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Fields

Active

Indicates if this form is active and available for customers

Declaration
public short Active
Field Value
Type Description
short
Remarks

Please use this class instead of a full FormRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding FormTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Config

The JSON-formatted config of this form

Declaration
public string Config
Field Value
Type Description
string
Remarks

Please use this class instead of a full FormRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding FormTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Description

Detailed description

Declaration
public string Description
Field Value
Type Description
string
Remarks

Please use this class instead of a full FormRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding FormTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Expires

After this datetime, the form will become inactive

Declaration
public DateTime Expires
Field Value
Type Description
DateTime
Remarks

Please use this class instead of a full FormRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding FormTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

FolderId

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

Declaration
public int FolderId
Field Value
Type Description
int
Remarks

Please use this class instead of a full FormRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding FormTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

FormId

Primary key

Declaration
public int FormId
Field Value
Type Description
int
Remarks

Please use this class instead of a full FormRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding FormTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

FormKey

A short string used as unique id to access this form

Declaration
public string FormKey
Field Value
Type Description
string
Remarks

Please use this class instead of a full FormRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding FormTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

GroupId

The group which this form belongs to.

Declaration
public int GroupId
Field Value
Type Description
int
Remarks

Please use this class instead of a full FormRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding FormTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

MaxSubmits

After this number of submits, the form will become inactive

Declaration
public int MaxSubmits
Field Value
Type Description
int
Remarks

Please use this class instead of a full FormRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding FormTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Name

The name of this form

Declaration
public string Name
Field Value
Type Description
string
Remarks

Please use this class instead of a full FormRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding FormTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

NewTicket

True if this form creates a new ticket

Declaration
public short NewTicket
Field Value
Type Description
short
Remarks

Please use this class instead of a full FormRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding FormTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Recipe

The JSON-formatted recipe of this form

Declaration
public string Recipe
Field Value
Type Description
string
Remarks

Please use this class instead of a full FormRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding FormTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Registered

Registered when in UTC.

Declaration
public DateTime Registered
Field Value
Type Description
DateTime
Remarks

Please use this class instead of a full FormRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding FormTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

RegisteredAssociateId

Registered by whom

Declaration
public int RegisteredAssociateId
Field Value
Type Description
int
Remarks

Please use this class instead of a full FormRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding FormTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

ResponseShipmentId

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

Declaration
public int ResponseShipmentId
Field Value
Type Description
int
Remarks

Please use this class instead of a full FormRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding FormTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

ScriptId

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

Declaration
public int ScriptId
Field Value
Type Description
int
Remarks

Please use this class instead of a full FormRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding FormTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Type

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

Declaration
public FormType Type
Field Value
Type Description
FormType
Remarks

Please use this class instead of a full FormRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding FormTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Updated

Last updated when in UTC.

Declaration
public DateTime Updated
Field Value
Type Description
DateTime
Remarks

Please use this class instead of a full FormRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding FormTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

UpdatedAssociateId

Last updated by whom

Declaration
public int UpdatedAssociateId
Field Value
Type Description
int
Remarks

Please use this class instead of a full FormRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding FormTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

UpdatedCount

Number of updates made to this record

Declaration
public short UpdatedCount
Field Value
Type Description
short
Remarks

Please use this class instead of a full FormRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding FormTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Extension Methods

EnumUtil.MapEnums<From, To>(From)
FormRecordDataExtensions.ToInsertAsync(FormRecordData, CancellationToken)
Converters.MapEnums<From, To>(From)
ObjectExtensions.AssignByReflection<T>(T, T)
ObjectExtensions.GraphCopy<T>(T)
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top