Class NSFieldMetadata
Used to populate the Admin configuration dialog for a connection. The call to the ERP Connector’s GetConfigurationFields method returns a list of fields and field types. The Admin client builds a dialog with these fields.
Constructors
NSFieldMetadata()
Initializes a new instance of the NSFieldMetadata class.
Declaration
NSFieldMetadataMethods
GetAccess()
Declaration
Integer GetAccess()Examples
NSFieldMetadata thing;
Integer access = thing.GetAccess();Returns
| Type | Description |
| Integer | Access restrictions on the field. See <xref href="CRMScript.NetServer.FieldAccess" data-throw-if-not-resolved="false"></xref> |
GetDefaultValue()
Declaration
String GetDefaultValue()Examples
NSFieldMetadata thing;
String defaultValue = thing.GetDefaultValue();Returns
| Type | Description |
| String | A default value for the field. |
GetDisplayDescription()
Declaration
String GetDisplayDescription()Examples
NSFieldMetadata thing;
String displayDescription = thing.GetDisplayDescription();Returns
| Type | Description |
| String | Tooltip for the field name. |
GetDisplayName()
Declaration
String GetDisplayName()Examples
NSFieldMetadata thing;
String displayName = thing.GetDisplayName();Returns
| Type | Description |
| String | Localized field name – shown in the GUi. |
GetFieldKey()
Declaration
String GetFieldKey()Examples
NSFieldMetadata thing;
String fieldKey = thing.GetFieldKey();Returns
| Type | Description |
| String | Internal key/name of the field. Used as the key in the ConnectionConfigField values when TestConnection is called. |
GetFieldType()
Declaration
Integer GetFieldType()Examples
NSFieldMetadata thing;
Integer fieldType = thing.GetFieldType();Returns
| Type | Description |
| Integer | Text, Integer, etc. See <xref href="CRMScript.NetServer.FieldMetadataType" data-throw-if-not-resolved="false"></xref>. |
GetListName()
Declaration
String GetListName()Examples
NSFieldMetadata thing;
String listName = thing.GetListName();Returns
| Type | Description |
| String | MDO List provider name for list fields. |
GetMaxLength()
Declaration
Integer GetMaxLength()Examples
NSFieldMetadata thing;
Integer maxLength = thing.GetMaxLength();Returns
| Type | Description |
| Integer | Maximum length for strings, if set. 0 means no restriction. (Though sooner or later something will no doubt overflow if you pile on the gigabytes.). |
GetRank()
Declaration
Integer GetRank()Examples
NSFieldMetadata thing;
Integer rank = thing.GetRank();Returns
| Type | Description |
| Integer | A way to set the order of the fields. Lowest value will be displayed first/over the fields with other values. |
GetShowInSearch()
Declaration
Bool GetShowInSearch()Examples
NSFieldMetadata thing;
Bool showInSearch = thing.GetShowInSearch();Returns
| Type | Description |
| Bool | True if this field is displayed in search result. |
SetAccess(Integer)
Declaration
Void SetAccess(Integer access)Examples
NSFieldMetadata thing;
Integer access;
thing.SetAccess(access);Parameters
| Type | Name | Description |
| Integer | access | Access restrictions on the field. See <xref href="CRMScript.NetServer.FieldAccess" data-throw-if-not-resolved="false"></xref>. |
Returns
| Type | Description |
| Void |
SetDefaultValue(String)
Declaration
Void SetDefaultValue(String defaultValue)Examples
NSFieldMetadata thing;
String defaultValue;
thing.SetDefaultValue(defaultValue);Parameters
| Type | Name | Description |
| String | defaultValue | A default value for the field. |
Returns
| Type | Description |
| Void |
SetDisplayDescription(String)
Declaration
Void SetDisplayDescription(String displayDescription)Examples
NSFieldMetadata thing;
String displayDescription;
thing.SetDisplayDescription(displayDescription);Parameters
| Type | Name | Description |
| String | displayDescription | Tooltip for the field name. |
Returns
| Type | Description |
| Void |
SetDisplayName(String)
Declaration
Void SetDisplayName(String displayName)Examples
NSFieldMetadata thing;
String displayName;
thing.SetDisplayName(displayName);Parameters
| Type | Name | Description |
| String | displayName | Localized field name – shown in the GUi. |
Returns
| Type | Description |
| Void |
SetFieldKey(String)
Declaration
Void SetFieldKey(String fieldKey)Examples
NSFieldMetadata thing;
String fieldKey;
thing.SetFieldKey(fieldKey);Parameters
| Type | Name | Description |
| String | fieldKey | Internal key/name of the field. Used as the key in the ConnectionConfigField values when TestConnection is called. |
Returns
| Type | Description |
| Void |
SetFieldType(Integer)
Declaration
Void SetFieldType(Integer fieldType)Examples
NSFieldMetadata thing;
Integer fieldType;
thing.SetFieldType(fieldType);Parameters
| Type | Name | Description |
| Integer | fieldType | Text, Integer, etc. See <xref href="CRMScript.NetServer.FieldMetadataType" data-throw-if-not-resolved="false"></xref>. |
Returns
| Type | Description |
| Void |
SetListName(String)
Declaration
Void SetListName(String listName)Examples
NSFieldMetadata thing;
String listName;
thing.SetListName(listName);Parameters
| Type | Name | Description |
| String | listName | MDO List provider name for list fields. |
Returns
| Type | Description |
| Void |
SetMaxLength(Integer)
Declaration
Void SetMaxLength(Integer maxLength)Examples
NSFieldMetadata thing;
Integer maxLength;
thing.SetMaxLength(maxLength);Parameters
| Type | Name | Description |
| Integer | maxLength | Maximum length for strings, if set. 0 means no restriction. (Though sooner or later something will no doubt overflow if you pile on the gigabytes.). |
Returns
| Type | Description |
| Void |
SetRank(Integer)
Declaration
Void SetRank(Integer rank)Examples
NSFieldMetadata thing;
Integer rank;
thing.SetRank(rank);Parameters
| Type | Name | Description |
| Integer | rank | A way to set the order of the fields. Lowest value will be displayed first/over the fields with other values. |
Returns
| Type | Description |
| Void |