NSFieldInfoBase - SuperOffice

Abstract basic information about database fields. May be custom or user-defined fields. The information can be used to build a user interface.

Constructors

NSFieldInfoBase()

NSFieldInfoBase

Initializes a new instance of the NSFieldInfoBase class.

Methods

GetDescription()

String GetDescription()

Returns: CRMScript.Global.String - Optional tooltip text for this field. Example:

NSFieldInfoBase thing;
String description = thing.GetDescription();

GetDisplayName()

String GetDisplayName()

Returns: CRMScript.Global.String - Label for field. May be multi-lang string encoded. Example:

NSFieldInfoBase thing;
String displayName = thing.GetDisplayName();

GetFieldName()

String GetFieldName()

Returns: CRMScript.Global.String - Database name or prog-id ‘x_foobar’ or ‘SuperOffice:2’. Example:

NSFieldInfoBase thing;
String fieldName = thing.GetFieldName();

GetFieldType()

Integer GetFieldType()

Returns: CRMScript.Global.Integer - What sort of data does this field contain. See <xref href=“CRMScript.NetServer.CustomFieldType” data-throw-if-not-resolved=“false”></xref>. Example:

NSFieldInfoBase thing;
Integer fieldType = thing.GetFieldType();

GetHideField()

Bool GetHideField()

Returns: CRMScript.Global.Bool - Hide the field from the UI. Only allow API access. Example:

NSFieldInfoBase thing;
Bool hideField = thing.GetHideField();

GetHideLabel()

Bool GetHideLabel()

Returns: CRMScript.Global.Bool - Hide the label if 1 Example:

NSFieldInfoBase thing;
Bool hideLabel = thing.GetHideLabel();

GetIsExternal()

Bool GetIsExternal()

Returns: CRMScript.Global.Bool - Should this field be shown to external users via customer center? Example:

NSFieldInfoBase thing;
Bool isExternal = thing.GetIsExternal();

GetIsIndexed()

Bool GetIsIndexed()

Returns: CRMScript.Global.Bool - Is this field indexed? true if yes; false if no. Example:

NSFieldInfoBase thing;
Bool isIndexed = thing.GetIsIndexed();

GetIsMandatory()

Bool GetIsMandatory()

Returns: CRMScript.Global.Bool - 0 = no, 1 = yes (field must be filled out). Example:

NSFieldInfoBase thing;
Bool isMandatory = thing.GetIsMandatory();

GetIsReadOnly()

Bool GetIsReadOnly()

Returns: CRMScript.Global.Bool - 0 = read/write, 1 = readonly (don’t combine with mandatory). Example:

NSFieldInfoBase thing;
Bool isReadOnly = thing.GetIsReadOnly();

GetRank()

Integer GetRank()

Returns: CRMScript.Global.Integer - Tab order, ranking within the custom fields. Example:

NSFieldInfoBase thing;
Integer rank = thing.GetRank();

GetShortLabel()

String GetShortLabel()

Returns: CRMScript.Global.String - Short name to be used in Archive headings and on page 1. If blank, the fieldLabel will be used everywhere. Example:

NSFieldInfoBase thing;
String shortLabel = thing.GetShortLabel();

GetTemplateVariableName()

String GetTemplateVariableName()

Returns: CRMScript.Global.String - Template variable name ‘cs01’, ‘cl02’ etc. Null for extra fields. Example:

NSFieldInfoBase thing;
String templateVariableName = thing.GetTemplateVariableName();

SetDescription(String)

Void SetDescription(String description)

Returns: CRMScript.Global.Void Example:

NSFieldInfoBase thing;
String description;
thing.SetDescription(description);

SetDisplayName(String)

Void SetDisplayName(String displayName)

Returns: CRMScript.Global.Void Example:

NSFieldInfoBase thing;
String displayName;
thing.SetDisplayName(displayName);

SetFieldName(String)

Void SetFieldName(String fieldName)

Returns: CRMScript.Global.Void Example:

