Reading settings from app.config or web.config in .NET

Question

I'm working on a C# class library that needs to be able to read settings from the web.config or app.config file (depending on whether the DLL is referenced from an ASP.NET web application or a Windows Forms application).

I've found that

ConfigurationSettings.AppSettings.Get("MySetting")

works, but that code has been marked as deprecated by Microsoft.

I've read that I should be using:

ConfigurationManager.AppSettings["MySetting"]

However, the System.Configuration.ConfigurationManager class doesn't seem to be available from a C# Class Library project.

What is the best way to do this?

Like i read 4 MSDN examples and articles.. And landed up here. Just add a reference.. why can't they just say that. Good question! +1 — Piotr Kula
– Piotr Kula, Commented Sep 14, 2012 at 10:18
If you want to write the settings back as well, look here how you can do it. — Matt
– Matt, Commented Jul 17, 2017 at 11:16
Possible duplicate of Pros and cons of AppSettings vs applicationSettings (.NET app.config / Web.config) — Matt
– Matt, Commented Jul 17, 2017 at 11:17

Peter Mortensen · Accepted Answer · 2019-12-27 15:33:02Z

1061

For a sample app.config file like below:

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <appSettings>
    <add key="countoffiles" value="7" />
    <add key="logfilelocation" value="abc.txt" />
  </appSettings>
</configuration>

You read the above application settings using the code shown below:

using System.Configuration;

You may also need to also add a reference to System.Configuration in your project if there isn't one already. You can then access the values like so:

string configvalue1 = ConfigurationManager.AppSettings["countoffiles"];
string configvalue2 = ConfigurationManager.AppSettings["logfilelocation"];

edited Dec 27, 2019 at 15:33

Peter Mortensen

31.4k22 gold badges110 silver badges134 bronze badges

answered Oct 15, 2012 at 8:47

Ram

17.1k5 gold badges51 silver badges42 bronze badges

Sign up to request clarification or add additional context in comments.

9 Comments

Brendan Vogt Over a year ago

I like your answer more than the accepted answer. Answers with examples always do the trick for me.

Spook Over a year ago

