MSDN Magazine - July 2008 - (Page 47)

public static void ConfigureSiteLogo(bool ApplySiteLogo) { // determine SiteLogoUrl property setting string SiteLogoUrl = (ApplySiteLogo ? CustomSiteLogoUrl : string.Empty); // update AlternateCssUrl for all sites foreach (SPWeb site in SPContext.Current.Site.AllWebs) { site.SiteLogoUrl = SiteLogoUrl; site.Update(); } Figure 5 PreInit Event Handler void page_PreInit(object sender, EventArgs e) { Page page = sender as Page; if ((page != null) && (page.MasterPageFile != null) && (page.Request.Url.AbsolutePath.Contains("_layouts")) && (SPContext.Current != null) ) { // inspect UseCustomApplicationPageMaster property SPWeb site = SPContext.Current.Site.RootWeb; string UseCustomApplicationPageMaster = site.Properties["UseCustomApplicationPageMaster"]; if ((!string.IsNullOrEmpty(UseCustomApplicationPageMaster)) && (UseCustomApplicationPageMaster.Equals("True"))) { // now replace application.master with customized version if (page.MasterPageFile.Contains("application.master")) { page.MasterPageFile = "/_layouts/LitwareBranding/application.master"; } } } } } While SharePoint makes it relatively easy to swap out the Master Page for site pages, it does not provide an obvious way to swap out the Master Page for built-in application pages running out of the LAYOUTS directory such as the standard WSS Site Settings page (settings.aspx). These application pages are linked to a standard WSS Master Page named application.master that WSS deploys within the LAYOUTS directory. However, if you create a branding solution that swaps out the Master Page for all the site pages within a site collection, you might want to create a consistent appearance by swapping out the Master Page for application pages such as settings.aspx so that they also use a customized Master Page. The LitwareBranding solution demonstrates a technique for swapping out the Master Page for all application pages that link to the standard Master Page file named application.master. The technique used for swapping out the Master Page involves implementing a custom HttpModule that registers an event handler for one of the events in the ASP.NET page lifecycle named PreInit. This is the event that the ASP.NET programming model requires you to implement whenever you want to swap out the Master Page during the initial processing of a page request. The class LitwareBrandingHttpModule provides the HttpModule used in the LitwareBranding solution to swap out the Master Page (see Figure 4). This HttpModule class registers a handler for the PreRequestHandlerExecute event inside the Init method. Within the method implementation of the PreRequestHandlerExecute event handler, the HttpModule class determines whether the request is based on an HttpHandler object that derives from the ASP.NET Page class. Only in cases where the request is based on a Page-derived object will the HttpModule class register an event handler from the PreInit event. The code in the PreRequestHandlerExecute event handler also checks to make sure the incoming request targets a page inside the _layouts directory, which will always be the case when processing an application page in WSS. It’s important to remember that an HttpModule cannot be deployed in a WSS farm for an individual site collection. Instead, an HttpModule must be configured as an all-or-nothing proposition at the Web application level. However, a Web application may contain hundreds of site collections and only certain site collections might have enabled the LitwareBranding feature. Therefore, the PreInit event handler for the HttpModule class must be able to determine whether the current site collection has been configured with the behavior to swap out the Master Page for its application pages. The LitwareBranding solution solves this problem by creating a msdnmagazine.com Swapping Out the Master Page custom property in the site collection’s top-level site to indicate that swapping out the Master Page for application pages should be enabled. Examine the implementation of the ConfigureApplicationPageMaster method defined within the BrandManager class: public static void ConfigureApplicationPageMaster( bool ApplyApplicationPageMaster) { SPWeb TopLevelSite = SPContext.Current.Site.RootWeb; if (ApplyApplicationPageMaster) { TopLevelSite.Properties["UseCustomApplicationPageMaster"] = "True"; } else { TopLevelSite.Properties["UseCustomApplicationPageMaster"] = "False"; } TopLevelSite.Properties.Update(); } This method creates a custom property named UseCustomApplicationPageMaster on the top-level site and assigns the property a value of True. Now, the method implementation for the PreInit event handler in the HttpModule can look for this property with- it’s a good idea to distribute your development efforts within a solution package. in the current site collection to see whether it has been configured to enable swapping out the application page master. Note that the PreInit event handler also performs several other checks to determine whether it is appropriate to swap out the Master Page within the context of the current request (see Figure 5). Once the PreInit event handler determines the current site collection has been configured to enable swapping out the Master Page for application pages and also that the current page links to application.master, it modifies the MasterPageFile property of the current ASP.NET Page object to use a custom Master Page located within a solution-specific directory within the LAYOUTS directory at the following path: /_layouts/LitwareBranding/application.master July 2008 47 http://msdnmagazine.com

Table of Contents Feed for the Digital Edition of MSDN Magazine - July 2008

MSDN Magazine - July 2008 Contents Toolbox CLR Inside Out Flex Your Data Data Points Advanced Basics Office Space Cutting Edge Data Services ADO.NET Data and WPF Transactions WCF P2P Test Run Security Briefs Foundations .NET Matters {End Bracket}

MSDN Magazine - July 2008

For optimal viewing of this digital publication, please enable JavaScript and then refresh the page. If you would like to try to load the digital publication without using Flash Player detection, please click here.