Class 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
Carrier object for FieldMetadata. Services for the FieldMetadata Carrier is available from the Quote Agent.Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
[DataContract(Namespace = "http://www.superoffice.net/ws/crm/NetServer/11.1.0.0")]
public class FieldMetadata : CarrierConstructors
FieldMetadata()
Default constructor
Declaration
public FieldMetadata()See Also
Properties
Access
Access restrictions on the field
Declaration
[DataMember]
public virtual FieldAccess Access { get; set; }Property Value
| Type | Description |
|---|---|
| FieldAccess |
See Also
DefaultValue
A default value for the field.
Declaration
[DataMember]
public virtual string DefaultValue { get; set; }Property Value
| Type | Description |
|---|---|
| string |
See Also
DisplayDescription
Tooltip for the field name.
Declaration
[DataMember]
public virtual string DisplayDescription { get; set; }Property Value
| Type | Description |
|---|---|
| string |
See Also
DisplayName
Localized field name – shown in the GUI
Declaration
[DataMember]
public virtual string DisplayName { get; set; }Property Value
| Type | Description |
|---|---|
| string |
See Also
FieldKey
Internal key/name of the field. Used as the key in the ConnectionConfigField values when TestConnection is called.
Declaration
[DataMember]
public virtual string FieldKey { get; set; }Property Value
| Type | Description |
|---|---|
| string |
See Also
FieldType
String, int, decimal, etc.
Declaration
[DataMember]
public virtual FieldMetadataType FieldType { get; set; }Property Value
| Type | Description |
|---|---|
| FieldMetadataType |
See Also
ListName
MDO List provider name for list fields
Declaration
[DataMember]
public virtual string ListName { get; set; }Property Value
| Type | Description |
|---|---|
| string |
See Also
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.)
Declaration
[DataMember]
public virtual int MaxLength { get; set; }Property Value
| Type | Description |
|---|---|
| int |
See Also
Rank
A way to set the order of the fields. Lowest value will be displayed first/over the fields with other values.
Declaration
[DataMember]
public virtual int Rank { get; set; }Property Value
| Type | Description |
|---|---|
| int |
See Also
ShowInSearch
True if this field is displayed in search result
Declaration
[DataMember]
public virtual bool ShowInSearch { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
See Also
Methods
ToString()
Returns the carrier contents as a formatted string.
Declaration
public override string ToString()Returns
| Type | Description |
|---|---|
| string | The carrier contents. |
See Also
ToString(string)
Returns the carrier contents as a formatted string, useful for debugging. Each line in the output is prefixed with the input value.
Declaration
public string ToString(string prefix)Parameters
| Type | Name | Description |
|---|---|---|
| string | prefix | The line prefix (typically used for indenting) |
Returns
| Type | Description |
|---|---|
| string | The carrier contents. |