Skip to main content

Configuration section designer

A Visual Studio add-in that allows you to graphically design .NET Configuration Sections and automatically generates all the required code and a schema definition (XSD) for them.

This is really good tool if you want to design your own complex configuration section in web.config or app.config. It saves you lots of trouble to write your own section handler.

You can download the add-in here: http://csd.codeplex.com/releases

Once installed, it created a new item type:



It also adds this new toolbox items in the designer surface.


For example, I want to create a configuration file as following:

Using the configuration section designer, the design is like this:


It starts with Configuration Section "SearchResultSection". You can define attributes and elements inside it. In my example, we have following elements in this section:
  • UserLockedField
  • UserRegisteredField
  • UserResetField
  • CredentialFields: this is a collection that contains CredentialField element. For collection element, you have to specify which attribute is the key that can be used to find the element in the collection uniquely.
  • UserDataFields: this is a collection that contains UserDataField element.
Each attribute needs to declare its type. These are the built-in types you can use:


You can also define your own type by using "Configuration Section Exploer".





Once you saved the designer file, the add-in will generate all the required .xsd and .cs file for you. You have to add this line inside"configSections" element in your web.config file:
Right outside the "configSections" element, add this line:


The SearchResultSection.config file must be put in the same folder as your web.config file.

In your code, you can reference the configurations like this:


Enjoy coding!


Comments

Popular posts from this blog

Manage IIS 7 remotely using PowerShell and AppCmd

We can use  Windows PowerShell remoting features  to manage IIS 7 websites remotely.  Currently, remoting is supported on Windows Vista with Service Pack 1 or later, Windows 7, Windows Server 2008, and Windows Server 2008 Release 2.  Start Windows PowerShell as an administrator by right-clicking the Windows PowerShell shortcut and selecting Run As Administrator .  Enable PowerShell Remoting with Enable-PSRemoting -Force Starting a Remote Session using:  Enter-PSSession -ComputerName <COMPUTER> -Credential <USER> Now the PowerShell connected to the remote server. Any commands issued with work against the remote server. We can use the Appcmd.exe command line tool to manage remote server just as what we do locally. For example, to add an application pool: c:\windows\system32\inetsrv\appcmd add apppool /name:"Contoso" /managedPipelineMode:Integrated /managedRuntimeVersion:"v4.0" /enable32BitAppOnWin64:true To change application p...

Entity framework code first error: OriginalValues cannot be used for entities in the Added state

When I was using Entity framework code first, I encountered an error when I tried to create an entity into database. The entity is: [ Table (" EmployeeProfile ")]     public partial class EmployeeProfile     {         [ Key ]         [DatabaseGeneratedAttribute(DatabaseGeneratedOption.Identity)]         public int EmployeeProfileID { get; set; }         [ ForeignKey ("Employee")]         public int EmployeeID { get; set; }         public virtual Employee Employee { get; set; }         [ ForeignKey (" Profile ")]         public int ProfileID { get; set; }         public virtual Profile Profile { get; set; }       ...

X509Certificate2: The system cannot find the file specified.

When I use the new X509Certificate2(fileName, password, X509KeyStorageFlags.DefaultKeySet) to create certificate from certificate file containing private key in my web application, I got following error message: System . Security . Cryptography . CryptographicException : The system cannot find the file specified . at System . Security . Cryptography . CryptographicException . ThrowCryptogaphicException ( Int32 hr ) at System . Security . Cryptography . X509Certificates . X509Utils . _LoadCertFromBlob ( Byte [] rawData , IntPtr password , UInt32 dwFlags , Boolean persistKeySet , SafeCertContextHandle & pCertCtx ) at System . Security . Cryptography . X509Certificates . X509Certificate . LoadCertificateFromBlob ( Byte [] rawData , Object password , X509KeyStorageFlags keyStorageFlags ) at System . Security . Cryptography . X509Certificates . X509Certificate2 .. ctor ( Byte [] rawData , String password , X509KeyStorageFlags keyStorageFlags ) In orde...