Interface ISettings

Namespace

CarinaStudio.Configuration

Assembly

CarinaStudio.AppBase.Configuration.dll

Application settings.

public interface ISettings

Extension Methods

SettingsExtensions.GetValueOrDefault(ISettings?, SettingKey)

SettingsExtensions.GetValueOrDefault<T>(ISettings?, SettingKey<T>)

SettingsExtensions.IsFalse(ISettings, SettingKey<bool>)

SettingsExtensions.IsTrue(ISettings, SettingKey<bool>)

SettingsExtensions.ResetValues(ISettings)

SettingsExtensions.ResetValues(ISettings, IEnumerable<SettingKey>)

SettingsExtensions.SetValue<T>(ISettings, SettingKey<T>, T)

SettingsExtensions.ToggleValue(ISettings, SettingKey<bool>)

SettingsExtensions.ValuesEqual(ISettings, ISettings)

SettingsExtensions.VerifyValue(ISettings, SettingKey)

ObjectExtensions.AddWeakEventHandler<TObject>(TObject, string, Action)

ObjectExtensions.AddWeakEventHandler<TObject>(TObject, string, EventHandler)

ObjectExtensions.AddWeakEventHandler<TObject, TArg>(TObject, string, Action<TArg>)

ObjectExtensions.AddWeakEventHandler<TObject, TArgs>(TObject, string, EventHandler<TArgs>)

ObjectExtensions.AddWeakEventHandler<TObject, TArg1, TArg2>(TObject, string, Action<TArg1, TArg2>)

ObjectExtensions.AddWeakEventHandler<TObject, TArg1, TArg2, TArg3>(TObject, string, Action<TArg1, TArg2, TArg3>)

ObjectExtensions.AlsoAsync<T>(T, Func<T, Task>)

ObjectExtensions.Also<T>(T, Action<T>)

ObjectExtensions.AsNonNull<T>(T?)

ObjectExtensions.LetAsync<T>(T, Func<T, Task>)

ObjectExtensions.LetAsync<T, R>(T, Func<T, Task<R>>)

ObjectExtensions.Let<T>(T, Action<T>)

ObjectExtensions.Let<T, R>(T, RefOutFunc<T, R>)

ObjectExtensions.Let<T, R>(T, Func<T, R>)

ObjectExtensions.LockAsync<T>(T, Func<T, Task>)

ObjectExtensions.LockAsync<T>(T, Func<Task>)

ObjectExtensions.LockAsync<T, R>(T, Func<T, Task<R>>)

ObjectExtensions.LockAsync<T, R>(T, Func<Task<R>>)

ObjectExtensions.Lock<T>(T, Action)

ObjectExtensions.Lock<T>(T, Action<T>)

ObjectExtensions.Lock<T, R>(T, RefOutFunc<T, R>)

ObjectExtensions.Lock<T, R>(T, RefOutFunc<R>)

ObjectExtensions.Lock<T, R>(T, Func<T, R>)

ObjectExtensions.Lock<T, R>(T, Func<R>)

ObjectExtensions.TryCastAndRunAsync<T>(object?, Func<T, Task>)

ObjectExtensions.TryCastAndRunAsync<T, R>(object?, Func<T, Task<R>>)

ObjectExtensions.TryCastAndRun<T>(object?, Action<T>)

ObjectExtensions.TryCastAndRun<T, R>(object?, Func<T, R>)

Properties

Keys

Get all setting keys.

IEnumerable<SettingKey> Keys { get; }

Property Value

IEnumerable<SettingKey>

Version

Get version of settings.

int Version { get; }

Property Value

int

Methods

GetRawValue(SettingKey)

Get raw value stored in settings no matter what type of value specified by key.

object? GetRawValue(SettingKey key)

Parameters

key SettingKey

Key of setting.

Returns

object

Raw setting value.

ResetValue(SettingKey)

Reset setting to default value.

void ResetValue(SettingKey key)

Parameters

key SettingKey

Key of setting.

SetValue(SettingKey, object)

Set value of setting.

[Obsolete("Try using generic SetValue() instead, unless you don't know the type of value.")]
void SetValue(SettingKey key, object value)

Parameters

key SettingKey

Key of setting.

value object

New value.

Events

SettingChanged

Raised after changing setting.

event EventHandler<SettingChangedEventArgs>? SettingChanged

Event Type

EventHandler<SettingChangedEventArgs>

SettingChanging

Raised before changing setting.

event EventHandler<SettingChangingEventArgs>? SettingChanging

Event Type

EventHandler<SettingChangingEventArgs>