NSUserDefinedFieldInfo

Can be used to mirror the layout of the user-defined fields in the user interface.

Constructors

NSUserDefinedFieldInfo()

NSUserDefinedFieldInfo

Initializes a new instance of the NSUserDefinedFieldInfo class.

Methods

GetColumnId()

Integer GetColumnId()

Returns: CRMScript.Global.Integer - The ID of the database column this field corresponds to. Example:

NSUserDefinedFieldInfo thing;
Integer columnId = thing.GetColumnId();

GetFieldDefault()

String GetFieldDefault()

Returns: CRMScript.Global.String - Optional default value for String fields. Example:

NSUserDefinedFieldInfo thing;
String fieldDefault = thing.GetFieldDefault();

GetFieldHeight()

Integer GetFieldHeight()

Returns: CRMScript.Global.Integer - field height in pixels, 0 = ‘enough’ (from font). Example:

NSUserDefinedFieldInfo thing;
Integer fieldHeight = thing.GetFieldHeight();

GetFieldLabel()

String GetFieldLabel()

Returns: CRMScript.Global.String - The label (lead text). Example:

NSUserDefinedFieldInfo thing;
String fieldLabel = thing.GetFieldLabel();

GetFieldLeft()

Integer GetFieldLeft()

Returns: CRMScript.Global.Integer - X pixel coordinate of field. Example:

NSUserDefinedFieldInfo thing;
Integer fieldLeft = thing.GetFieldLeft();

GetFieldTop()

Integer GetFieldTop()

Returns: CRMScript.Global.Integer - Y pixel coordinate of field. Example:

NSUserDefinedFieldInfo thing;
Integer fieldTop = thing.GetFieldTop();

GetFieldType()

Integer GetFieldType()

Returns: CRMScript.Global.Integer - See <xref href=“CRMScript.NetServer.UDefFieldType” data-throw-if-not-resolved=“false”></xref> Example:

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

GetFieldWidth()

Integer GetFieldWidth()

Returns: CRMScript.Global.Integer - field width in pixels, 0 = ‘enough’ (from font). Example:

NSUserDefinedFieldInfo thing;
Integer fieldWidth = thing.GetFieldWidth();

GetFormatMask()

String GetFormatMask()

Returns: CRMScript.Global.String - Formatting mask, can be whatever the controls understand (currently nothing). Example:

NSUserDefinedFieldInfo thing;
String formatMask = thing.GetFormatMask();

GetHasBeenPublished()

Bool GetHasBeenPublished()

Returns: CRMScript.Global.Bool - Has the udef field been published? Example:

NSUserDefinedFieldInfo thing;
Bool hasBeenPublished = thing.GetHasBeenPublished();

GetHideLabel()

Bool GetHideLabel()

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

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

GetIsIndexed()

Bool GetIsIndexed()

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

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

GetIsMandatory()

Bool GetIsMandatory()

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

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

GetIsReadOnly()

Bool GetIsReadOnly()

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

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

GetJustification()

Integer GetJustification()

Returns: CRMScript.Global.Integer - Justification. See <xref href=“CRMScript.NetServer.UdefJustification” data-throw-if-not-resolved=“false”></xref> Example:

NSUserDefinedFieldInfo thing;
Integer justification = thing.GetJustification();

GetLabelHeight()

Integer GetLabelHeight()

Returns: CRMScript.Global.Integer - label height in pixels, 0 = ‘enough’ (from font). Example:

NSUserDefinedFieldInfo thing;
Integer labelHeight = thing.GetLabelHeight();

GetLabelLeft()

Integer GetLabelLeft()

Returns: CRMScript.Global.Integer - X pixel coordinate of label. Example:

NSUserDefinedFieldInfo thing;
Integer labelLeft = thing.GetLabelLeft();

GetLabelTop()

Integer GetLabelTop()

Returns: CRMScript.Global.Integer - Y pixel coordinate of label. Example:

NSUserDefinedFieldInfo thing;
Integer labelTop = thing.GetLabelTop();

GetLabelWidth()

