Class ConfigFieldAttribute

Attribute to inject metadata about a configuration field, for a Quote or EIS connector. Use on fields with default get/set

Inheritance
object
Attribute
ConfigFieldAttribute
Inherited Members
Namespace: SuperOffice.ErpSync.ConnectorWS
Assembly: SuperOffice.Plugins.dll
Syntax
[AttributeUsage(AttributeTargets.Field)]
public class ConfigFieldAttribute : Attribute

Constructors

ConfigFieldAttribute(string, FieldMetadataTypeInfo)

Mark this field as configuration data. Use optional named fields to initialize values that are not part of the constructor.

Declaration
public ConfigFieldAttribute(string displayName, FieldMetadataTypeInfo type)
Parameters
Type Name Description
string displayName

The name (label) shown in the GUI
FieldMetadataTypeInfo type

The field type, must correspond to the actual type of the member

Properties

Access

The access rights for the field

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

DefaultValue

Contains the default value, if any

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

DisplayDescription

The description shown in the GUI

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

DisplayName

The name (label) shown in the GUI

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

FieldType

The field type, must correspond to the actual type of the member

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

ListName

This will contain the list name if the field is a list

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

MaxLength

Maximum length of the field

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

Rank

The rank (sort order) of the field

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

Extension Methods