MSDN Magazine - July 2008 - (Page 48)

Figure 6 CreateHttpModuleModification public SPWebConfigModification CreateHttpModuleModification() { SPWebConfigModification modification; string ModName = "add[@name='LitwareBrandingModule']"; string ModXPath = "configuration/system.web/httpModules"; modification = new SPWebConfigModification(ModName, ModXPath); modification.Owner = "LitwareBranding"; modification.Sequence = 0; modification.Type = SPWebConfigModification.SPWebConfigModificationType.EnsureChildNode; modification.Value = @" "; return modification; } Figure 7 Enabling and Disabling the HttpModule public override void FeatureActivated( SPFeatureReceiverProperties properties) { SPWebApplication WebApp = (SPWebApplication)properties.Feature.Parent; WebApp.WebConfigModifications.Add( CreateHttpModuleModification()); WebApp.WebService.ApplyWebConfigModifications(); WebApp.WebService.Update(); } public override void FeatureDeactivating( SPFeatureReceiverProperties properties) { SPWebApplication WebApp = (SPWebApplication)properties.Feature.Parent; WebApp.WebConfigModifications.Remove( CreateHttpModuleModification()); WebApp.WebService.ApplyWebConfigModifications(); WebApp.WebService.Update(); } Like any other feature receiver class, the FeatureReceiver WebApplication class inherits from the SPFeatureReceiver class and overrides the four handler methods named FeatureInstalled, FeatureActivated, FeatureDecactivating and FeatureUninstalling. The implementation for FeatureActivated adds the HttpModule entry to the web.config file for the current Web application. The implementation for FeatureDeactivating reverses that operation by removing the HttpModule entry. When you need to add an entry to the web.config file, it is best to use the SPWebConfigModification class from the WSS object model. The FeatureReceiverWebApplication class contains a utility method named CreateHttpModuleModification that creates and initializes an instance of SPWebConfigModification and passes it back as its return value (see Figure 6). Once you have a utility method such as CreateHttpModule Modification that returns an initialized SPWebConfigModification object, you can simply call this method from event handlers such as FeatureActivated and FeatureDeactivating to add the required HttpModule entry to or remove it from the web.config file for the current Web application (see Figure 7). Initializing Branding during Feature Activation Registering an HttpModule in the Web.config File When deploying a business solution with WSS and MOSS, it is good to distribute your development efforts within a solution package. For example, the Visual Studio project for LitwareBranding builds a single-solution package named LitwareBranding.wsp, which makes it easy and reliable to deploy this solution out to any farm running WSS 3.0 or MOSS 2007. However, the LitwareBranding solution requires adding an HttpModule entry to the web.config file for each Web application that will be running site collections that activate the LitwareBranding feature. To update the web.config file within specific Web applications, the LitwareBranding solution uses a second feature named LitwareBrandingWebApplication. This feature is scoped to the Web application level and is configured with a feature receiver class to fire event handlers as it is activated and deactivated within the scope of a particular Web application: It’s time to put all these pieces together. When a user activates the LitwareBranding feature within a specific site collection, there is a feature receiver with a FeatureActivated event handler that uses the BrandManager class to apply all the various branding elements. There is also a FeatureDeactivating event handler that removes all the branding elements during feature deactivation (see Figure 8). Note the call to the EnsureWebApplicationFeatureEnabled method at the beginning of the FeatureActivated event handler. This method has been written to ensure that the Web application-level feature named LitwareBrandingWebApplication has been activated so that the HttpModule, which swaps out the Master Pages for application pages, is properly registered with ASP.NET: public void EnsureWebApplicationFeatureEnabled() { // make sure feature which adds HttpModule to web.config is active SPSecurity.RunWithElevatedPrivileges(delegate() { using (SPSite siteCollection = new SPSite(SPContext.Current.Site.ID)) { try { Guid FeatureId = new Guid("FF739C76-0B08-4bc2-A3A2-F61524B492D8"); Figure 8 Applying and Removing Branding Elements public override void FeatureActivated(SPFeatureReceiverProperties properties) { EnsureWebApplicationFeatureEnabled(); BrandManager.ConfigureMasterUrl(true); BrandManager.ConfigureCustomMasterUrl(true); BrandManager.ConfigureAlternateCss(true); BrandManager.ConfigureSiteLogo(true); BrandManager.ConfigureApplicationPageMaster(true); } public override void FeatureDeactivating(SPFeatureReceiverProperties properties) { BrandManager.ConfigureMasterUrl(false); BrandManager.ConfigureCustomMasterUrl(false); BrandManager.ConfigureAlternateCss(false); BrandManager.ConfigureSiteLogo(false); BrandManager.ConfigureApplicationPageMaster(false); } 48 msdn magazine Office Space

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.