NSFieldMetadata - SuperOffice

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

NSFieldMetadata

Initializes a new instance of the NSFieldMetadata class.

Methods

GetAccess()

Integer GetAccess()

Returns: CRMScript.Global.Integer - Access restrictions on the field. See <xref href=“CRMScript.NetServer.FieldAccess” data-throw-if-not-resolved=“false”></xref> Example:

NSFieldMetadata thing;
Integer access = thing.GetAccess();

GetDefaultValue()

String GetDefaultValue()

Returns: CRMScript.Global.String - A default value for the field. Example:

NSFieldMetadata thing;
String defaultValue = thing.GetDefaultValue();

GetDisplayDescription()

String GetDisplayDescription()

Returns: CRMScript.Global.String - Tooltip for the field name. Example:

NSFieldMetadata thing;
String displayDescription = thing.GetDisplayDescription();

GetDisplayName()

String GetDisplayName()

Returns: CRMScript.Global.String - Localized field name – shown in the GUi. Example:

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

GetFieldKey()

String GetFieldKey()

Returns: CRMScript.Global.String - Internal key/name of the field. Used as the key in the ConnectionConfigField values when TestConnection is called. Example:

NSFieldMetadata thing;
String fieldKey = thing.GetFieldKey();

GetFieldType()

Integer GetFieldType()

Returns: CRMScript.Global.Integer - Text, Integer, etc. See <xref href=“CRMScript.NetServer.FieldMetadataType” data-throw-if-not-resolved=“false”></xref>. Example:

NSFieldMetadata thing;
Integer fieldType = thing.GetFieldType();

GetListName()

String GetListName()

Returns: CRMScript.Global.String - MDO List provider name for list fields. Example:

NSFieldMetadata thing;
String listName = thing.GetListName();

GetMaxLength()

Integer GetMaxLength()

Returns: CRMScript.Global.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.). Example:

NSFieldMetadata thing;
Integer maxLength = thing.GetMaxLength();

GetRank()

Integer GetRank()

Returns: CRMScript.Global.Integer - A way to set the order of the fields. Lowest value will be displayed first/over the fields with other values. Example:

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

GetShowInSearch()

Bool GetShowInSearch()

Returns: CRMScript.Global.Bool - True if this field is displayed in search result. Example:

NSFieldMetadata thing;
Bool showInSearch = thing.GetShowInSearch();

SetAccess(Integer)

Void SetAccess(Integer access)

Returns: CRMScript.Global.Void Example:

NSFieldMetadata thing;
Integer access;
thing.SetAccess(access);

SetDefaultValue(String)

Void SetDefaultValue(String defaultValue)

Returns: CRMScript.Global.Void Example:

NSFieldMetadata thing;
String defaultValue;
thing.SetDefaultValue(defaultValue);

SetDisplayDescription(String)

Void SetDisplayDescription(String displayDescription)

Returns: CRMScript.Global.Void Example:

NSFieldMetadata thing;
String displayDescription;
thing.SetDisplayDescription(displayDescription);

SetDisplayName(String)

Void SetDisplayName(String displayName)

Returns: CRMScript.Global.Void Example:

NSFieldMetadata thing;
String displayName;
thing.SetDisplayName(displayName);

SetFieldKey(String)

Void SetFieldKey(String fieldKey)

Returns: CRMScript.Global.Void Example:

NSFieldMetadata thing;
String fieldKey;
thing.SetFieldKey(fieldKey);

SetFieldType(Integer)

Void SetFieldType(Integer fieldType)

Returns: CRMScript.Global.Void Example:

NSFieldMetadata thing;
Integer fieldType;
thing.SetFieldType(fieldType);

SetListName(String)

Void SetListName(String listName)

Returns: CRMScript.Global.Void Example:

NSFieldMetadata thing;
String listName;
thing.SetListName(listName);

SetMaxLength(Integer)

Void SetMaxLength(Integer maxLength)

Returns: CRMScript.Global.Void Example:

NSFieldMetadata thing;
Integer maxLength;
thing.SetMaxLength(maxLength);

SetRank(Integer)

Void SetRank(Integer rank)

Returns: CRMScript.Global.Void Example:

NSFieldMetadata thing;
Integer rank;
thing.SetRank(rank);

SetShowInSearch(Bool)

Void SetShowInSearch(Bool showInSearch)

Returns: CRMScript.Global.Void Example:

NSFieldMetadata thing;
Bool showInSearch;
thing.SetShowInSearch(showInSearch);

​Constructors

​NSFieldMetadata()

​Methods

​GetAccess()

​GetDefaultValue()

​GetDisplayDescription()

​GetDisplayName()

​GetFieldKey()

​GetFieldType()

​GetListName()

​GetMaxLength()

​GetRank()

​GetShowInSearch()

​SetAccess(Integer)

​SetDefaultValue(String)

​SetDisplayDescription(String)

​SetDisplayName(String)

​SetFieldKey(String)

​SetFieldType(Integer)

​SetListName(String)

​SetMaxLength(Integer)

​SetRank(Integer)

​SetShowInSearch(Bool)

Constructors

NSFieldMetadata()

Methods

GetAccess()

GetDefaultValue()

GetDisplayDescription()

GetDisplayName()

GetFieldKey()

GetFieldType()

GetListName()

GetMaxLength()

GetRank()

GetShowInSearch()

SetAccess(Integer)

SetDefaultValue(String)

SetDisplayDescription(String)

SetDisplayName(String)

SetFieldKey(String)

SetFieldType(Integer)

SetListName(String)

SetMaxLength(Integer)

SetRank(Integer)

SetShowInSearch(Bool)