FieldMapping

FieldMapping

protected FieldMapping(string name, Func<string> getDisplayName, Func<string> getDescription, Type type)

fieldMapping = FieldMapping(name, getDisplayName, getDescription, type)

Initializes a new instance of the FieldMapping.

name

Name.

getDisplayName

Display name.

getDescription

Description.

type

Field type.

AdapterType

public Type AdapterType { get; set; }

value = fieldMapping.AdapterType
fieldMapping.AdapterType = value

Adapter.

DefaultValue

public string DefaultValue { get; set; }

value = fieldMapping.DefaultValue
fieldMapping.DefaultValue = value

Default value.

Description

public string Description { get; }

value = fieldMapping.Description

Description.

DisplayName

public string DisplayName { get; }

value = fieldMapping.DisplayName

Display name.

Format

public string Format { get; set; }

value = fieldMapping.Format
fieldMapping.Format = value

Date format.

IsAdapter

public bool IsAdapter { get; set; }

value = fieldMapping.IsAdapter
fieldMapping.IsAdapter = value

AdapterType required.

IsEnabled

public bool IsEnabled { get; set; }

value = fieldMapping.IsEnabled
fieldMapping.IsEnabled = value

Is field enabled.

IsExtended

public bool IsExtended { get; set; }

value = fieldMapping.IsExtended
fieldMapping.IsExtended = value

Is field extended.

IsMultiple

public bool IsMultiple { get; }

value = fieldMapping.IsMultiple

Multiple field's instancies allowed.

IsRequired

public bool IsRequired { get; set; }

value = fieldMapping.IsRequired
fieldMapping.IsRequired = value

Is field required.

Name

public string Name { get; private set; }

value = fieldMapping.Name
fieldMapping.Name = value

Name.

Order

public int? Order { get; set; }

value = fieldMapping.Order
fieldMapping.Order = value

Field order.

Type

public Type Type { get; }

value = fieldMapping.Type

Field type.

Values

public IEnumerable<FieldMappingValue> Values { get; set; }

value = fieldMapping.Values
fieldMapping.Values = value

Mapping values.

ZeroAsNull

public bool ZeroAsNull { get; set; }

value = fieldMapping.ZeroAsNull
fieldMapping.ZeroAsNull = value

Zero as .

ApplyDefaultValue

public void ApplyDefaultValue(object instance)

fieldMapping.ApplyDefaultValue(instance)

Apply default value.

instance

Instance.

ApplyFileValue

public void ApplyFileValue(object instance, string value)

fieldMapping.ApplyFileValue(instance, value)

Apply value.

instance

Instance.

value

Field value.

Clone

public abstract object Clone()

result = fieldMapping.Clone()

Creates a new object that is a deep copy of the current instance.

Returns: A new object that is a deep copy of this instance.

CopyTo

protected void CopyTo(FieldMapping destination)

fieldMapping.CopyTo(destination)

Copy the settings into .

destination

The field that receives the settings.

GetOrClone

public FieldMapping GetOrClone()

result = fieldMapping.GetOrClone()

Get FieldMapping instance or clone dependent on IsMultiple.

Returns: Field.

LoadAsync

public Task LoadAsync(SettingsStorage storage, CancellationToken cancellationToken)

result = fieldMapping.LoadAsync(storage, cancellationToken)

Load settings.

storage

Settings storage.

cancellationToken

CancellationToken

Returns: Task

OnApply

protected abstract void OnApply(object instance, object value)

fieldMapping.OnApply(instance, value)

Apply value.

instance

Instance.

value

Field value.

Reset

public void Reset()

fieldMapping.Reset()

Reset state.

ToString

public override string ToString()

result = fieldMapping.ToString()

Returns a string representation of the tuple, with values separated by commas.

Returns: A string representing the tuple's values.

GetDescription

protected readonly Func<string> GetDescription

value = fieldMapping.GetDescription

Description.

GetDisplayName

protected readonly Func<string> GetDisplayName

value = fieldMapping.GetDisplayName

Display name.