Integer GetLabelWidth()

Returns: CRMScript.Global.Integer - label width in pixels, 0 = ‘enough’ (from font). Example:

NSUserDefinedFieldInfo thing;
Integer labelWidth = thing.GetLabelWidth();

GetLastVersionId()

Integer GetLastVersionId()

Returns: CRMScript.Global.Integer - UDefFieldId this field had in the previous version, 0 = field is new in this version. Example:

NSUserDefinedFieldInfo thing;
Integer lastVersionId = thing.GetLastVersionId();

GetListTableId()

Integer GetListTableId()

Returns: CRMScript.Global.Integer - The table ID of the source table for lists kTableAssoc, kTableContInt or whatever. Example:

NSUserDefinedFieldInfo thing;
Integer listTableId = thing.GetListTableId();

GetMdoListName()

String GetMdoListName()

Returns: CRMScript.Global.String - MDO list name used to populate this list. Derived from UDListDefinitionId and ListTableId. (Read-only). Example:

NSUserDefinedFieldInfo thing;
String mdoListName = thing.GetMdoListName();

GetOwnerTableId()

Integer GetOwnerTableId()

Returns: CRMScript.Global.Integer - ID of owning table (contact, person, project).

GetPage1LineNo()

Integer GetPage1LineNo()

Returns: CRMScript.Global.Integer - Line no on View Page 1, used if MDO flags are OFF. 0 = this field is not visible on page 1 Example:

NSUserDefinedFieldInfo thing;
Integer page1LineNo = thing.GetPage1LineNo();

GetProgId()

String GetProgId()

Returns: CRMScript.Global.String - Programmatic ID, for use by software that needs to find a particular field. Carried over like udefIdentity across generations.

Use a Company.Product.Field format to avoid naming conflicts; the Company name SuperOffice is reserved.

Example:

NSUserDefinedFieldInfo thing;
String progId = thing.GetProgId();

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:

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

GetTabOrder()

Integer GetTabOrder()

Returns: CRMScript.Global.Integer - Tab order value, sets the field processing sequence. Example:

NSUserDefinedFieldInfo thing;
Integer tabOrder = thing.GetTabOrder();

GetTemplateVariableName()

String GetTemplateVariableName()

Returns: CRMScript.Global.String - Template variable name. Example:

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

GetTextLength()

Integer GetTextLength()

Returns: CRMScript.Global.Integer - Length (in characters) of a text field, 0 for other types. Example:

NSUserDefinedFieldInfo thing;
Integer textLength = thing.GetTextLength();

GetTooltip()

String GetTooltip()

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

NSUserDefinedFieldInfo thing;
String tooltip = thing.GetTooltip();

GetType()

Integer GetType()

Returns: CRMScript.Global.Integer - ID of owning table (contact, person, project). See <xref href=“CRMScript.NetServer.UDefType” data-throw-if-not-resolved=“false”></xref>.

This is not the actual tableNumber, rather it’s an enum.

Example:

NSUserDefinedFieldInfo thing;
Integer type = thing.GetType();

GetUDefFieldId()

Integer GetUDefFieldId()

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

NSUserDefinedFieldInfo thing;
Integer uDefFieldId = thing.GetUDefFieldId();

GetUdefIdentity()

Integer GetUdefIdentity()

Returns: CRMScript.Global.Integer - Unique number used to track field identity across layout changes. Example:

NSUserDefinedFieldInfo thing;
Integer udefIdentity = thing.GetUdefIdentity();

GetUDListDefinitionId()

Integer GetUDListDefinitionId()

Returns: CRMScript.Global.Integer - List to use for populating dropdown or listbox. Example:

NSUserDefinedFieldInfo thing;
Integer uDListDefinitionId = thing.GetUDListDefinitionId();

GetVersion()

Integer GetVersion()

Returns: CRMScript.Global.Integer - Definition version number; ALL fields get new version whenever layout is updated. Example:

NSUserDefinedFieldInfo thing;
Integer version = thing.GetVersion();

SetColumnId(Integer)

