London Dev Meetup Rescheduled! Due to unavoidable reasons, the event has been moved to 21st May. Speakers remain the same—any changes will be communicated. Seats are limited—register here to secure your spot!

Ravindra S. Rathore
Oct 17, 2019
  2387
(8 votes)

Playing with Episerver webconfig settings programmatically

Hi Guys,

Sometimes we need to read, write or update some of the property from the Episerver web.config so Episerver provided a class called "EPiServerFrameworkSection". By using this class we can achieve this.

I found this class very handy and I used this many times when I have to read, write and update the settings on web.config programmatically.

This exists in "EPiServer.Framework.Configuration" namespace.

Some Examples-

Reading providers from config-

ProviderSettingsCollection virtualRoles = EPiServerFrameworkSection.Instance.VirtualRoles.Providers;
ProviderSettingsCollection blobProviders = EPiServerFrameworkSection.Instance.Blob.Providers;

Reading connections string -

var ConnectionStrings = EPiServerFrameworkSection.Instance.CurrentConfiguration.ConnectionStrings;

Reading Appdata path-

string appData = EPiServerFrameworkSection.Instance.AppData.BasePath;

There are lots of other options as well that you can explore on your own. Here are some great documentation from Episerver

https://world.episerver.com/documentation/class-library/?documentId=cms/11/4E02FB31

https://world.episerver.com/documentation/class-library/?documentId=episerverframework/7/09b6aa52-2249-641a-ed99-d6ebe9afc589

Thanks and Regards

Ravindra S. Rathore

Oct 17, 2019

Comments

K Khan
K Khan Oct 18, 2019 07:03 AM

Wondering, what happened when you wrote something programmatically in web.config?

Ravindra S. Rathore
Ravindra S. Rathore Oct 19, 2019 04:42 AM

Hi K Khan,

It will write the entry and recycle the app pool.

valdis
valdis Oct 19, 2019 09:49 AM

I would not recommend to write anything back to web.config :)

Ravindra S. Rathore
Ravindra S. Rathore Oct 19, 2019 10:15 AM

Yes, true but we can use this class to read settings from web.config

Please login to comment.
Latest blogs
Render ContentArea without wrapping them in surrounding div

CustomContentAreaRenderer is a specialized class that overrides the default ContentAreaRenderer. It customizes the rendering behavior for content...

sunylcumar | May 18, 2025

Indexing a content item programatically

public bool IndexContent(int contentId, bool contentOnly, bool childrenOnly, string language) { // Retrieve the content var contentReference = new...

sunylcumar | May 18, 2025

Add a new menu item to the Admin Menu in Optimizely CMS

Create a new Controller called CustomMenuController and decorate with [Authorize(Roles ="CMSAdmins")] so that it will be accessed by admins only...

sunylcumar | May 18, 2025

Display page/block thumbnail based on selected site in multi-site solution

In previous blog we described how to control the visibility of the blocks or properties based on the current site in multisite solution. We can use...

Tomek Juranek | May 16, 2025