Class NSFieldInfoBase
Abstract basic information about database fields. May be custom or user-defined fields. The information can be used to build a user interface.
Syntax
Constructors
NSFieldInfoBase()
Initializes a new instance of the NSFieldInfoBase class.
Declaration
NSFieldInfoBaseMethods
GetDescription()
Abstract basic information about database fields. May be custom or user-defined fields. The information can be used to build a user interface.
Declaration
String GetDescription()Returns
| Type | Description |
|---|---|
| String | Optional tooltip text for this field. |
Examples
NSFieldInfoBase thing;
String description = thing.GetDescription();GetDisplayName()
Abstract basic information about database fields. May be custom or user-defined fields. The information can be used to build a user interface.
Declaration
String GetDisplayName()Returns
| Type | Description |
|---|---|
| String | Label for field. May be multi-lang string encoded. |
Examples
NSFieldInfoBase thing;
String displayName = thing.GetDisplayName();GetFieldName()
Abstract basic information about database fields. May be custom or user-defined fields. The information can be used to build a user interface.
Declaration
String GetFieldName()Returns
| Type | Description |
|---|---|
| String | Database name or prog-id 'x_foobar' or 'SuperOffice:2'. |
Examples
NSFieldInfoBase thing;
String fieldName = thing.GetFieldName();GetFieldType()
Abstract basic information about database fields. May be custom or user-defined fields. The information can be used to build a user interface.
Declaration
Integer GetFieldType()Returns
| Type | Description |
|---|---|
| Integer | What sort of data does this field contain. See FieldMetadataType. |
Examples
NSFieldInfoBase thing;
Integer fieldType = thing.GetFieldType();GetHideField()
Abstract basic information about database fields. May be custom or user-defined fields. The information can be used to build a user interface.
Declaration
Bool GetHideField()Returns
| Type | Description |
|---|---|
| Bool | Hide the field from the UI. Only allow API access. |
Examples
NSFieldInfoBase thing;
Bool hideField = thing.GetHideField();GetHideLabel()
Abstract basic information about database fields. May be custom or user-defined fields. The information can be used to build a user interface.
Declaration
Bool GetHideLabel()Returns
| Type | Description |
|---|---|
| Bool | Hide the label if 1 |
Examples
NSFieldInfoBase thing;
Bool hideLabel = thing.GetHideLabel();GetIsExternal()
Abstract basic information about database fields. May be custom or user-defined fields. The information can be used to build a user interface.
Declaration
Bool GetIsExternal()Returns
| Type | Description |
|---|---|
| Bool | Should this field be shown to external users via customer center? |
Examples
NSFieldInfoBase thing;
Bool isExternal = thing.GetIsExternal();GetIsIndexed()
Abstract basic information about database fields. May be custom or user-defined fields. The information can be used to build a user interface.
Declaration
Bool GetIsIndexed()Returns
| Type | Description |
|---|---|
| Bool | Is this field indexed? true if yes; false if no. |
Examples
NSFieldInfoBase thing;
Bool isIndexed = thing.GetIsIndexed();GetIsMandatory()
Abstract basic information about database fields. May be custom or user-defined fields. The information can be used to build a user interface.
Declaration
Bool GetIsMandatory()Returns
| Type | Description |
|---|---|
| Bool | 0 = no, 1 = yes (field must be filled out). |
Examples
NSFieldInfoBase thing;
Bool isMandatory = thing.GetIsMandatory();GetIsReadOnly()
Abstract basic information about database fields. May be custom or user-defined fields. The information can be used to build a user interface.
Declaration
Bool GetIsReadOnly()Returns
| Type | Description |
|---|---|
| Bool | 0 = read/write, 1 = readonly (don't combine with mandatory). |
Examples
NSFieldInfoBase thing;
Bool isReadOnly = thing.GetIsReadOnly();GetRank()
Abstract basic information about database fields. May be custom or user-defined fields. The information can be used to build a user interface.
Declaration
Integer GetRank()Returns
| Type | Description |
|---|---|
| Integer | Tab order, ranking within the custom fields. |
Examples
NSFieldInfoBase thing;
Integer rank = thing.GetRank();GetShortLabel()
Abstract basic information about database fields. May be custom or user-defined fields. The information can be used to build a 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
NSFieldInfoBase thing;
String shortLabel = thing.GetShortLabel();GetTemplateVariableName()
Abstract basic information about database fields. May be custom or user-defined fields. The information can be used to build a user interface.
Declaration
String GetTemplateVariableName()Returns
| Type | Description |
|---|---|
| String | Template variable name 'cs01', 'cl02' etc. Null for extra fields. |
Examples
NSFieldInfoBase thing;
String templateVariableName = thing.GetTemplateVariableName();SetDescription(String)
Abstract basic information about database fields. May be custom or user-defined fields. The information can be used to build a user interface.
Declaration
Void SetDescription(String description)Parameters
| Type | Name | Description |
|---|---|---|
| String | description | Optional tooltip text for this field. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSFieldInfoBase thing;
String description;
thing.SetDescription(description);SetDisplayName(String)
Abstract basic information about database fields. May be custom or user-defined fields. The information can be used to build a user interface.
Declaration
Void SetDisplayName(String displayName)Parameters
| Type | Name | Description |
|---|---|---|
| String | displayName | Label for field. May be multi-lang string encoded. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSFieldInfoBase thing;
String displayName;
thing.SetDisplayName(displayName);SetFieldName(String)
Abstract basic information about database fields. May be custom or user-defined fields. The information can be used to build a user interface.
Declaration
Void SetFieldName(String fieldName)Parameters
| Type | Name | Description |
|---|---|---|
| String | fieldName | Database name or prog-id 'x_foobar' or 'SuperOffice:2'. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSFieldInfoBase thing;
String fieldName;
thing.SetFieldName(fieldName);SetFieldType(Integer)
Abstract basic information about database fields. May be custom or user-defined fields. The information can be used to build a user interface.
Declaration
Void SetFieldType(Integer fieldType)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | fieldType | What sort of data does this field contain. See FieldMetadataType. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSFieldInfoBase thing;
Integer fieldType;
thing.SetFieldType(fieldType);SetHideField(Bool)
Abstract basic information about database fields. May be custom or user-defined fields. The information can be used to build a user interface.
Declaration
Void SetHideField(Bool hideField)Parameters
| Type | Name | Description |
|---|---|---|
| Bool | hideField | Hide the field from the UI. Only allow API access. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSFieldInfoBase thing;
Bool hideField;
thing.SetHideField(hideField);SetHideLabel(Bool)
Abstract basic information about database fields. May be custom or user-defined fields. The information can be used to build a user interface.
Declaration
Void SetHideLabel(Bool hideLabel)Parameters
| Type | Name | Description |
|---|---|---|
| Bool | hideLabel | Hide the label if 1 |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSFieldInfoBase thing;
Bool hideLabel;
thing.SetHideLabel(hideLabel);SetIsExternal(Bool)
Abstract basic information about database fields. May be custom or user-defined fields. The information can be used to build a user interface.
Declaration
Void SetIsExternal(Bool isExternal)Parameters
| Type | Name | Description |
|---|---|---|
| Bool | isExternal | Should this field be shown to external users via customer center? |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSFieldInfoBase thing;
Bool isExternal;
thing.SetIsExternal(isExternal);SetIsIndexed(Bool)
Abstract basic information about database fields. May be custom or user-defined fields. The information can be used to build a 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
NSFieldInfoBase thing;
Bool isIndexed;
thing.SetIsIndexed(isIndexed);SetIsMandatory(Bool)
Abstract basic information about database fields. May be custom or user-defined fields. The information can be used to build a 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
NSFieldInfoBase thing;
Bool isMandatory;
thing.SetIsMandatory(isMandatory);SetIsReadOnly(Bool)
Abstract basic information about database fields. May be custom or user-defined fields. The information can be used to build a 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
NSFieldInfoBase thing;
Bool isReadOnly;
thing.SetIsReadOnly(isReadOnly);SetRank(Integer)
Abstract basic information about database fields. May be custom or user-defined fields. The information can be used to build a user interface.
Declaration
Void SetRank(Integer rank)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | rank | Tab order, ranking within the custom fields. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSFieldInfoBase thing;
Integer rank;
thing.SetRank(rank);SetShortLabel(String)
Abstract basic information about database fields. May be custom or user-defined fields. The information can be used to build a 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
NSFieldInfoBase thing;
String shortLabel;
thing.SetShortLabel(shortLabel);SetTemplateVariableName(String)
Abstract basic information about database fields. May be custom or user-defined fields. The information can be used to build a user interface.
Declaration
Void SetTemplateVariableName(String templateVariableName)Parameters
| Type | Name | Description |
|---|---|---|
| String | templateVariableName | Template variable name 'cs01', 'cl02' etc. Null for extra fields. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSFieldInfoBase thing;
String templateVariableName;
thing.SetTemplateVariableName(templateVariableName);