Skip to main content

​
Class FieldMetadata

Namespace: SuperOffice.WebApi.Data
Assembly: SuperOffice.WebApi.dll Carrier object for FieldMetadata. This is 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

​
Inheritance

object ← Carrier ← FieldMetadata

​
Inherited Members

Carrier.TableRight, Carrier.FieldProperties, object.ToString(), object.Equals(object), object.Equals(object, object), object.ReferenceEquals(object, object), object.GetHashCode(), object.GetType(), object.MemberwiseClone()

​
Constructors

​
FieldMetadata()

Default constructor - defaults any enum props to 0.

​
Properties

​
Access

Access restrictions on the field NULL if unknown enum value.

​
Property Value

FieldAccess?

​
See Also

FieldMetadata.Access_String

​
Access_String

Access restrictions on the field Raw string enum value.

​
Property Value

string

​
See Also

FieldMetadata.Access

​
DefaultValue

A default value for the field.

​
Property Value

string

​
DisplayDescription

Tooltip for the field name.

​
Property Value

string

​
DisplayName

Localized field name – shown in the GUI

​
Property Value

string

​
FieldKey

Internal key/name of the field. Used as the key in the ConnectionConfigField values when TestConnection is called.

​
Property Value

string

​
FieldType

String, int, decimal, etc. NULL if unknown enum value.

​
Property Value

FieldMetadataType?

​
See Also

FieldMetadata.FieldType_String

​
FieldType_String

String, int, decimal, etc. Raw string enum value.

​
Property Value

string

​
See Also

FieldMetadata.FieldType

​
ListName

MDO List provider name for list fields

​
Property Value

string

​
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.)

​
Property Value

int

​
Rank

A way to set the order of the fields. Lowest value will be displayed first/over the fields with other values.

​
Property Value

int

​
ShowInSearch

True if this field is displayed in search result

​
Property Value

bool

​
See Also

QuoteAgent

Related topics

WebAPI changes in SuperOffice 12.1WebAPI changes in SuperOffice 12.2SuperOffice WebApiWebAPI changes in SuperOffice 12.0How to use SuperOffice.WebApiHow to create a user-defined field using the web services APIHow to update a user-defined field using the web services API