@Gigo I guess because it answers questions of people who visit this question (and they may not care about OP's one :))

BrainSlugs83 Over a year ago

@Gigo, it says "You may also need to also add a reference to System.Configuration in your project if there isn't one already." -- That specifically answers the OP's question. Though it's kind of glossed over if you ask me.

BrainSlugs83 Over a year ago

@NightmareGames that's because you didn't add the reference like the answer said to do. If you use ConfigurationSettings instead of ConfigurationManager then you are using an obsolete API. That's the whole point.

Todd Vance Over a year ago

Can someone tell me why they think System.Configuration is not added by default... this seems like a pretty basic need in most applications.

|

DrBeco · Accepted Answer · 2015-06-02 18:25:08Z

896

You'll need to add a reference to System.Configuration in your project's references folder.

You should definitely be using the ConfigurationManager over the obsolete ConfigurationSettings.

edited Jun 2, 2015 at 18:25

DrBeco

11.9k12 gold badges63 silver badges82 bronze badges

answered Jul 27, 2009 at 17:00

womp

117k27 gold badges240 silver badges271 bronze badges

2 Comments

Triynko Over a year ago

Is this still accurate for .net core.

WiiLF Over a year ago

@Triynko You should specify the .NET Core version you have in mind to confirm compatibility, because at this point in time as of this writing.. your looking at .NET Core 3.1, .NET 5 or 6. Also, those reading.. For the note, C# 9 and VS2019 - Program.cs does not need a reference to System.Configuration (unnecessary).

Peter Mortensen · Accepted Answer · 2019-12-27 16:05:50Z

117

Update for .NET Framework 4.5 and 4.6; the following will no longer work:

string keyvalue = System.Configuration.ConfigurationManager.AppSettings["keyname"];

Now access the Setting class via Properties:

string keyvalue = Properties.Settings.Default.keyname;

See Managing Application Settings for more information.

edited Dec 27, 2019 at 16:05

Peter Mortensen

31.4k22 gold badges110 silver badges134 bronze badges

answered Aug 21, 2015 at 18:24

bsivel

2,9715 gold badges28 silver badges32 bronze badges

9 Comments

Nick Westgate Over a year ago

Properties since 2010.

J. Chris Compton Over a year ago

Thanks so much for posting this. I determined that Properties.Settings.Default.MachName worked, but I couldn't figure out why ConfigurationManager.AppSettings["MachName"] returned null.

Neil B Over a year ago

This ended my prolonged agony. Thanks. The framework should warn you that the old way is obsolete.

Ivanhoe Over a year ago

Can't confirm. The ConfigurationManager.AppSettings["someKey"] works in .NET 4.5, 4.6, 4.7.1

OKEEngine Over a year ago

Not working on vs2022, this is a very outdated answer

|

Peter Mortensen · Accepted Answer · 2019-12-27 15:27:57Z

42

Right click on your class library, and choose the "Add References" option from the Menu.

And from the .NET tab, select System.Configuration. This would include the System.Configuration DLL file into your project.

edited Dec 27, 2019 at 15:27

Peter Mortensen

31.4k22 gold badges110 silver badges134 bronze badges

answered Jul 27, 2009 at 17:51

Shiva

1,4092 gold badges16 silver badges32 bronze badges

1 Comment

SushiGuy Over a year ago

After adding reference, was able to do ConfigurationManager.ConnectionStrings[0].ConnectionString

Peter Mortensen · Accepted Answer · 2019-10-24 12:25:53Z

30

I'm using this, and it works well for me:

textBox1.Text = ConfigurationManager.AppSettings["Name"];

edited Oct 24, 2019 at 12:25

Peter Mortensen

31.4k22 gold badges110 silver badges134 bronze badges

answered Nov 30, 2011 at 23:15

Pagey

5494 silver badges2 bronze badges

1 Comment

Isantipov Over a year ago

The TS explicitly states, that he uses the same code, but his project fails to compile (due to missing references, as it turned out). -1 for not reading the question.

Peter Mortensen · Accepted Answer · 2019-12-27 15:49:24Z

29

Read From Config:

You'll need to add a reference to the configuration:

Open "Properties" on your project
Go to "Settings" Tab
Add "Name" and "Value"

Get Value with using following code:

string value = Properties.Settings.Default.keyname;

Save to the configuration:

   Properties.Settings.Default.keyName = value;
   Properties.Settings.Default.Save();

edited Dec 27, 2019 at 15:49

Peter Mortensen

31.4k22 gold badges110 silver badges134 bronze badges

answered Aug 7, 2016 at 12:29

Masoud Siahkali

5,3811 gold badge32 silver badges18 bronze badges

1 Comment

Steve G Over a year ago

FYI: Google likes your answer best. Shows up verbatim when you search for "get app config settings c#"

Peter Mortensen · Accepted Answer · 2019-12-27 15:26:30Z

23

You must add a reference to the System.Configuration assembly to the project.

edited Dec 27, 2019 at 15:26

Peter Mortensen

31.4k22 gold badges110 silver badges134 bronze badges

answered Jul 27, 2009 at 17:01

Otávio Décio

74.6k18 gold badges167 silver badges230 bronze badges

Comments

Peter Mortensen · Accepted Answer · 2019-12-27 15:38:58Z

22

You might be adding the App.config file to a DLL file. App.Config works only for executable projects, since all the DLL files take the configuration from the configuration file for the EXE file being executed.

Let's say you have two projects in your solution:

SomeDll
SomeExe

Your problem might be related to the fact that you're including the app.config file to SomeDLL and not SomeExe. SomeDll is able to read the configuration from the SomeExe project.

edited Dec 27, 2019 at 15:38

Peter Mortensen

31.4k22 gold badges110 silver badges134 bronze badges

answered Jun 12, 2013 at 18:59

Victor Naranjo

2212 silver badges2 bronze badges

1 Comment

David Krider Over a year ago

Wow, that's not obvious. If someone could link a document talking about this, that would be fantastic. This is a tough topic to search on.

Peter Mortensen · Accepted Answer · 2019-12-27 15:40:53Z

14

Try this:

string keyvalue = System.Configuration.ConfigurationManager.AppSettings["keyname"];

In the web.config file this should be the next structure:

<configuration>
<appSettings>
<add key="keyname" value="keyvalue" />
</appSettings>
</configuration>

edited Dec 27, 2019 at 15:40

Peter Mortensen

31.4k22 gold badges110 silver badges134 bronze badges

answered Nov 16, 2014 at 6:12

Ruslan

1771 silver badge7 bronze badges

Comments

Peter Mortensen · Accepted Answer · 2019-12-27 16:06:14Z

11

Step 1: Right-click on references tab to add reference.

Step 2: Click on Assemblies tab

Step 3: Search for 'System.Configuration'

Step 4: Click OK.

Then it will work.

 string value = System.Configuration.ConfigurationManager.AppSettings["keyname"];

edited Dec 27, 2019 at 16:06

Peter Mortensen

31.4k22 gold badges110 silver badges134 bronze badges

answered Jan 4, 2019 at 6:11

Jitendra Kumar

2,2492 gold badges19 silver badges23 bronze badges

Comments

Peter Mortensen · Accepted Answer · 2019-12-27 15:39:31Z

8

I had the same problem. Just read them this way: System.Configuration.ConfigurationSettings.AppSettings["MySetting"]

edited Dec 27, 2019 at 15:39

Peter Mortensen

31.4k22 gold badges110 silver badges134 bronze badges

answered Oct 16, 2013 at 10:53

Tom

6891 gold badge12 silver badges29 bronze badges

2 Comments

Peter M Over a year ago

As per Microsoft regarding ConfigurationSettings.AppSettings

This method is obsolete, it has been replaced by System.Configuration!System.Configuration.ConfigurationManager.AppSettings

GabrielBB Over a year ago

this method is Obsolete

Peter Mortensen · Accepted Answer · 2019-12-27 15:30:53Z

7

web.config is used with web applications. web.config by default has several configurations required for the web application. You can have a web.config for each folder under your web application.

app.config is used for Windows applications. When you build the application in Visual Studio, it will be automatically renamed to <appname>.exe.config and this file has to be delivered along with your application.

You can use the same method to call the app settings values from both configuration files: System.Configuration.ConfigurationSettings.AppSettings["Key"]

edited Dec 27, 2019 at 15:30

Peter Mortensen

31.4k22 gold badges110 silver badges134 bronze badges

answered Dec 16, 2011 at 7:33

Wavare Santosh

951 silver badge1 bronze badge

1 Comment

Mason Over a year ago

It's also possible to use System.Configuration.COnfigurationSettings.AppSettings.Get("Key") instead of using the square brackets.

Peter Mortensen · Accepted Answer · 2019-12-27 15:51:06Z

As I found the best approach to access application settings variables in a systematic way by making a wrapper class over System.Configuration as below

public class BaseConfiguration
{
    protected static object GetAppSetting(Type expectedType, string key)
    {
        string value = ConfigurationManager.AppSettings.Get(key);
        try
        {
            if (expectedType == typeof(int))
                return int.Parse(value);
            if (expectedType == typeof(string))
                return value;

            throw new Exception("Type not supported.");
        }
        catch (Exception ex)
        {
            throw new Exception(string.Format("Config key:{0} was expected to be of type {1} but was not.",
                key, expectedType), ex);
        }
    }
}

Now we can access needed settings variables by hard coded names using another class as below:

public class ConfigurationSettings:BaseConfiguration
{
    #region App setting

    public static string ApplicationName
    {
        get { return (string)GetAppSetting(typeof(string), "ApplicationName"); }
    }

    public static string MailBccAddress
    {
        get { return (string)GetAppSetting(typeof(string), "MailBccAddress"); }
    }

    public static string DefaultConnection
    {
        get { return (string)GetAppSetting(typeof(string), "DefaultConnection"); }
    }

    #endregion App setting

    #region global setting


    #endregion global setting
}

This uses the method the OP points out is marked as deprecated.

Peter Mortensen · Accepted Answer · 2019-12-27 15:42:39Z

6

Also, you can use Formo:

Configuration:

<appSettings>
    <add key="RetryAttempts" value="5" />
    <add key="ApplicationBuildDate" value="11/4/1999 6:23 AM" />
</appSettings>

Code:

dynamic config = new Configuration();
var retryAttempts1 = config.RetryAttempts;                 // Returns 5 as a string
var retryAttempts2 = config.RetryAttempts(10);             // Returns 5 if found in config, else 10
var retryAttempts3 = config.RetryAttempts(userInput, 10);  // Returns 5 if it exists in config, else userInput if not null, else 10
var appBuildDate = config.ApplicationBuildDate<DateTime>();

edited Dec 27, 2019 at 15:42

Peter Mortensen

31.4k22 gold badges110 silver badges134 bronze badges

answered May 18, 2015 at 20:58

pomber

24.1k15 gold badges83 silver badges96 bronze badges

2 Comments

lukejkw Over a year ago

Why on earth would you want to do this?

WiiLF Over a year ago

9 years later its even more irrelevant. Yikes

Chris Catignani · Accepted Answer · 2020-03-06 00:29:25Z

5

If your needing/wanting to use the ConfigurationManager class...

You may need to load System.Configuration.ConfigurationManager by Microsoft via NuGet Package Manager

Tools->NuGet Package Manager->Manage NuGet Packages for Solution...

Microsoft Docs

One thing worth noting from the docs...

If your application needs read-only access to its own configuration, we recommend that you use the GetSection(String) method. This method provides access to the cached configuration values for the current application, which has better performance than the Configuration class.

edited Mar 6, 2020 at 0:29

answered Mar 6, 2020 at 0:22

Chris Catignani

5,30819 gold badges46 silver badges54 bronze badges

Comments

Peter Mortensen · Accepted Answer · 2019-12-27 15:34:58Z

4

I strongly recommend you to create a wrapper for this call. Something like a ConfigurationReaderService and use dependency injection to get this class. This way you will be able to isolate this configuration files for test purposes.

So use the ConfigurationManager.AppSettings["something"]; suggested and return this value. With this method you can create some kind of default return if there isn't any key available in the .config file.

edited Dec 27, 2019 at 15:34

Peter Mortensen

31.4k22 gold badges110 silver badges134 bronze badges

answered Oct 18, 2012 at 19:19

Custodio

9,00415 gold badges86 silver badges115 bronze badges

1 Comment

jpaugh Over a year ago

Microsoft already has a bulit-in way to manage multiple versions of the same config file: build configurations, which allow having separate config files for each build configuration: app.DEBUG.config, app.RELEASE.config, and app.TEST.config, etc.

Peter Mortensen · Accepted Answer · 2019-12-27 15:46:13Z

3

Just for completeness, there's another option available for web projects only: System.Web.Configuration.WebConfigurationManager.AppSettings["MySetting"]

The benefit of this is that it doesn't require an extra reference to be added, so it may be preferable for some people.

edited Dec 27, 2019 at 15:46

Peter Mortensen

31.4k22 gold badges110 silver badges134 bronze badges

answered Mar 16, 2016 at 11:59

rdans

2,14722 silver badges33 bronze badges

Comments

Peter Mortensen · Accepted Answer · 2019-12-27 16:08:45Z

3

The ConfigurationManager is not what you need to access your own settings.

To do this you should use

{YourAppName}.Properties.Settings.{settingName}

edited Dec 27, 2019 at 16:08

Peter Mortensen

31.4k22 gold badges110 silver badges134 bronze badges

answered Jul 19, 2019 at 13:55

martin c

391 bronze badge

Comments

Peter Mortensen · Accepted Answer · 2019-12-27 15:45:36Z

2

I always create an IConfig interface with typesafe properties declared for all configuration values. A Config implementation class then wraps the calls to System.Configuration. All your System.Configuration calls are now in one place, and it is so much easier and cleaner to maintain and track which fields are being used and declare their default values. I write a set of private helper methods to read and parse common data types.

Using an IoC framework you can access the IConfig fields anywhere your in application by simply passing the interface to a class constructor. You're also then able to create mock implementations of the IConfig interface in your unit tests so you can now test various configuration values and value combinations without needing to touch your App.config or Web.config file.

edited Dec 27, 2019 at 15:45

Peter Mortensen

31.4k22 gold badges110 silver badges134 bronze badges

answered Jan 10, 2016 at 23:29

Tony O'Hagan

23k3 gold badges73 silver badges83 bronze badges

Comments

Peter Mortensen · Accepted Answer · 2019-12-27 16:00:25Z

2

Please check the .NET version you are working on. It should be higher than 4. And you have to add the System.Configuration system library to your application.

edited Dec 27, 2019 at 16:00

Peter Mortensen

31.4k22 gold badges110 silver badges134 bronze badges

answered Sep 23, 2018 at 4:46

Nayanajith

64512 silver badges16 bronze badges

2 Comments

Richardissimo Over a year ago

This question was asked over 9 years ago, and already has over 20 answers, including 2 which each have over 600 upvotes, the accepted answer is to add a reference to System.Configuration. This additional answer does not add value. At best, this should be a comment on the accepted answer.

Peter Mortensen Over a year ago

Re "higher than 4": In major version number? Or do you mean "higher than 4.0"? Or in other words, what side would .NET Framework 4.5 be on?

Peter Mortensen · Accepted Answer · 2019-12-27 16:07:46Z

2

You can use the below line. In my case it was working: System.Configuration.ConfigurationSettings.AppSettings["yourKeyName"]

You must take care that the above line of code is also the old version and it's deprecated in new libraries.

edited Dec 27, 2019 at 16:07

Peter Mortensen

31.4k22 gold badges110 silver badges134 bronze badges

answered Mar 29, 2019 at 11:12

Mohammad D

235 bronze badges

Comments

Peter Mortensen · Accepted Answer · 2019-12-27 16:17:51Z

I was able to get the below approach working for .NET Core projects:

Steps:

Create an appsettings.json (format given below) in your project.
Next create a configuration class. The format is provided below.

I have created a Login() method to show the usage of the Configuration Class.

Create appsettings.json in your project with content:

{
  "Environments": {
    "QA": {
      "Url": "somevalue",
 "Username": "someuser",
      "Password": "somepwd"
  },
  "BrowserConfig": {
    "Browser": "Chrome",
    "Headless": "true"
  },
  "EnvironmentSelected": {
    "Environment": "QA"
  }
}

public static class Configuration
{
    private static IConfiguration _configuration;

    static Configuration()
    {
        var builder = new ConfigurationBuilder()
            .AddJsonFile($"appsettings.json");

        _configuration = builder.Build();

    }
    public static Browser GetBrowser()
    {

        if (_configuration.GetSection("BrowserConfig:Browser").Value == "Firefox")
        {
            return Browser.Firefox;
        }
        if (_configuration.GetSection("BrowserConfig:Browser").Value == "Edge")
        {
            return Browser.Edge;
        }
        if (_configuration.GetSection("BrowserConfig:Browser").Value == "IE")
        {
            return Browser.InternetExplorer;
        }
        return Browser.Chrome;
    }

    public static bool IsHeadless()
    {
        return _configuration.GetSection("BrowserConfig:Headless").Value == "true";
    }

    public static string GetEnvironment()
    {
        return _configuration.GetSection("EnvironmentSelected")["Environment"];
    }
    public static IConfigurationSection EnvironmentInfo()
    {
        var env = GetEnvironment();
        return _configuration.GetSection($@"Environments:{env}");
    }

}


public void Login()
{
    var environment = Configuration.EnvironmentInfo();
    Email.SendKeys(environment["username"]);
    Password.SendKeys(environment["password"]);
    WaitForElementToBeClickableAndClick(_driver, SignIn);
}

Dmitry Grinko · Accepted Answer · 2022-07-27 02:38:46Z

2

I'm using Visual Studio for Mac version 17.0.6.

As you can see on this screenshot it is not possible to add a reference to System.Configuration.

Solution:

install NuGet Package - System.Configuration.ConfigurationManager.
Create app.config file and set "Build action" to "EmbeddedResource"

<?xml version="1.0" encoding="utf-8"?>
<configuration>
    <appSettings>
        <add key="name" value="Joe"/>
    </appSettings>
</configuration>

using System.Configuration;
enjoy)

string name = ConfigurationManager.AppSettings["name"];

BTW: Do not add an app.config for a library

edited Jul 27, 2022 at 2:38

answered Jul 26, 2022 at 22:35

Dmitry Grinko

15.4k15 gold badges66 silver badges91 bronze badges

Comments

Diligent Key Presser · Accepted Answer · 2016-03-30 15:15:19Z

1

Another possible solution:

var MyReader = new System.Configuration.AppSettingsReader();
string keyvalue = MyReader.GetValue("keyalue",typeof(string)).ToString();

edited Mar 30, 2016 at 15:15

Diligent Key Presser

4,3044 gold badges28 silver badges34 bronze badges

answered Mar 30, 2016 at 14:34

sherite

111 bronze badge

Comments

Peter Mortensen · Accepted Answer · 2019-12-27 15:36:11Z

1

I have been trying to find a fix for this same issue for a couple of days now. I was able to resolve this by adding a key within the appsettings tag in the web.config file. This should override the .dll file when using the helper.

<configuration>
    <appSettings>
        <add key="loginUrl" value="~/RedirectValue.cshtml" />
        <add key="autoFormsAuthentication" value="false"/>
    </appSettings>
</configuration>

edited Dec 27, 2019 at 15:36

Peter Mortensen

31.4k22 gold badges110 silver badges134 bronze badges

answered Apr 30, 2013 at 18:06

Jason

1441 gold badge3 silver badges11 bronze badges

Comments

esamaldin elzain · Accepted Answer · 2021-05-17 08:19:07Z

1

extra : if you are working on a Class Library project you have to embed the settings.json file.

A class library shouldn't really be directly referencing anything in app.config - the class doesn't have an app.config, because it's not an application, it's a class.

Go to the JSON file's properties.
Change Build Action -> Embedded resource.
Use the following code to read it.

var assembly = Assembly.GetExecutingAssembly();

var resourceStream = assembly.GetManifestResourceStream("Assembly.file.json");

string myString = reader.ReadToEnd();

now we have a JSON string we can Deserialize it using JsonConvert

if you didn't embed the file inside the assembly you can't use only the DLL file without the file

edited May 17, 2021 at 8:19

answered May 17, 2021 at 6:51

esamaldin elzain

3581 gold badge5 silver badges20 bronze badges

Comments

asmgx · Accepted Answer · 2023-01-30 06:13:41Z

0

I found the answer in this link https://stackoverflow.com/a/1836938/1492229

It's not only necessary to use the namespace System.Configuration. You have also to add the reference to the assembly System.Configuration.dll , by

Right-click on the References / Dependencies
Choose Add Reference
Find and add System.Configuration.

This will work for sure. Also for the NameValueCollection you have to write:

using System.Collections.Specialized;

answered Jan 30, 2023 at 6:13

asmgx

8,15019 gold badges102 silver badges185 bronze badges

Comments

Peter Mortensen · Accepted Answer · 2019-12-27 15:52:46Z

-8

Here's an example: App.config

<applicationSettings>
    <MyApp.My.MySettings>
        <setting name="Printer" serializeAs="String">
            <value>1234 </value>
        </setting>
    </MyApp.My.MySettings>
</applicationSettings>

Dim strPrinterName as string = My.settings.Printer

edited Dec 27, 2019 at 15:52

Peter Mortensen

31.4k22 gold badges110 silver badges134 bronze badges

answered Jan 9, 2017 at 22:57

JMat

23

Collectives™ on Stack Overflow

Reading settings from app.config or web.config in .NET

28 Answers 28

9 Comments

2 Comments

9 Comments

1 Comment

1 Comment

1 Comment

Comments

1 Comment

Comments

Comments

2 Comments

1 Comment

1 Comment

2 Comments

Comments

1 Comment

Comments

Comments

Comments

2 Comments

Comments

Comments

Comments

Comments

Comments

Comments

Comments

Comments

Linked

Hot Network Questions

Collectives™ on Stack Overflow

28 Answers 28

9 Comments

2 Comments

9 Comments

1 Comment

1 Comment

1 Comment

Comments

1 Comment

Comments

Comments

2 Comments

1 Comment

1 Comment

2 Comments

Comments

1 Comment

Comments

Comments

Comments

2 Comments

Comments

Comments

Comments

Comments

Comments

Comments

Comments

Comments

Linked

Related