Apply Out Of Box Themes And Custom Themes To SharePoint Site

Here are the steps,

Step 1: Create Provider Hosted App using Visual Studio as in the following,

Go to Visual Studio, Office/SharePoint Tab, Apps and select App for SharePoint. Give some unique name “SharePointBranding”.



Select Hosting option as “Provider Hosted” as in the following,



Select Web Application type “ASP.NET Web Form Application” as in the following screenshot,



Select Authentication Type as “Certificate” as in the following,:



Step 2: Solution Structure looks like the following,

1. Add folder named “CustomJS” with new custom JavaScript file named “App.js”.
   
   1. //function to get a parameter value by a specific key
   2. function getQueryStringParameter(urlParameterKey)
   3. {
   4. var params = document.URL.split('?')[1].split('&');
   5. var strParams = '';
   6. for (var i = 0; i < params.length; i = i + 1)
   7. {
   8. var singleParam = params[i].split('=');
   9. if (singleParam[0] == urlParameterKey) return singleParam[1];
   10. }
   11. }
   13. function Branding()
   14. {
   15. console.log("Branding");
   16. }
   17. $(document).ready(function ()
   18. {
   19. //Get the URI decoded SharePoint site url from the SPHostUrl parameter.
   20. var spHostUrl = decodeURIComponent(getQueryStringParameter('SPHostUrl'));
   21. //Build absolute path to the layouts root with the spHostUrl
   22. var layoutsRoot = spHostUrl + '/_layouts/15/';
   23. //load all appropriate scripts for the page to function
   24. $.getScript(layoutsRoot + 'SP.Runtime.js', function ()
   25. {
   26. $.getScript(layoutsRoot + 'SP.js', function ()
   27. {
   28. //Execute the correct script based on the isDialog
   29. //Load the SP.UI.Controls.js file to render the App Chrome
   30. $.getScript(layoutsRoot + 'SP.UI.Controls.js', renderSPChrome);
   31. });
   32. });
   33. });
2. Add folder named “Resources” with two files “NewCustom.spcolor” and “NewCustombg.jpg”
   
   

Step 3: Default.aspx page

Above code render UI as shown below:



Step 4: Register Script on page.

On page load we are going to register script named “BasePageScript” into page as shown below.
Step 5: Apply Existing Theme to SharePoint Site as follows:

1. Select any theme from dropdown menu and click on button “Set out Of Box Theme”.
   
   
2. On button click “btnSetThemeForHost_Click()” method get called, which in turn call “SetThemeBasedOnName()” method.
   
   1. public void SetThemeBasedOnName(Web web, string themeName)
   2. {
   3. // Let's get instance to the composite look gallery
   4. List themeList = web.GetCatalog(124);
   5. web.Context.Load(themeList);
   6. web.Context.ExecuteQuery();
   7. // We are assuming that the theme exists
   8. CamlQuery query = new CamlQuery();
   9. string camlString = @ " < View > < Query > < Where > < Eq > < FieldRef Name = 'Name' / > < Value Type = 'Text' >
   10. {
   11. 0
   12. } < /Value> < /Eq> < /Where> < /Query> < /View>";
   13. // Let's update the theme name accordingly
   14. camlString = string.Format(camlString, themeName);
   15. query.ViewXml = camlString;
   16. var found = themeList.GetItems(query);
   17. web.Context.Load(found);
   18. web.Context.ExecuteQuery();
   19. if (found.Count > 0)
   20. {
   21. Microsoft.SharePoint.Client.ListItem themeEntry = found[0];
   22. //Set the properties for applying custom theme which was jus uplaoded
   23. string spColorURL = null;
   24. if (themeEntry["ThemeUrl"] != null && themeEntry["ThemeUrl"].ToString().Length > 0)
   25. {
   26. spColorURL = MakeAsRelativeUrl((themeEntry["ThemeUrl"] as FieldUrlValue).Url);
   27. }
   28. string spFontURL = null;
   29. if (themeEntry["FontSchemeUrl"] != null && themeEntry["FontSchemeUrl"].ToString().Length > 0)
   30. {
   31. spFontURL = MakeAsRelativeUrl((themeEntry["FontSchemeUrl"] as FieldUrlValue).Url);
   32. }
   33. string backGroundImage = null;
   34. if (themeEntry["ImageUrl"] != null && themeEntry["ImageUrl"].ToString().Length > 0)
   35. {
   36. backGroundImage = MakeAsRelativeUrl((themeEntry["ImageUrl"] as FieldUrlValue).Url);
   37. }
   38. // Set theme to host web
   39. web.ApplyTheme(spColorURL, spFontURL, backGroundImage, false);
   40. // Let's also update master page, if needed
   41. if (themeEntry["MasterPageUrl"] != null && themeEntry["MasterPageUrl"].ToString().Length > 0)
   42. {
   43. web.MasterUrl = MakeAsRelativeUrl((themeEntry["MasterPageUrl"] as FieldUrlValue).Url);
   44. }
   45. // Execute the needed code
   46. web.Context.ExecuteQuery();
   47. }
   48. }
   49. private string MakeAsRelativeUrl(string urlToProcess)
   50. {
   51. Uri uri = new Uri(urlToProcess);
   52. return uri.AbsolutePath;
   53. }
   54. protected void btnSetThemeForHost_Click(object sender, EventArgs e)
   55. {
   56. var spContext = SharePointContextProvider.Current.GetSharePointContext(Context);
   57. using(var clientContext = spContext.CreateUserClientContextForSPHost())
   58. {
   59. if (clientContext != null)
   60. {
   61. Web web = clientContext.Web;
   62. string selectedTheme = drpThemes.SelectedValue;
   63. SetThemeBasedOnName(web, selectedTheme);
   64. lblStatus1.Text = string.Format("Theme '{0}' has been applied to the <a href='{1}'>host web</a>.", selectedTheme, spContext.SPHostUrl.ToString());
   65. }
   66. }
   67. }
3. Existing theme resides inside ‘Composite Look Gallery’, so we first need to get access to composite look gallery for that the following line of code is used.
   
   1. List themeList = web.GetCatalog(124);
   3. web.Context.Load(themeList);
   5. web.Context.ExecuteQuery();
4. Using CAML Query object, get list item corresponding to selected theme.
   
   
5. Let’s find “ThemeURL”, “ImageURL”, “MasterPageURL” which is needed to apply theme to the site.
   
   1. // Set theme to host web
   3. web.ApplyTheme(spColorURL, spFontURL, backGroundImage, false);

Step 6: Output of applying existing theme to SharePoint Site.



Step 7: Deploy Custom Theme