CapyKit/Docs/api/CapyKit.Helpers.SettingsHelper.md

Class SettingsHelper

Namespace: CapyKit.Helpers
Assembly: CapyKit.dll

Static class containing helper methods for retrieving and setting application settings.

public static class SettingsHelper

Inheritance

object ← SettingsHelper

Inherited Members

object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object?, object?), object.ToString()

Extension Methods

ObjectExtensions.UpdateProperties(object, object)

Examples

This example demonstrates how to set up the SettingsHelper class with custom accessor and detector methods that read from an App.config file. The setup is done at the beginning of the application execution, before any other usage of the helper methods.

public int main(string[] args)
{
   // Set up SettingsHelper with custom accessor and detector methods
   Func<string, object> accessor = (key) =>
   {
       Configuration config = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None);
       return config.AppSettings.Settings[key].Value;
   };

   Func<string, bool> detector = (key) =>
   {
       Configuration config = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None);
       return config.AppSettings.Settings.AllKeys.Contains(key);
   };

   SettingsHelper.SetAccessorMethod(accessor);
   SettingsHelper.SetDetectorMethod(detector);

   // Use the helper to retrieve and set settings
   SettingsHelper.SetApplicationSetting<int>("MySettingKey", 42);
   int newSetting = SettingsHelper.GetApplicationSetting<int>("MySettingKey");
   Console.WriteLine("New setting: {0}", newSetting);

   int mySetting = SettingsHelper.GetApplicationSetting<int>("MySettingKey");
   Console.WriteLine("Retrieved setting: {0}", mySetting);
}

Remarks

The specific means of accessing and storing the settings are determined by the consumer, allowing for flexibility in various environments such as App.config or Web.config .

Methods

GetApplicationSetting<T>string

Retrieves a setting with the given key.

public static T GetApplicationSetting<T>(string settingName)

Parameters

settingName string

The name of the setting to retrieve.

Returns

T

The value of the setting as an uncast T.

Type Parameters

T

The type of the setting to be retrieved.

SetAccessorMethod(Func<string, object>)

Sets the function used to retrieve application settings.

public static void SetAccessorMethod(Func<string, object> accessor)

Parameters

accessor Func<string, object>

The new function used to retrieve application settings.

Exceptions

ArgumentNullException

Thrown when one or more required arguments are null.

SetDetectorMethod(Func<string, bool>)

Sets the function used to detect if an application setting with a given key exists.

public static void SetDetectorMethod(Func<string, bool> detector)

Parameters

detector Func<string, bool>

The new function used to detect if an application setting exists.

Exceptions

ArgumentNullException

Thrown when one or more required arguments are null.