NSFieldInfoBase thing;
String fieldName;
thing.SetFieldName(fieldName);

SetFieldType(Integer)

Void SetFieldType(Integer fieldType)

Returns: CRMScript.Global.Void Example:

NSFieldInfoBase thing;
Integer fieldType;
thing.SetFieldType(fieldType);

SetHideField(Bool)

Void SetHideField(Bool hideField)

Returns: CRMScript.Global.Void Example:

NSFieldInfoBase thing;
Bool hideField;
thing.SetHideField(hideField);

SetHideLabel(Bool)

Void SetHideLabel(Bool hideLabel)

Returns: CRMScript.Global.Void Example:

NSFieldInfoBase thing;
Bool hideLabel;
thing.SetHideLabel(hideLabel);

SetIsExternal(Bool)

Void SetIsExternal(Bool isExternal)

Returns: CRMScript.Global.Void Example:

NSFieldInfoBase thing;
Bool isExternal;
thing.SetIsExternal(isExternal);

SetIsIndexed(Bool)

Void SetIsIndexed(Bool isIndexed)

Returns: CRMScript.Global.Void Example:

NSFieldInfoBase thing;
Bool isIndexed;
thing.SetIsIndexed(isIndexed);

SetIsMandatory(Bool)

Void SetIsMandatory(Bool isMandatory)

Returns: CRMScript.Global.Void Example:

NSFieldInfoBase thing;
Bool isMandatory;
thing.SetIsMandatory(isMandatory);

SetIsReadOnly(Bool)

Void SetIsReadOnly(Bool isReadOnly)

Returns: CRMScript.Global.Void Example:

NSFieldInfoBase thing;
Bool isReadOnly;
thing.SetIsReadOnly(isReadOnly);

SetRank(Integer)

Void SetRank(Integer rank)

Returns: CRMScript.Global.Void Example:

NSFieldInfoBase thing;
Integer rank;
thing.SetRank(rank);

SetShortLabel(String)

Void SetShortLabel(String shortLabel)

Returns: CRMScript.Global.Void Example:

NSFieldInfoBase thing;
String shortLabel;
thing.SetShortLabel(shortLabel);

SetTemplateVariableName(String)

Void SetTemplateVariableName(String templateVariableName)

Returns: CRMScript.Global.Void Example:

NSFieldInfoBase thing;
String templateVariableName;
thing.SetTemplateVariableName(templateVariableName);

​Constructors

​NSFieldInfoBase()

​Methods

​GetDescription()

​GetDisplayName()

​GetFieldName()

​GetFieldType()

​GetHideField()

​GetHideLabel()

​GetIsExternal()

​GetIsIndexed()

​GetIsMandatory()

​GetIsReadOnly()

​GetRank()

​GetShortLabel()

​GetTemplateVariableName()

​SetDescription(String)

​SetDisplayName(String)

​SetFieldName(String)

​SetFieldType(Integer)

​SetHideField(Bool)

​SetHideLabel(Bool)

​SetIsExternal(Bool)

​SetIsIndexed(Bool)

​SetIsMandatory(Bool)

​SetIsReadOnly(Bool)

​SetRank(Integer)

​SetShortLabel(String)

​SetTemplateVariableName(String)

Constructors

NSFieldInfoBase()

Methods

GetDescription()

GetDisplayName()

GetFieldName()

GetFieldType()

GetHideField()

GetHideLabel()

GetIsExternal()

GetIsIndexed()

GetIsMandatory()

GetIsReadOnly()

GetRank()

GetShortLabel()

GetTemplateVariableName()

SetDescription(String)

SetDisplayName(String)

SetFieldName(String)

SetFieldType(Integer)

SetHideField(Bool)

SetHideLabel(Bool)

SetIsExternal(Bool)

SetIsIndexed(Bool)

SetIsMandatory(Bool)

SetIsReadOnly(Bool)

SetRank(Integer)

SetShortLabel(String)

SetTemplateVariableName(String)