Class IDictionaryConverter<TValue>

A converter for instances of IDictionary<TKey,TValue>.

Inheritance
Object
ValueConverter<IDictionary<String, TValue>>
IDictionaryConverter<TValue>
IDictionaryConverter<TValue, TConverter>
Implements
Inherited Members
Namespace: IPA.Config.Stores.Converters
Assembly: IPA.Loader.dll
Syntax
public class IDictionaryConverter<TValue> : ValueConverter<IDictionary<string, TValue>>, IValueConverter
Type Parameters
Name Description
TValue

the value type of the dictionary

Constructors

| Improve this Doc View Source

IDictionaryConverter()

Constructs an IDictionaryConverter<TValue> using the default converter for the value type.

Declaration
public IDictionaryConverter()
| Improve this Doc View Source

IDictionaryConverter(ValueConverter<TValue>)

Constructs an IDictionaryConverter<TValue> using the specified converter for the value.

Declaration
public IDictionaryConverter(ValueConverter<TValue> converter)
Parameters
Type Name Description
ValueConverter<TValue> converter

the converter for the value

Properties

| Improve this Doc View Source

BaseConverter

Gets the converter for the dictionary's value type.

Declaration
protected ValueConverter<TValue> BaseConverter { get; }
Property Value
Type Description
ValueConverter<TValue>

Methods

| Improve this Doc View Source

FromValue(Value, Object)

Converts a Map to an IDictionary<TKey,TValue> that is represented by it.

Declaration
public override IDictionary<string, TValue> FromValue(Value value, object parent)
Parameters
Type Name Description
Value value

the Map to convert
Object parent

the parent that will own the resulting object
Returns
Type Description
IDictionary<String, TValue>

the deserialized dictionary
Overrides
IPA.Config.Stores.ValueConverter<System.Collections.Generic.IDictionary<System.String, TValue>>.FromValue(IPA.Config.Data.Value, System.Object)
| Improve this Doc View Source

ToValue(IDictionary<String, TValue>, Object)

Serializes an IDictionary<TKey,TValue> into a Map containing its values.

Declaration
public override Value ToValue(IDictionary<string, TValue> obj, object parent)
Parameters
Type Name Description
IDictionary<String, TValue> obj

the dictionary to serialize
Object parent

the object that owns the dictionary
Returns
Type Description
Value

the dictionary serialized as a Map
Overrides
IPA.Config.Stores.ValueConverter<System.Collections.Generic.IDictionary<System.String, TValue>>.ToValue(System.Collections.Generic.IDictionary<System.String, TValue>, System.Object)

Implements

Extension Methods