Void SetColumnId(Integer columnId)

Returns: CRMScript.Global.Void Example:

NSUserDefinedFieldInfo thing;
Integer columnId;
thing.SetColumnId(columnId);

SetFieldDefault(String)

Void SetFieldDefault(String fieldDefault)

Returns: CRMScript.Global.Void Example:

NSUserDefinedFieldInfo thing;
String fieldDefault;
thing.SetFieldDefault(fieldDefault);

SetFieldHeight(Integer)

Void SetFieldHeight(Integer fieldHeight)

Returns: CRMScript.Global.Void Example:

NSUserDefinedFieldInfo thing;
Integer fieldHeight;
thing.SetFieldHeight(fieldHeight);

SetFieldLabel(String)

Void SetFieldLabel(String fieldLabel)

Returns: CRMScript.Global.Void Example:

NSUserDefinedFieldInfo thing;
String fieldLabel;
thing.SetFieldLabel(fieldLabel);

SetFieldLeft(Integer)

Void SetFieldLeft(Integer fieldLeft)

Returns: CRMScript.Global.Void Example:

NSUserDefinedFieldInfo thing;
Integer fieldLeft;
thing.SetFieldLeft(fieldLeft);

SetFieldTop(Integer)

Void SetFieldTop(Integer fieldTop)

Returns: CRMScript.Global.Void Example:

NSUserDefinedFieldInfo thing;
Integer fieldTop;
thing.SetFieldTop(fieldTop);

SetFieldType(Integer)

Void SetFieldType(Integer fieldType)

Returns: CRMScript.Global.Void Example:

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

SetFieldWidth(Integer)

Void SetFieldWidth(Integer fieldWidth)

Returns: CRMScript.Global.Void Example:

NSUserDefinedFieldInfo thing;
Integer fieldWidth;
thing.SetFieldWidth(fieldWidth);

SetFormatMask(String)

Void SetFormatMask(String formatMask)

Returns: CRMScript.Global.Void Example:

NSUserDefinedFieldInfo thing;
String formatMask;
thing.SetFormatMask(formatMask);

SetHasBeenPublished(Bool)

Void SetHasBeenPublished(Bool hasBeenPublished)

Returns: CRMScript.Global.Void Example:

NSUserDefinedFieldInfo thing;
Bool hasBeenPublished;
thing.SetHasBeenPublished(hasBeenPublished);

SetHideLabel(Bool)

Void SetHideLabel(Bool hideLabel)

Returns: CRMScript.Global.Void Example:

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

SetIsIndexed(Bool)

Void SetIsIndexed(Bool isIndexed)

Returns: CRMScript.Global.Void Example:

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

SetIsMandatory(Bool)

Void SetIsMandatory(Bool isMandatory)

Returns: CRMScript.Global.Void Example:

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

SetIsReadOnly(Bool)

Void SetIsReadOnly(Bool isReadOnly)

Returns: CRMScript.Global.Void Example:

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

SetJustification(Integer)

Void SetJustification(Integer justification)

Returns: CRMScript.Global.Void Example:

NSUserDefinedFieldInfo thing;
Integer justification;
thing.SetJustification(justification);

SetLabelHeight(Integer)

Void SetLabelHeight(Integer labelHeight)

Returns: CRMScript.Global.Void Example:

NSUserDefinedFieldInfo thing;
Integer labelHeight;
thing.SetLabelHeight(labelHeight);

SetLabelLeft(Integer)

Void SetLabelLeft(Integer labelLeft)

Returns: CRMScript.Global.Void Example:

NSUserDefinedFieldInfo thing;
Integer labelLeft;
thing.SetLabelLeft(labelLeft);

SetLabelTop(Integer)

Void SetLabelTop(Integer labelTop)

Returns: CRMScript.Global.Void Example:

NSUserDefinedFieldInfo thing;
Integer labelTop;
thing.SetLabelTop(labelTop);

SetLabelWidth(Integer)

Void SetLabelWidth(Integer labelWidth)

Returns: CRMScript.Global.Void Example:

NSUserDefinedFieldInfo thing;
Integer labelWidth;
thing.SetLabelWidth(labelWidth);

SetLastVersionId(Integer)

Void SetLastVersionId(Integer lastVersionId)

Returns: CRMScript.Global.Void Example:

NSUserDefinedFieldInfo thing;
Integer lastVersionId;
thing.SetLastVersionId(lastVersionId);

SetListTableId(Integer)

Void SetListTableId(Integer listTableId)

Returns: CRMScript.Global.Void Example:

NSUserDefinedFieldInfo thing;
Integer listTableId;
thing.SetListTableId(listTableId);

SetMdoListName(String)

Void SetMdoListName(String mdoListName)

Returns: CRMScript.Global.Void Example:

NSUserDefinedFieldInfo thing;
String mdoListName;
thing.SetMdoListName(mdoListName);

SetOwnerTableId(Integer)

Void SetOwnerTableId(Integer id)

Returns: CRMScript.Global.Void

SetPage1LineNo(Integer)

Void SetPage1LineNo(Integer page1LineNo)

Returns: CRMScript.Global.Void Example:

NSUserDefinedFieldInfo thing;
Integer page1LineNo;
thing.SetPage1LineNo(page1LineNo);

SetProgId(String)

Void SetProgId(String progId)

Returns: CRMScript.Global.Void

Use a Company.Product.Field format to avoid naming conflicts; the Company name SuperOffice is reserved.

Example:

NSUserDefinedFieldInfo thing;
String progId;
thing.SetProgId(progId);

SetShortLabel(String)

Void SetShortLabel(String shortLabel)

Returns: CRMScript.Global.Void Example:

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

SetTabOrder(Integer)

Void SetTabOrder(Integer tabOrder)

Returns: CRMScript.Global.Void Example:

NSUserDefinedFieldInfo thing;
Integer tabOrder;
thing.SetTabOrder(tabOrder);

SetTemplateVariableName(String)

Void SetTemplateVariableName(String templateVariableName)

Returns: CRMScript.Global.Void Example:

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

SetTextLength(Integer)

Void SetTextLength(Integer textLength)

Returns: CRMScript.Global.Void Example:

NSUserDefinedFieldInfo thing;
Integer textLength;
thing.SetTextLength(textLength);

SetTooltip(String)

Void SetTooltip(String tooltip)

Returns: CRMScript.Global.Void Example:

NSUserDefinedFieldInfo thing;
String tooltip;
thing.SetTooltip(tooltip);

SetType(Integer)

Void SetType(Integer type)

Returns: CRMScript.Global.Void

This is not the actual tableNumber, rather it’s an enum.

Example:

NSUserDefinedFieldInfo thing;
Integer type;
thing.SetType(type);

SetUDefFieldId(Integer)

Void SetUDefFieldId(Integer uDefFieldId)

Returns: CRMScript.Global.Void Example:

NSUserDefinedFieldInfo thing;
Integer uDefFieldId;
thing.SetUDefFieldId(uDefFieldId);

SetUdefIdentity(Integer)

Void SetUdefIdentity(Integer udefIdentity)

Returns: CRMScript.Global.Void Example:

NSUserDefinedFieldInfo thing;
Integer udefIdentity;
thing.SetUdefIdentity(udefIdentity);

SetUDListDefinitionId(Integer)

Void SetUDListDefinitionId(Integer uDListDefinitionId)

Returns: CRMScript.Global.Void Example:

NSUserDefinedFieldInfo thing;
Integer uDListDefinitionId;
thing.SetUDListDefinitionId(uDListDefinitionId);

SetVersion(Integer)

Void SetVersion(Integer version)

Returns: CRMScript.Global.Void Example:

NSUserDefinedFieldInfo thing;
Integer version;
thing.SetVersion(version);

​Constructors

​NSUserDefinedFieldInfo()

​Methods

​GetColumnId()

​GetFieldDefault()

​GetFieldHeight()

​GetFieldLabel()

​GetFieldLeft()

​GetFieldTop()

​GetFieldType()

​GetFieldWidth()

​GetFormatMask()

​GetHasBeenPublished()

​GetHideLabel()

​GetIsIndexed()

​GetIsMandatory()

​GetIsReadOnly()

​GetJustification()

​GetLabelHeight()

​GetLabelLeft()

​GetLabelTop()

​GetLabelWidth()

​GetLastVersionId()

​GetListTableId()

​GetMdoListName()

​GetOwnerTableId()

​GetPage1LineNo()

​GetProgId()

​GetShortLabel()

​GetTabOrder()

​GetTemplateVariableName()

​GetTextLength()

​GetTooltip()

​GetType()

​GetUDefFieldId()

​GetUdefIdentity()

​GetUDListDefinitionId()

​GetVersion()

​SetColumnId(Integer)

​SetFieldDefault(String)

​SetFieldHeight(Integer)

​SetFieldLabel(String)

​SetFieldLeft(Integer)

​SetFieldTop(Integer)

​SetFieldType(Integer)

​SetFieldWidth(Integer)

​SetFormatMask(String)

​SetHasBeenPublished(Bool)

​SetHideLabel(Bool)

​SetIsIndexed(Bool)

​SetIsMandatory(Bool)

​SetIsReadOnly(Bool)

​SetJustification(Integer)

​SetLabelHeight(Integer)

​SetLabelLeft(Integer)

​SetLabelTop(Integer)

​SetLabelWidth(Integer)

​SetLastVersionId(Integer)

​SetListTableId(Integer)

​SetMdoListName(String)

​SetOwnerTableId(Integer)

​SetPage1LineNo(Integer)

​SetProgId(String)

​SetShortLabel(String)

​SetTabOrder(Integer)

​SetTemplateVariableName(String)

​SetTextLength(Integer)

​SetTooltip(String)

​SetType(Integer)

​SetUDefFieldId(Integer)

​SetUdefIdentity(Integer)

​SetUDListDefinitionId(Integer)

​SetVersion(Integer)

Constructors

NSUserDefinedFieldInfo()

Methods

GetColumnId()

GetFieldDefault()

GetFieldHeight()

GetFieldLabel()

GetFieldLeft()

GetFieldTop()

GetFieldType()

GetFieldWidth()

GetFormatMask()

GetHasBeenPublished()

GetHideLabel()

GetIsIndexed()

GetIsMandatory()

GetIsReadOnly()

GetJustification()

GetLabelHeight()

GetLabelLeft()

GetLabelTop()

GetLabelWidth()

GetLastVersionId()

GetListTableId()

GetMdoListName()

GetOwnerTableId()

GetPage1LineNo()

GetProgId()

GetShortLabel()

GetTabOrder()

GetTemplateVariableName()

GetTextLength()

GetTooltip()

GetType()

GetUDefFieldId()

GetUdefIdentity()

GetUDListDefinitionId()

GetVersion()

SetColumnId(Integer)

SetFieldDefault(String)

SetFieldHeight(Integer)

SetFieldLabel(String)

SetFieldLeft(Integer)

SetFieldTop(Integer)

SetFieldType(Integer)

SetFieldWidth(Integer)

SetFormatMask(String)

SetHasBeenPublished(Bool)

SetHideLabel(Bool)

SetIsIndexed(Bool)

SetIsMandatory(Bool)

SetIsReadOnly(Bool)

SetJustification(Integer)

SetLabelHeight(Integer)

SetLabelLeft(Integer)

SetLabelTop(Integer)

SetLabelWidth(Integer)

SetLastVersionId(Integer)

SetListTableId(Integer)

SetMdoListName(String)

SetOwnerTableId(Integer)

SetPage1LineNo(Integer)

SetProgId(String)

SetShortLabel(String)

SetTabOrder(Integer)

SetTemplateVariableName(String)

SetTextLength(Integer)

SetTooltip(String)

SetType(Integer)

SetUDefFieldId(Integer)

SetUdefIdentity(Integer)

SetUDListDefinitionId(Integer)

SetVersion(Integer)