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