Search Results for

    Show / Hide Table of Contents
    View Source

    Class ConfigurationExtensions

    Extensions for .

    Inheritance
    System.Object
    Namespace: Umbraco.Extensions
    Assembly: Umbraco.Core.dll
    Syntax
    public static class ConfigurationExtensions

    Methods

    View Source

    GetConnectionStringProviderName(IConfiguration, String)

    Gets the provider name for the connection string name (shorthand for GetSection("ConnectionStrings")[name + "_ProviderName"]).

    Declaration
    public static string GetConnectionStringProviderName(this IConfiguration configuration, string name)
    Parameters
    Type Name Description
    IConfiguration configuration

    The configuration.

    System.String name

    The connection string key.

    Returns
    Type Description
    System.String

    The provider name.

    Remarks

    This uses the same convention as the Configuration API for connection string environment variables.

    View Source

    GetModelsMode(IConfiguration)

    Declaration
    public static ModelsMode GetModelsMode(this IConfiguration configuration)
    Parameters
    Type Name Description
    IConfiguration configuration
    Returns
    Type Description
    ModelsMode
    View Source

    GetRuntimeMode(IConfiguration)

    Gets the Umbraco runtime mode.

    Declaration
    public static RuntimeMode GetRuntimeMode(this IConfiguration configuration)
    Parameters
    Type Name Description
    IConfiguration configuration

    The configuration.

    Returns
    Type Description
    RuntimeMode

    The Umbraco runtime mode.

    View Source

    GetUmbracoConnectionString(IConfiguration, String)

    Gets the Umbraco connection string (shorthand for GetSection("ConnectionStrings")[name] and replacing the |DataDirectory| placeholder).

    Declaration
    public static string GetUmbracoConnectionString(this IConfiguration configuration, string name = "umbracoDbDSN")
    Parameters
    Type Name Description
    IConfiguration configuration

    The configuration.

    System.String name

    The connection string key.

    Returns
    Type Description
    System.String

    The Umbraco connection string.

    View Source

    GetUmbracoConnectionString(IConfiguration, String, out String)

    Gets the Umbraco connection string and provider name (shorthand for GetSection("ConnectionStrings")[name] and replacing the |DataDirectory| placeholder).

    Declaration
    public static string GetUmbracoConnectionString(this IConfiguration configuration, string name, out string providerName)
    Parameters
    Type Name Description
    IConfiguration configuration

    The configuration.

    System.String name

    The name.

    System.String providerName

    The provider name.

    Returns
    Type Description
    System.String

    The Umbraco connection string.

    View Source

    GetUmbracoConnectionString(IConfiguration, out String)

    Gets the Umbraco connection string and provider name (shorthand for GetSection("ConnectionStrings")[Constants.System.UmbracoConnectionName] and replacing the |DataDirectory| placeholder).

    Declaration
    public static string GetUmbracoConnectionString(this IConfiguration configuration, out string providerName)
    Parameters
    Type Name Description
    IConfiguration configuration

    The configuration.

    System.String providerName

    The provider name.

    Returns
    Type Description
    System.String

    The Umbraco connection string.

    • Improve this Doc
    • View Source
    In This Article
    • Methods
      • GetConnectionStringProviderName(IConfiguration, String)
      • GetModelsMode(IConfiguration)
      • GetRuntimeMode(IConfiguration)
      • GetUmbracoConnectionString(IConfiguration, String)
      • GetUmbracoConnectionString(IConfiguration, String, out String)
      • GetUmbracoConnectionString(IConfiguration, out String)
    Back to top Copyright © 2016-present Umbraco
    Generated by DocFX