Class FieldMetadataInfo

This carrier describes a custom field to be added to the config dialog at runtime. It is used to populate the Admin configuration dialog for a connection. Note that this is just a description of the field - it is not the field itself. The GUI will use this info to build the user interface controls. 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
FieldMetadataInfo
Inherited Members
Namespace: SuperOffice.CRM
Assembly: SuperOffice.Plugins.dll
Syntax
public class FieldMetadataInfo

Constructors

FieldMetadataInfo()

This carrier describes a custom field to be added to the config dialog at runtime. It is used to populate the Admin configuration dialog for a connection. Note that this is just a description of the field - it is not the field itself. The GUI will use this info to build the user interface controls. 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.

Declaration
public FieldMetadataInfo()

Properties

Access

Access restrictions on the field

Declaration
public FieldAccessInfo Access { get; set; }
Property Value
Type Description
FieldAccessInfo

DefaultValue

A default value for the field. The value in the widget when the configure dialog is opened in Add Connection mode. This will vary a bit depending on the type, of course. Obviously, if the field is a label, text or password, then the text is used. If the field is an int or double, we shall try to convert the string into a number. (If the conversion fails, we shall use zero or 0.00 as the default value.) If the field is a list, we shall try to find a list item where the fields default value matches the listsitem’s ERPQuoteListItemKey.

Declaration
public string DefaultValue { get; set; }
Property Value
Type Description
string

DisplayDescription

Tooltip for the field name.

Declaration
public string DisplayDescription { get; set; }
Property Value
Type Description
string

DisplayName

Localized field name – shown in the GUI as the label for the control.

Declaration
public string DisplayName { get; set; }
Property Value
Type Description
string

FieldKey

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

Declaration
public string FieldKey { get; set; }
Property Value
Type Description
string

FieldType

Kind of field widget to use: textbox, number field, password field, dropdown list or checkbox?

Declaration
public FieldMetadataTypeInfo FieldType { get; set; }
Property Value
Type Description
FieldMetadataTypeInfo

ListName

Used for getting the list items from the list provider. The source of the items must ultimately be exposed via GetQuoteList(string) or GetList(Guid, string), through various naming conventions and adapters. The actual Quote and ERP Connectors solve this in slightly different ways.

Declaration
public string ListName { get; set; }
Property Value
Type Description
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)

Declaration
public int MaxLength { get; set; }
Property Value
Type Description
int

Rank

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

Declaration
public int Rank { get; set; }
Property Value
Type Description
int

Methods

ToString()

Override: Useful ToString for debugging

Declaration
public override string ToString()
Returns
Type Description
string
Overrides

Extension Methods