SharePoint Pals
 | Sign In
How to Attach an Event Receiver to a SharePoint List on Feature Activation
by Sathish Nadarajan 14 Dec 2015
Author
SharePoint MVP
Visits   
Today  :   3     Total  :    6642

For a very long time, I have been thinking to write this particular function. Here, there are two methods we can use. Either the Elements.xml or with the CS. I always believe in C Sharp, rather than the Elements File. Hence, I have come up with a Generic Method which will delete the event receiver and attach the event receiver to the List.

The Code snippet is self-explanatory and does not require much explanation.

 private static void AttachEventReceiver(SPWeb web,string listName,string eventClassName,string eventName,int sequenceNumber,string eventReceiverType)
         {
             SPList list = web.Lists[listName];
             if (list != null)
             {
                 SPEventReceiverDefinition eventReceiverDefinitionToDelete = null;
 
                 foreach (SPEventReceiverDefinition eventReceiverDefinition in list.EventReceivers)
                 {
                     if (eventReceiverDefinition.Class == eventClassName)
                     {
                         eventReceiverDefinitionToDelete = eventReceiverDefinition;
                         break;
                     }
                 }
 
                 if (eventReceiverDefinitionToDelete != null)
                 {
                     eventReceiverDefinitionToDelete.Delete();
                     list.Update();
                 }
 
                 SPEventReceiverDefinition workflowStatusUpdatedEventDefinition = list.EventReceivers.Add();
                 workflowStatusUpdatedEventDefinition.Assembly = System.Reflection.Assembly.GetExecutingAssembly().FullName;
                 workflowStatusUpdatedEventDefinition.Class = eventClassName;
                 workflowStatusUpdatedEventDefinition.SequenceNumber = sequenceNumber;
                 workflowStatusUpdatedEventDefinition.Name = eventName;
                 switch (eventReceiverType)
                 {
                     case "ItemUpdated":
                         workflowStatusUpdatedEventDefinition.Type = SPEventReceiverType.ItemUpdated ;
                         break;
                     case "CheckIn":
                         workflowStatusUpdatedEventDefinition.Type = SPEventReceiverType.ItemCheckedIn;
                         break;
                     case "ItemDeleting":
                         workflowStatusUpdatedEventDefinition.Type = SPEventReceiverType.ItemDeleting;
                         break;
                     default:
                         break;
                 }
                 
                 workflowStatusUpdatedEventDefinition.HostId = list.ID;
                 workflowStatusUpdatedEventDefinition.HostType = SPEventHostType.List;
                 workflowStatusUpdatedEventDefinition.Update();
                 list.Update();
 
             }
         }
 
 private static void DeleteEventReceiver(SPWeb web,string listName, string eventClassName)
         {
             SPList pagesList = web.Lists[listName];
 
             if (pagesList != null)
             {
                 SPEventReceiverDefinition eventReceiverDefinitionToDelete = null;
 
                 foreach (SPEventReceiverDefinition er in pagesList.EventReceivers)
                 {
                     if (er.Class == eventClassName)
                     {
                         eventReceiverDefinitionToDelete = er;
                         break;
                     }
                 }
 
                 if (eventReceiverDefinitionToDelete != null)
                 {
                     eventReceiverDefinitionToDelete.Delete();
                     pagesList.Update();
                 }
             }
         }
 

And the Sample Call to these methods are as follows.

 public override void FeatureActivated(SPFeatureReceiverProperties properties)
         {
             
             SPSite site = (SPSite)properties.Feature.Parent;
             SPWeb web = site.RootWeb;
             SPWeb confidentialWeb = site.AllWebs[SiteVariables.SITE_CONFIDENTIAL];
             AttachEventReceiver(web, "Pages", "EventReceiver Assembly Name", "Event Name", 1000, "CheckIn");
             
         }
 public override void FeatureDeactivating(SPFeatureReceiverProperties properties)
         {
 
             SPSite site = (SPSite)properties.Feature.Parent;
             SPWeb web = site.RootWeb;
             SPWeb confidentialWeb = site.AllWebs[SiteVariables.SITE_CONFIDENTIAL];
             DeleteEventReceiver(web,"Pages"," EventReceiver Assembly Name ");
  
         }
 

Hope this snippet is useful.

Happy Coding,

Sathish Nadarajan.

blog comments powered by Disqus

SharePoint Pals

Pals
SharePoint Pals, a community portal for SharePoint developers, Administrators and End Users. Let's join hands and share the point together.
Read this on mobile

Training

Angular Js Training In Chennai
Advanced Angular Js training with real world developer scenarios
Angular Js, Web Api and Ionic for .Net Developers
All in one client side application development for .Net developers
Angular Js For SharePoint Developers
Get ready for the future. Its no more just C#

Get Connected

SharePoint Resources

SharePoint 2013 and 2010 Web Parts
Free Web Parts with Source Code for SharePoint Community




SharePoint 2013 Books and Tutorials
Collection of free SharePoint 2013 books and tutorials (eBooks, pdfs)

Supported By

Contribute your article and be eligible for a one month Free Subscription for Plural Sight. The Author of the most popular New Article (published in the previous month) will be awarded with a Free One month Plural Sight Subscription. Article can be sent to articles@sharepointpals.com in a word document.

Related Resources

Recent Tweets

Twitter January 15, 00:25
How To Enable Target Value And Actual Value In #D3 Gauge Chart https://t.co/VxSi4QnNrC

Twitter January 15, 00:24
How To Open #SharePoint List Hyperlink Column In Modal #Popup Window https://t.co/EQ7HkoZDkX

Twitter January 15, 00:24
Quick Introduction To #Asp.NetCore And It’s Features https://t.co/zAXObHCFpH

Twitter January 15, 00:22
How To Configure #PerformancePoint Services To Use Secure Store In #SharePoint 2013 https://t.co/LEwnUoI7EY

Twitter January 15, 00:21
How To Block Or Disable #Office365 Services https://t.co/Yvp2VPFIRP

Follow us @SharePointPals
Note: For Customization and Configuration, CheckOutRecent Tweets Documentation