Add And Retrieve Property Bag Values In SharePoint Using JavaScript Object Model

Property bags in SharePoint act as a key value pair repository, where we can store the metadata values. The property bags more or less serve the same purpose of the app settings section in the Web Config file in ASP.NET, where we can store the configuration values. We can store the property bag values at different scopes in SharePoint like:

• Farm scope
• Web Application scope
• Site collection scope
• Site scope and
• List scope

The property bag values can be added using the SharePoint designer as well as programmatically. In this article, we will see how we can update and read the property bag values using the JavaScript object model.

Add Property Bag Value

• Add reference to jQuery file.
  
  1. <script language="javascript" type="text/javascript" src="//ajax.googleapis.com/ajax/libs/jquery/1.8.1/jquery.min.js"></script>
  2. <script language="javascript" type="text/javascript">
• Within the document, call ready function SP.SOD.executeFunc, so as to load the on demand script SP.js . Call the main starting point function, say: ModifyPropertyBag.
  
  1. SP.SOD.executeFunc('sp.js', 'SP.ClientContext', ModifyPropertyBag);
• Instantiate the client context and get the Web instance. Once the Web object is retrieved, get the property bag collection.
  
  1. //Get Client Context and Web object.
  2. clientContext= new SP.ClientContext.get_current();
  3. varoWeb= clientContext.get_web();
  5. //Get property bag collection and set the new key value pair
  6. oPropBag= oWeb.get_allProperties();
  7. oPropBag.set_item("Updated Name", "Modified List");
  8. oWeb.update();
• Execute the batch which will send the request to the Server and perform the entire JavaScript object model operation as a batch. Loading of the client context is not necessary to update property bag.
  
  1. clientContext.executeQueryAsync(Success,Failure);

Full code