Saturday, April 25, 2009

How to create a event handler

 - - - - - - - - - Create the event handler in Visual Studio

1.
Create a new project in Visual Studio by clicking File, pointing to New, and
thenclicking Project.

2. In the New Project dialog box, select Visual C# in the Project types box, select ClassLibrary in the Templates box, type MyEventHandler in the Name box,and then click OK.

3. In Solution Explorer, select MyEventHandler, and click Add Reference on the Project menu.

4. In the Add Reference dialog box, select Microsoft.SharePoint on the Browse tab and then click OK. (C:\Program Files\Common Files\Microsoft Shared\web server extensions\12\ISAPI\Microsoft.SharePoint.dll)

5. In the Code Editor, import the Microsoft.SharePoint namespace as follows.

using Microsoft.SharePoint:

6. Change the name of the class to MyAction and make it inherit from the SPItemEventReceiverclass, as follows. 

public class MyAction : SPItemEventReceiver

7. Add some code within the class to override the ItemDeleting method.

public override void ItemDeleting(SPItemEventProperties properties)
{  
    properties.Cancel = true;
    properties.ErrorMessage = "Deleting items from " + properties.RelativeWebUrl + " is not supported.";
}

8. In Solution Explorer, right-click the MyEventHandler node, and then click Properties.

9. In the Properties dialog box, click the Signing tab, select Sign the asembly, select Choose a strong name key file, and then click <New…>

10. In the Create Strong Name Key dialog box, type MyEventHandler.snk in the Key file  name box, optionally specify a password for the key, and then click OK

11. To build the project, click Build Solution on the Build menu, or press CTRL+SHIFT+B.

12. Find the \MyEventHandler\bin\Debug folder in the Visual Studio Projects folder, and  drag the MyEventHandler.dll file to C:\WINDOWS\assembly to place the DLL in the global assembly cache. 


- - - - - - - - - Add the event handler as a Windows SharePoint Services Feature

1. Create a folder in C:\Program Files\Common Files\Microsoft Shared\web server extensions\12\TEMPLATE\FEATURES called MyEventHandler.

2. Create a Feature.xml Files file in this folder like the following that identifies the Feature and its element manifest file and sets the Feature scope to Web site.

<Feature Scope="Web" Title="Deleting Event Handler" Id="GUIDxmlns="http://schemas.microsoft.com/sharepoint/">  
 <ElementManifests>
     
  <ElementManifest Location="Elements.xml"/>
  
 </ElementManifests>

</Feature>

3. To replace the GUID placeholder in the previous Id attribute, generate a GUID by running guidgen.exe located in C:\Program Files\Microsoft Visual Studio 8\Common7\Tools\guidgen.exe.

4. Create an Elements.xml file in the MyEventHandler folder that identifies the assembly, class, and method to implement as the event handler. This example applies the event handler to all announcements lists of a site, as specified by the ListTemplateId attribute. For the IDs of other default Windows SharePoint Services list template types, see the Type attribute description of the ListTemplate element.

<Elements xmlns="http://schemas.microsoft.com/sharepoint/">  
 <Receivers ListTemplateId="100">
     
  <Receiver>
        
   <Name>MyEventHandler</Name>
        
   <Type>ItemDeleting</Type>
        
   <SequenceNumber>10000</SequenceNumber>
        
   <Assembly>MyEventHandler, Version=1.0.0.0, Culture=neutral,PublicKeyToken=key</Assembly>
   
   <Class>MyEventHandler.MyAction</Class>
        
   <Data></Data>
        
   <Filter></Filter>
     
  </Receiver>
  
 </Receivers>

</Elements>

5. To get the Public Key Token of the assembly, in Windows Explorer find the MyEventHandler.dll file in the C:\WINDOWS\assembly, right-click the file, click Properties, and on the General tab of the Properties dialog box, select and copy the token.

6. At a command prompt, navigate to C:\Program Files\Common Files\Microsoft Shared\web server extensions\12\BIN on the local drive, and type each of the following commands to install the Feature in the deployment, activate the Feature on a specified
subsite, and reset Microsoft Internet Information Services (IIS) so that the changes take effect:

stsadm -o installfeature -filename MyEventHandler\Feature.xml

stsadm -o activatefeature -filename MyEventHandler\Feature.xml -url http://Server/Site/Subsite

iisreset

No comments:

Post a Comment