Presets<T>

References
[IoId("00000000-7afb-41e0-b4e1-4c489e4646ee")] public sealed class Presets<T> : IPresets
Generic implementation of IPresets.
Type parameters:
T

Constructors

Presets

#
public Presets()
Empty preset constructor.

Presets

#
public Presets(IReader reader)
Parameters:
reader (IReader)

Properties

AllPresets

#
public IEnumerable<Preset<T>> AllPresets { get; }
Enumerate over all name+value pairs.

Count

#
public int Count { get; }
Gets the number of preset values.
Implements: Count
Explicit

IPresets.AllPresets

#
IEnumerable<IPreset> IPresets.AllPresets
Implements: AllPresets

Names

#
public IEnumerable<string> Names { get; }
Enumerate over all names.
Implements: Names

Indexers

Explicit

IPresets.this[]

#
IPreset IPresets.this[int index]
Parameters:
index (int)
Implements: this[]
Explicit

IPresets.this[]

#
IPreset IPresets.this[string name]
Parameters:
name (string)
Implements: this[]

this[]

#
public Preset<T> this[int index] { get; }
Access a specific name+value pair.
Parameters:
index (int)Index of pair.

this[]

#
public Preset<T> this[string name] { get; }
Access a specific value by name.
Parameters:
name (string)Name of value.

Methods

Add

#
public bool Add(Preset<T> preset)
Attempt to add a preset.
Parameters:
preset (Preset<T>)Preset to add.
Returns: True if preset was successfully added.

Add

#
public bool Add(string name, string info, Color tint, T value)
Attempt to add a preset.
Parameters:
name (string)Name of preset.
info (string)Description of preset.
tint (Color)Colour of preset.
value (T)Value of preset.
Returns: True if preset was successfully added.

Add

#
public bool Add(string name, string info, T value)
Attempt to add a preset.
Parameters:
name (string)Name of preset.
info (string)Description of preset.
value (T)Value of preset.
Returns: True if preset was successfully added.

AddEnum<TE>

#
public int AddEnum<TE>()
Add all values from an enum as presets. This will only work if the enum numeric base type is compatible with the T constraint. The values are added under their own name, unless they have a [UiName] attribute.
Returns: Number of added values.

AddEnumByType

#
public int AddEnumByType(Type enumType)
Add all values from an enum as presets. This will only work if the enum numeric base type is compatible with the T constraint. The values are added under their own name, unless they have a [UiName] attribute.
Parameters:
enumType (Type)
Returns: Number of added values.

Clear

#
public void Clear()
Wipe all defined presets.
Implements: Clear

FindByValue

#
public Preset<T> FindByValue(object value)
Attempt to find the name of a value. If the value is of the wrong type or otherwise unknown to this preset collection, null or an empty string may be returned.
Parameters:
value (object)
Explicit

IPresets.FindByValue

#
IPreset IPresets.FindByValue(object value)
Parameters:
value (object)
Implements: FindByValue
Explicit

IPresets.TryCopyFrom

#
int IPresets.TryCopyFrom(IPresets other)
Parameters:
other (IPresets)
Implements: TryCopyFrom

IsAvailable

#
public bool IsAvailable(string name)
Gets whether a specific name is still available and adheres to the naming scheme.
Parameters:
name (string)Name to test.
Returns: True if name hasn't been defined.
Implements: IsAvailable

Store

#
public void Store(IWriter writer)
Parameters:
writer (IWriter)
Implements: Store

TryCopyFrom

#
public int TryCopyFrom(Presets<T> other)
Try and copy all presets from another collection.
Parameters:
other (Presets<T>)
Returns: Number of presets successfully copied.