Class SystemConfiguration

Namespace

Dynamicweb.Configuration

Assembly

Dynamicweb.Core.dll

Provides access to all settings in GlobalSettings.aspx and .config files located in the /Files folder. Uses the XmlConfigurationProvider to return values from settings stored in xml files.

public class SystemConfiguration : ConfigurationManager

Inheritance

object

ConfigurationManager

SystemConfiguration

Inherited Members

ConfigurationManager.AddProvider(IConfigurationProvider)

ConfigurationManager.AddProviderPriority(IConfigurationProvider)

ConfigurationManager.GetValue(string)

ConfigurationManager.GetBoolean(string)

ConfigurationManager.GetInt32(string)

ConfigurationManager.GetDouble(string)

ConfigurationManager.TryGet<T>(string, out T)

ConfigurationManager.SetValue<T>(string, T)

ConfigurationManager.SetValue(Dictionary<string, string>)

ConfigurationManager.Contains(string)

ConfigurationManager.GetKeys()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ConfigurationManagerXmlExtensions.AddXml(ConfigurationManager, string)

ConfigurationManagerXmlExtensions.AddXmlFile(ConfigurationManager, string)

ConfigurationExtensions.GetFailureBanInterval(SystemConfiguration?)

ConfigurationExtensions.GetNotificationEmails(SystemConfiguration?)

ConfigurationExtensions.GetRetryCount(SystemConfiguration?)

ConfigurationExtensions.IsNotificationsActive(SystemConfiguration?)

Examples

namespace Dynamicweb.Configuration.Examples;

public static class ConfigurationSample
{
    public static void Configure()
    {
        // Setting a configuration value
        SystemConfiguration.Instance.SetValue("/Globalsettings/Modules/MyModule/Feature", true);

        // Getting a configuration setting as a string value
        string dbserver = SystemConfiguration.Instance.GetValue("/Globalsettings/System/Database/Server");

        // Getting a configuration setting as an integer value
        int maxAttempts = SystemConfiguration.Instance.GetInt32("/Globalsettings/Modules/MyModule/MaxAttempts");

        // Getting a configuration setting as a boolean value
        bool useFeature = SystemConfiguration.Instance.GetBoolean("/Globalsettings/Modules/MyModule/UseFeature");

        // Getting a configuration setting using TryGet
        if (SystemConfiguration.Instance.TryGet("/Globalsettings/Modules/MyModule/ApiKey", out string? apiKey))
        {
            if (!string.IsNullOrEmpty(apiKey))
            {

            }
        }
    }
}

Properties

Instance

Gets the current instance of the system configuration manager with data loaded from configuration files.

public static SystemConfiguration Instance { get; }

Property Value

SystemConfiguration

Remarks

Please try to avoid using this method and instance inject SystemConfiguration as a dependency or use Current to resolve it.

Methods

Reset()

Resets the system configuration instance and reloads settings from configuration files.

public static void Reset()

Remarks

Please try to avoid using this method and instance inject SystemConfiguration as a dependency or use Current to resolve it.