Click here to Skip to main content
13,399,174 members (33,169 online)
Click here to Skip to main content
Add your own
alternative version


6 bookmarked
Posted 6 Nov 2009

SharePoint Property Bag

, 7 Nov 2009
Rate this:
Please Sign up or sign in to vote.
Property bag is a feature available in Windows SharePoint Services 3.0. It's nothing but a hash table of Key-Value pairs.

Property bag is a feature available in Windows SharePoint Services 3.0. It's nothing but a hash table of Key-Value pairs. It allows to add properties to objects in a SharePoint site.


Why to Use SharePoint Property Bag

The Property Bag hash table for a site can store any metadata as Key-Value pairs such as connection strings, server names, file paths, and other settings needed by your SharePoint application. Most of the time, we will store the above settings in configuration file, which is common to the entire web application. If there is any setting specific each and individual sites in the web application, then we have to maintain that many entries in the config file. To overcome the above scenario, we can use the SharePoint Property Bag.

There is no specific out of box user interface available to set or to read the property bag settings. In WSS 3.0, property bag values have to set/get using the object model. There is an option available in SharePoint designer to set/get the property bag settings. Go to Site -> Site Settings. click on the Parameters tab.  On this tab, you will be able to manipulate all of your custom property bag values.



How to Use

            using (SPSite RootSite = new SPSite(URL))
                using (SPWeb SiteCollection = RootSite.OpenWeb())
                        SiteCollection.AllowUnsafeUpdates = true;
                       // Get connection string from Property bag
                        if (SiteCollection.AllProperties.ContainsKey("ConnectionString"))
                            ConnectionString = 
                        // Set siteID in the Property bag
                        SiteCollection.Properties["siteID"] = siteID;
                        SiteCollection.AllowUnsafeUpdates = false;                        
                    catch (Exception ex) 
                      //Handle Exception  
        catch(Exception ex)        


This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)


About the Author

United States United States
I'm interested in C#, AJAX, SilverLight,and SharePoint now. I enjoy listening to music, movies, driving.
I love posting answers to forums, especially questions related to SharePoint Technology. Started career as c++ developer, then .Net Mobile Technologies and SharePoint now.

You may also be interested in...

Comments and Discussions

GeneralNice post Pin
pydi.suresh28-May-13 19:46
memberpydi.suresh28-May-13 19:46 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

Permalink | Advertise | Privacy | Terms of Use | Mobile
Web02 | 2.8.180218.2 | Last Updated 7 Nov 2009
Article Copyright 2009 by Rajesh.Sitaraman
Everything else Copyright © CodeProject, 1999-2018
Layout: fixed | fluid