Skip to main content
Definition and configuration of a Form.

Constructors

NSFormEntity()

Initializes a new instance of the NSFormEntity class.

Methods

GetActive()

Indicates if this form is active or not
Returns: CRMScript.Global.Bool Example:

GetConfig()

Returns: CRMScript.Global.String - The JSON-formatted config of this form. Example:

GetDescription()

Returns: CRMScript.Global.String - Detailed description. Example:

GetExpires()

Returns: CRMScript.Global.DateTime - After this, the form will become inactive. Example:

GetFolderId()

Returns: CRMScript.Global.Integer - The folder which this form belongs to. -1 indicates that the shipment is on the root. Example:

GetFolderName()

Returns: CRMScript.Global.String - The name of the folder for this form. Example:

GetFormId()

Returns: CRMScript.Global.Integer - Primary key. Example:

GetFormKey()

Returns: CRMScript.Global.String - A short string used as unique ID to access this form. Example:

GetGroupId()

Returns: CRMScript.Global.Integer - The group which this form belongs to. Example:

GetMaxSubmits()

Returns: CRMScript.Global.Integer - After this number of submits, the form will become inactive. Example:

GetName()

Returns: CRMScript.Global.String - The name of this form. Example:

GetNewTicket()

Returns: CRMScript.Global.Bool - Indicates if this form creates a ticket or not. Example:

GetRecaptchaMode()

Returns: CRMScript.Global.Integer - What is the state of the reCAPTCHA configuration? This is a read-only member. See <xref href=“CRMScript.NetServer.FormsRecaptchaMode” data-throw-if-not-resolved=“false”></xref> Example:

GetRecipe()

Returns: CRMScript.Global.String - The JSON-formatted recipe of this form. Example:

GetRegistered()

Returns: CRMScript.Global.DateTime - Registered when. Example:

GetRegisteredAssociateId()

Returns: CRMScript.Global.Integer - Registered by whom. Example:

GetResponseShipmentId()

Returns: CRMScript.Global.Integer - The ID of the s_shipment that is used to send the response mails. Example:

GetScriptId()

Returns: CRMScript.Global.Integer - The CRMScript Macro that will be run when the form is submitted. Example:

GetType()

Returns: CRMScript.Global.Integer - What kind of form is this? Indicates if this is a normal form or a template. See <xref href=“CRMScript.NetServer.FormType” data-throw-if-not-resolved=“false”></xref>. Example:

GetUpdated()

Returns: CRMScript.Global.DateTime - Last updated when. Example:

GetUpdatedAssociateId()

Returns: CRMScript.Global.Integer - Last updated by whom. Example:

GetUpdatedCount()

Returns: CRMScript.Global.Integer - Number of updates made to this record. Example:

SetActive(Bool)

Returns: CRMScript.Global.Void Example:

SetConfig(String)

Returns: CRMScript.Global.Void Example:

SetDescription(String)

Returns: CRMScript.Global.Void Example:

SetExpires(DateTime)

Returns: CRMScript.Global.Void Example:

SetFolderId(Integer)

Returns: CRMScript.Global.Void Example:

SetFolderName(String)

Returns: CRMScript.Global.Void Example:

SetFormId(Integer)

Returns: CRMScript.Global.Void Example:

SetFormKey(String)

Returns: CRMScript.Global.Void Example:

SetGroupId(Integer)

Returns: CRMScript.Global.Void Example:

SetMaxSubmits(Integer)

Returns: CRMScript.Global.Void Example:

SetName(String)

Returns: CRMScript.Global.Void Example:

SetNewTicket(Bool)

Returns: CRMScript.Global.Void Example:

SetRecaptchaMode(Integer)

Returns: CRMScript.Global.Void Example:

SetRecipe(String)

Returns: CRMScript.Global.Void Example:

SetRegistered(DateTime)

Returns: CRMScript.Global.Void Example:

SetRegisteredAssociateId(Integer)

Returns: CRMScript.Global.Void Example:

SetResponseShipmentId(Integer)

Returns: CRMScript.Global.Void Example:

SetScriptId(Integer)

Returns: CRMScript.Global.Void Example:

SetType(Integer)

Returns: CRMScript.Global.Void Example:

SetUpdated(DateTime)

Returns: CRMScript.Global.Void Example:

SetUpdatedAssociateId(Integer)

Returns: CRMScript.Global.Void Example:

SetUpdatedCount(Integer)

Returns: CRMScript.Global.Void Example: