Class NSUserDefinedFieldInfo
Can be used to mirror the layout of the user-defined fields in the user interface.
Constructors
NSUserDefinedFieldInfo()
Initializes a new instance of the NSUserDefinedFieldInfo class.
Declaration
NSUserDefinedFieldInfoMethods
GetColumnId()
Declaration
Integer GetColumnId()Examples
NSUserDefinedFieldInfo thing;
Integer columnId = thing.GetColumnId();Returns
| Type | Description |
| Integer | The ID of the database column this field corresponds to. |
GetFieldDefault()
Declaration
String GetFieldDefault()Examples
NSUserDefinedFieldInfo thing;
String fieldDefault = thing.GetFieldDefault();Returns
| Type | Description |
| String | Optional default value for String fields. |
GetFieldHeight()
Declaration
Integer GetFieldHeight()Examples
NSUserDefinedFieldInfo thing;
Integer fieldHeight = thing.GetFieldHeight();Returns
| Type | Description |
| Integer | field height in pixels, 0 = 'enough' (from font). |
GetFieldLabel()
Declaration
String GetFieldLabel()Examples
NSUserDefinedFieldInfo thing;
String fieldLabel = thing.GetFieldLabel();Returns
| Type | Description |
| String | The label (lead text). |
GetFieldLeft()
Declaration
Integer GetFieldLeft()Examples
NSUserDefinedFieldInfo thing;
Integer fieldLeft = thing.GetFieldLeft();Returns
| Type | Description |
| Integer | X pixel coordinate of field. |
GetFieldTop()
Declaration
Integer GetFieldTop()Examples
NSUserDefinedFieldInfo thing;
Integer fieldTop = thing.GetFieldTop();Returns
| Type | Description |
| Integer | Y pixel coordinate of field. |
GetFieldType()
Declaration
Integer GetFieldType()Examples
NSUserDefinedFieldInfo thing;
Integer fieldType = thing.GetFieldType();Returns
| Type | Description |
| Integer | See <xref href="CRMScript.NetServer.UDefFieldType" data-throw-if-not-resolved="false"></xref> |
GetFieldWidth()
Declaration
Integer GetFieldWidth()Examples
NSUserDefinedFieldInfo thing;
Integer fieldWidth = thing.GetFieldWidth();Returns
| Type | Description |
| Integer | field width in pixels, 0 = 'enough' (from font). |
GetFormatMask()
Declaration
String GetFormatMask()Examples
NSUserDefinedFieldInfo thing;
String formatMask = thing.GetFormatMask();Returns
| Type | Description |
| String | Formatting mask, can be whatever the controls understand (currently nothing). |
GetHasBeenPublished()
Declaration
Bool GetHasBeenPublished()Examples
NSUserDefinedFieldInfo thing;
Bool hasBeenPublished = thing.GetHasBeenPublished();Returns
| Type | Description |
| Bool | Has the udef field been published? |
GetHideLabel()
Declaration
Bool GetHideLabel()Examples
NSUserDefinedFieldInfo thing;
Bool hideLabel = thing.GetHideLabel();Returns
| Type | Description |
| Bool | Hide the label if 1 |
GetIsIndexed()
Declaration
Bool GetIsIndexed()Examples
NSUserDefinedFieldInfo thing;
Bool isIndexed = thing.GetIsIndexed();Returns
| Type | Description |
| Bool | Is this field indexed? true if yes; false if no. |
GetIsMandatory()
Declaration
Bool GetIsMandatory()Examples
NSUserDefinedFieldInfo thing;
Bool isMandatory = thing.GetIsMandatory();Returns
| Type | Description |
| Bool | 0 = no, 1 = yes (field must be filled out). |
GetIsReadOnly()
Declaration
Bool GetIsReadOnly()Examples
NSUserDefinedFieldInfo thing;
Bool isReadOnly = thing.GetIsReadOnly();Returns
| Type | Description |
| Bool | 0 = read/write, 1 = readonly (don't combine with mandatory). |
GetJustification()
Declaration
Integer GetJustification()Examples
NSUserDefinedFieldInfo thing;
Integer justification = thing.GetJustification();Returns
| Type | Description |
| Integer | Justification. See <xref href="CRMScript.NetServer.UdefJustification" data-throw-if-not-resolved="false"></xref> |
GetLabelHeight()
Declaration
Integer GetLabelHeight()Examples
NSUserDefinedFieldInfo thing;
Integer labelHeight = thing.GetLabelHeight();Returns
| Type | Description |
| Integer | label height in pixels, 0 = 'enough' (from font). |
GetLabelLeft()
Declaration
Integer GetLabelLeft()Examples
NSUserDefinedFieldInfo thing;
Integer labelLeft = thing.GetLabelLeft();Returns
| Type | Description |
| Integer | X pixel coordinate of label. |
GetLabelTop()
Declaration
Integer GetLabelTop()Examples
NSUserDefinedFieldInfo thing;
Integer labelTop = thing.GetLabelTop();Returns
| Type | Description |
| Integer | Y pixel coordinate of label. |
GetLabelWidth()
Declaration
Integer GetLabelWidth()Examples
NSUserDefinedFieldInfo thing;
Integer labelWidth = thing.GetLabelWidth();Returns
| Type | Description |
| Integer | label width in pixels, 0 = 'enough' (from font). |
GetLastVersionId()
Declaration
Integer GetLastVersionId()Examples
NSUserDefinedFieldInfo thing;
Integer lastVersionId = thing.GetLastVersionId();Returns
| Type | Description |
| Integer | UDefFieldId this field had in the previous version, 0 = field is new in this version. |
GetListTableId()
Declaration
Integer GetListTableId()Examples
NSUserDefinedFieldInfo thing;
Integer listTableId = thing.GetListTableId();Returns
| Type | Description |
| Integer | The table ID of the source table for lists kTableAssoc, kTableContInt or whatever. |
GetMdoListName()
Declaration
String GetMdoListName()Examples
NSUserDefinedFieldInfo thing;
String mdoListName = thing.GetMdoListName();Returns
| Type | Description |
| String | MDO list name used to populate this list. Derived from UDListDefinitionId and ListTableId. (Read-only). |
GetOwnerTableId()
Declaration
Integer GetOwnerTableId()Returns
| Type | Description |
| Integer | ID of owning table (contact, person, project). |
GetPage1LineNo()
Declaration
Integer GetPage1LineNo()Examples
NSUserDefinedFieldInfo thing;
Integer page1LineNo = thing.GetPage1LineNo();Returns
| Type | Description |
| Integer | Line no on View Page 1, used if MDO flags are OFF. 0 = this field is not visible on page 1 |
GetProgId()
Declaration
String GetProgId()Examples
NSUserDefinedFieldInfo thing;
String progId = thing.GetProgId();Returns
| Type | Description |
| String | Programmatic ID, for use by software that needs to find a particular field. Carried over like udefIdentity across generations. |
GetShortLabel()
Declaration
String GetShortLabel()Examples
NSUserDefinedFieldInfo thing;
String shortLabel = thing.GetShortLabel();Returns
| Type | Description |
| String | Short name to be used in Archive headings and on page 1. If blank, the fieldLabel will be used everywhere. |
GetTabOrder()
Declaration
Integer GetTabOrder()Examples
NSUserDefinedFieldInfo thing;
Integer tabOrder = thing.GetTabOrder();Returns
| Type | Description |
| Integer | Tab order value, sets the field processing sequence. |
GetTemplateVariableName()
Declaration
String GetTemplateVariableName()Examples
NSUserDefinedFieldInfo thing;
String templateVariableName = thing.GetTemplateVariableName();Returns
| Type | Description |
| String | Template variable name. |
GetTextLength()
Declaration
Integer GetTextLength()Examples
NSUserDefinedFieldInfo thing;
Integer textLength = thing.GetTextLength();Returns
| Type | Description |
| Integer | Length (in characters) of a text field, 0 for other types. |
GetTooltip()
Declaration
String GetTooltip()Examples
NSUserDefinedFieldInfo thing;
String tooltip = thing.GetTooltip();Returns
| Type | Description |
| String | Optional tooltip text for this field. |
GetType()
Declaration
Integer GetType()Examples
NSUserDefinedFieldInfo thing;
Integer type = thing.GetType();Returns
| Type | Description |
| Integer | ID of owning table (contact, person, project). See <xref href="CRMScript.NetServer.UDefType" data-throw-if-not-resolved="false"></xref>. |
GetUDefFieldId()
Declaration
Integer GetUDefFieldId()Examples
NSUserDefinedFieldInfo thing;
Integer uDefFieldId = thing.GetUDefFieldId();Returns
| Type | Description |
| Integer | Primary key. |
GetUdefIdentity()
Declaration
Integer GetUdefIdentity()Examples
NSUserDefinedFieldInfo thing;
Integer udefIdentity = thing.GetUdefIdentity();Returns
| Type | Description |
| Integer | Unique number used to track field identity across layout changes. |
GetUDListDefinitionId()
Declaration
Integer GetUDListDefinitionId()Examples
NSUserDefinedFieldInfo thing;
Integer uDListDefinitionId = thing.GetUDListDefinitionId();Returns
| Type | Description |
| Integer | List to use for populating dropdown or listbox. |
GetVersion()
Declaration
Integer GetVersion()Examples
NSUserDefinedFieldInfo thing;
Integer version = thing.GetVersion();Returns
| Type | Description |
| Integer | Definition version number; ALL fields get new version whenever layout is updated. |
SetColumnId(Integer)
Declaration
Void SetColumnId(Integer columnId)Examples
NSUserDefinedFieldInfo thing;
Integer columnId;
thing.SetColumnId(columnId);Parameters
| Type | Name | Description |
| Integer | columnId | The ID of the database column this field corresponds to. |
Returns
| Type | Description |
| Void |
SetFieldDefault(String)
Declaration
Void SetFieldDefault(String fieldDefault)Examples
NSUserDefinedFieldInfo thing;
String fieldDefault;
thing.SetFieldDefault(fieldDefault);Parameters
| Type | Name | Description |
| String | fieldDefault | Optional default value for String fields. |
Returns
| Type | Description |
| Void |
SetFieldHeight(Integer)
Declaration
Void SetFieldHeight(Integer fieldHeight)Examples
NSUserDefinedFieldInfo thing;
Integer fieldHeight;
thing.SetFieldHeight(fieldHeight);Parameters
| Type | Name | Description |
| Integer | fieldHeight | field height in pixels, 0 = 'enough' (from font). |
Returns
| Type | Description |
| Void |
SetFieldLabel(String)
Declaration
Void SetFieldLabel(String fieldLabel)Examples
NSUserDefinedFieldInfo thing;
String fieldLabel;
thing.SetFieldLabel(fieldLabel);Parameters
| Type | Name | Description |
| String | fieldLabel | The label (lead text). |
Returns
| Type | Description |
| Void |
SetFieldLeft(Integer)
Declaration
Void SetFieldLeft(Integer fieldLeft)Examples
NSUserDefinedFieldInfo thing;
Integer fieldLeft;
thing.SetFieldLeft(fieldLeft);Parameters
| Type | Name | Description |
| Integer | fieldLeft | X pixel coordinate of field. |
Returns
| Type | Description |
| Void |
SetFieldTop(Integer)
Declaration
Void SetFieldTop(Integer fieldTop)Examples
NSUserDefinedFieldInfo thing;
Integer fieldTop;
thing.SetFieldTop(fieldTop);Parameters
| Type | Name | Description |
| Integer | fieldTop | Y pixel coordinate of field. |
Returns
| Type | Description |
| Void |
SetFieldType(Integer)
Declaration
Void SetFieldType(Integer fieldType)Examples
NSUserDefinedFieldInfo thing;
Integer fieldType;
thing.SetFieldType(fieldType);Parameters
| Type | Name | Description |
| Integer | fieldType | See <xref href="CRMScript.NetServer.UDefFieldType" data-throw-if-not-resolved="false"></xref>. |
Returns
| Type | Description |
| Void |
SetFieldWidth(Integer)
Declaration
Void SetFieldWidth(Integer fieldWidth)Examples
NSUserDefinedFieldInfo thing;
Integer fieldWidth;
thing.SetFieldWidth(fieldWidth);Parameters
| Type | Name | Description |
| Integer | fieldWidth | field width in pixels, 0 = 'enough' (from font). |
Returns
| Type | Description |
| Void |
SetFormatMask(String)
Declaration
Void SetFormatMask(String formatMask)Examples
NSUserDefinedFieldInfo thing;
String formatMask;
thing.SetFormatMask(formatMask);Parameters
| Type | Name | Description |
| String | formatMask | Formatting mask, can be whatever the controls understand (currently nothing). |
Returns
| Type | Description |
| Void |
SetHasBeenPublished(Bool)
Declaration
Void SetHasBeenPublished(Bool hasBeenPublished)Examples
NSUserDefinedFieldInfo thing;
Bool hasBeenPublished;
thing.SetHasBeenPublished(hasBeenPublished);Parameters
| Type | Name | Description |
| Bool | hasBeenPublished | Has the udef field been published? |
Returns
| Type | Description |
| Void |
SetHideLabel(Bool)
Declaration
Void SetHideLabel(Bool hideLabel)Examples
NSUserDefinedFieldInfo thing;
Bool hideLabel;
thing.SetHideLabel(hideLabel);Parameters
| Type | Name | Description |
| Bool | hideLabel | Hide the label if 1 |
Returns
| Type | Description |
| Void |
SetIsIndexed(Bool)
Declaration
Void SetIsIndexed(Bool isIndexed)Examples
NSUserDefinedFieldInfo thing;
Bool isIndexed;
thing.SetIsIndexed(isIndexed);Parameters
| Type | Name | Description |
| Bool | isIndexed | Is this field indexed? true if yes; false if no. |
Returns
| Type | Description |
| Void |
SetIsMandatory(Bool)
Declaration
Void SetIsMandatory(Bool isMandatory)Examples
NSUserDefinedFieldInfo thing;
Bool isMandatory;
thing.SetIsMandatory(isMandatory);Parameters
| Type | Name | Description |
| Bool | isMandatory | 0 = no, 1 = yes (field must be filled out). |
Returns
| Type | Description |
| Void |
SetIsReadOnly(Bool)
Declaration
Void SetIsReadOnly(Bool isReadOnly)Examples
NSUserDefinedFieldInfo thing;
Bool isReadOnly;
thing.SetIsReadOnly(isReadOnly);Parameters
| Type | Name | Description |
| Bool | isReadOnly | 0 = read/write, 1 = readonly (don't combine with mandatory). |
Returns
| Type | Description |
| Void |
SetJustification(Integer)
Declaration
Void SetJustification(Integer justification)Examples
NSUserDefinedFieldInfo thing;
Integer justification;
thing.SetJustification(justification);Parameters
| Type | Name | Description |
| Integer | justification | See <xref href="CRMScript.NetServer.UdefJustification" data-throw-if-not-resolved="false"></xref>. |
Returns
| Type | Description |
| Void |
SetLabelHeight(Integer)
Declaration
Void SetLabelHeight(Integer labelHeight)Examples
NSUserDefinedFieldInfo thing;
Integer labelHeight;
thing.SetLabelHeight(labelHeight);Parameters
| Type | Name | Description |
| Integer | labelHeight | label height in pixels, 0 = 'enough' (from font). |
Returns
| Type | Description |
| Void |
SetLabelLeft(Integer)
Declaration
Void SetLabelLeft(Integer labelLeft)Examples
NSUserDefinedFieldInfo thing;
Integer labelLeft;
thing.SetLabelLeft(labelLeft);Parameters
| Type | Name | Description |
| Integer | labelLeft | X pixel coordinate of label. |
Returns
| Type | Description |
| Void |
SetLabelTop(Integer)
Declaration
Void SetLabelTop(Integer labelTop)Examples
NSUserDefinedFieldInfo thing;
Integer labelTop;
thing.SetLabelTop(labelTop);Parameters
| Type | Name | Description |
| Integer | labelTop | Y pixel coordinate of label. |
Returns
| Type | Description |
| Void |
SetLabelWidth(Integer)
Declaration
Void SetLabelWidth(Integer labelWidth)Examples
NSUserDefinedFieldInfo thing;
Integer labelWidth;
thing.SetLabelWidth(labelWidth);Parameters
| Type | Name | Description |
| Integer | labelWidth | label width in pixels, 0 = 'enough' (from font). |
Returns
| Type | Description |
| Void |
SetLastVersionId(Integer)
Declaration
Void SetLastVersionId(Integer lastVersionId)Examples
NSUserDefinedFieldInfo thing;
Integer lastVersionId;
thing.SetLastVersionId(lastVersionId);Parameters
| Type | Name | Description |
| Integer | lastVersionId | UDefFieldId this field had in the previous version, 0 = field is new in this version. |
Returns
| Type | Description |
| Void |
SetListTableId(Integer)
Declaration
Void SetListTableId(Integer listTableId)Examples
NSUserDefinedFieldInfo thing;
Integer listTableId;
thing.SetListTableId(listTableId);Parameters
| Type | Name | Description |
| Integer | listTableId | The table ID of the source table for lists kTableAssoc, kTableContInt or whatever. |
Returns
| Type | Description |
| Void |
SetMdoListName(String)
Declaration
Void SetMdoListName(String mdoListName)Examples
NSUserDefinedFieldInfo thing;
String mdoListName;
thing.SetMdoListName(mdoListName);Parameters
| Type | Name | Description |
| String | mdoListName | MDO list name used to populate this list. Derived from UDListDefinitionId and ListTableId. (Read-only). |
Returns
| Type | Description |
| Void |
SetOwnerTableId(Integer)
Declaration
Void SetOwnerTableId(Integer id)Parameters
| Type | Name | Description |
| Integer | id | ID of owning table (contact, person, project). |
Returns
| Type | Description |
| Void |
SetPage1LineNo(Integer)
Declaration
Void SetPage1LineNo(Integer page1LineNo)Examples
NSUserDefinedFieldInfo thing;
Integer page1LineNo;
thing.SetPage1LineNo(page1LineNo);Parameters
| Type | Name | Description |
| Integer | page1LineNo | Line no on View Page 1, used if MDO flags are OFF. 0 = this field is not visible on page 1 |
Returns
| Type | Description |
| Void |
SetProgId(String)
Declaration
Void SetProgId(String progId)Examples
NSUserDefinedFieldInfo thing;
String progId;
thing.SetProgId(progId);Parameters
| Type | Name | Description |
| String | progId | Programmatic ID, for use by software that needs to find a particular field. Carried over like udefIdentity across generations. |
Returns
| Type | Description |
| Void |
SetShortLabel(String)
Declaration
Void SetShortLabel(String shortLabel)Examples
NSUserDefinedFieldInfo thing;
String shortLabel;
thing.SetShortLabel(shortLabel);Parameters
| Type | Name | Description |
| String | shortLabel | Short name to be used in Archive headings and on page 1. If blank, the fieldLabel will be used everywhere. |
Returns
| Type | Description |
| Void |
SetTabOrder(Integer)
Declaration
Void SetTabOrder(Integer tabOrder)Examples
NSUserDefinedFieldInfo thing;
Integer tabOrder;
thing.SetTabOrder(tabOrder);Parameters
| Type | Name | Description |
| Integer | tabOrder | Tab order value, sets the field processing sequence. |
Returns
| Type | Description |
| Void |
SetTemplateVariableName(String)
Declaration
Void SetTemplateVariableName(String templateVariableName)Examples
NSUserDefinedFieldInfo thing;
String templateVariableName;
thing.SetTemplateVariableName(templateVariableName);Parameters
| Type | Name | Description |
| String | templateVariableName | Template variable name. |
Returns
| Type | Description |
| Void |
SetTextLength(Integer)
Declaration
Void SetTextLength(Integer textLength)Examples
NSUserDefinedFieldInfo thing;
Integer textLength;
thing.SetTextLength(textLength);Parameters
| Type | Name | Description |
| Integer | textLength | Length (in characters) of a text field, 0 for other types. |
Returns
| Type | Description |
| Void |
SetTooltip(String)
Declaration
Void SetTooltip(String tooltip)Examples
NSUserDefinedFieldInfo thing;
String tooltip;
thing.SetTooltip(tooltip);Parameters
| Type | Name | Description |
| String | tooltip | Optional tooltip text for this field. |
Returns
| Type | Description |
| Void |
SetType(Integer)
Declaration
Void SetType(Integer type)Examples
NSUserDefinedFieldInfo thing;
Integer type;
thing.SetType(type);Parameters
| Type | Name | Description |
| Integer | type | ID of owning table (contact, person, project). See <xref href="CRMScript.NetServer.UDefType" data-throw-if-not-resolved="false"></xref>. |
Returns
| Type | Description |
| Void |
SetUDefFieldId(Integer)
Declaration
Void SetUDefFieldId(Integer uDefFieldId)Examples
NSUserDefinedFieldInfo thing;
Integer uDefFieldId;
thing.SetUDefFieldId(uDefFieldId);Parameters
| Type | Name | Description |
| Integer | uDefFieldId | Primary key. |
Returns
| Type | Description |
| Void |
SetUdefIdentity(Integer)
Declaration
Void SetUdefIdentity(Integer udefIdentity)Examples
NSUserDefinedFieldInfo thing;
Integer udefIdentity;
thing.SetUdefIdentity(udefIdentity);Parameters
| Type | Name | Description |
| Integer | udefIdentity | Unique number used to track field identity across layout changes. |
Returns
| Type | Description |
| Void |
SetUDListDefinitionId(Integer)
Declaration
Void SetUDListDefinitionId(Integer uDListDefinitionId)Examples
NSUserDefinedFieldInfo thing;
Integer uDListDefinitionId;
thing.SetUDListDefinitionId(uDListDefinitionId);Parameters
| Type | Name | Description |
| Integer | uDListDefinitionId | List to use for populating dropdown or listbox. |
Returns
| Type | Description |
| Void |
SetVersion(Integer)
Declaration
Void SetVersion(Integer version)Examples
NSUserDefinedFieldInfo thing;
Integer version;
thing.SetVersion(version);Parameters
| Type | Name | Description |
| Integer | version | Definition version number; ALL fields get new version whenever layout is updated. |
Returns
| Type | Description |
| Void |