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.

Introduced or updated in version: 8.5R08

Declaration

NSFieldInfoBase

Methods

GetDescription()

Introduced or updated in version: 8.5R08

Declaration

String GetDescription()

Returns

Type	Description
String	Optional tooltip text for this field.

Examples

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

GetDisplayName()

Introduced or updated in version: 8.5R08

Declaration

String GetDisplayName()

Returns

Type	Description
String	Label for field. May be multi-lang string encoded.

Examples

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

GetFieldName()

Introduced or updated in version: 8.5R08

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()

Introduced or updated in version: 8.5R08

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()

Introduced or updated in version: 8.5R08

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()

Introduced or updated in version: 8.5R08

Declaration

Bool GetHideLabel()

Returns

Type	Description
Bool	Hide the label if 1

Examples

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

GetIsExternal()

Introduced or updated in version: 8.5R08

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()

Introduced or updated in version: 8.5R08

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()

Introduced or updated in version: 8.5R08

Declaration

Bool GetIsMandatory()

Returns

Type	Description
Bool	0 = no, 1 = yes (field must be filled out).

Examples

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

GetIsReadOnly()

Introduced or updated in version: 8.5R08

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()

Introduced or updated in version: 8.5R08

Declaration

Integer GetRank()

Returns

Type	Description
Integer	Tab order, ranking within the custom fields.

Examples

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

GetShortLabel()

Introduced or updated in version: 8.5R08

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()

Introduced or updated in version: 8.5R08

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)

Introduced or updated in version: 8.5R08

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)

Introduced or updated in version: 8.5R08

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)

Introduced or updated in version: 8.5R08

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)

Introduced or updated in version: 8.5R08

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)

Introduced or updated in version: 8.5R08

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)

Introduced or updated in version: 8.5R08

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)

Introduced or updated in version: 8.5R08

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)

Introduced or updated in version: 8.5R08

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)

Introduced or updated in version: 8.5R08

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)

Introduced or updated in version: 8.5R08

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)

Introduced or updated in version: 8.5R08

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)

Introduced or updated in version: 8.5R08

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)

Introduced or updated in version: 8.5R08

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);