DataWeb
Search Results for

    Show / Hide Table of Contents

    Interface IConfigurationService

    Defines the contract for retrieving configuration settings.

    Namespace: DataWeb.Configuration
    Assembly: DataWeb.Core.dll
    Syntax
    public interface IConfigurationService

    Methods

    GetAppSetting(string)

    Retrieves a specific application setting value from the AppSettings configuration section by its key name.

    Declaration
    string GetAppSetting(string name)
    Parameters
    Type Name Description
    string name

    The key name of the application setting within the AppSettings section.

    Returns
    Type Description
    string

    The string value of the application setting, or null if the key does not exist.

    GetAppSetting<T>(string)

    Retrieves a specific application setting value from the AppSettings configuration section by its key name.

    Declaration
    T GetAppSetting<T>(string name)
    Parameters
    Type Name Description
    string name

    The key name of the application setting within the AppSettings section.

    Returns
    Type Description
    T

    The value of the application setting converted to T, or the default value of T if the key does not exist.

    Type Parameters
    Name Description
    T

    The type to convert the configuration value to.

    GetAppSettings()

    Retrieves the application settings.

    Declaration
    ConfigurationAppSettings GetAppSettings()
    Returns
    Type Description
    ConfigurationAppSettings

    A ConfigurationAppSettings instance containing the application settings.

    GetSection(string)

    Retrieves a specific configuration section by its full hierarchical key name.

    Declaration
    IConfigurationSection GetSection(string fullName)
    Parameters
    Type Name Description
    string fullName

    The full hierarchical key of the configuration section (e.g., "MySection:SubSection").

    Returns
    Type Description
    IConfigurationSection

    The IConfigurationSection for the specified key. The section may be empty if the key does not exist.

    GetSetting(string)

    Retrieves a specific configuration setting value by its full key name.

    Declaration
    string GetSetting(string fullName)
    Parameters
    Type Name Description
    string fullName

    The full hierarchical key of the configuration setting (e.g., "MySection:MyKey").

    Returns
    Type Description
    string

    The string value of the configuration setting, or null if the key does not exist.

    GetSetting<T>(string)

    Retrieves a specific configuration setting value by its full key name.

    Declaration
    T GetSetting<T>(string fullName)
    Parameters
    Type Name Description
    string fullName

    The full hierarchical key of the configuration setting (e.g., "MySection:MyKey").

    Returns
    Type Description
    T

    The value of the configuration setting converted to T, or the default value of T if the key does not exist.

    Type Parameters
    Name Description
    T

    The type to convert the configuration value to.

    In this article
    Back to top Generated by DocFX