Data handler (CustomDataHandler class)

This handler allows you to add custom actions to the following events:

 

•OnBeforeUpdate
•OnAfterUpdate
•OnBeforeInsert
•OnAfterInsert
•OnBeforeDelete
•OnAfterDelete

 

The events are applied to all data items that are stored to the database. It includes documents, user information or any other settings. They receive the data object of type DataClass that can be modified. In case of delete handlers, the class name and ID is provided.

 

 

 

 

Handling document events

 

For handling document events, please use the CustomTreeNodeHandler class instead of the CustomDataHandler class. Every document uses up to 3 tables, which leads to three separate events in the CustomDataHandler class.

 

Example

 

The following example shows how to handle the OnAfterUpdate event and send the password to the user whenever her profile is updated:

 

1.Open the CustomDataHandler class and put the following code at the beginning of the file. It adds the reference to the namespaces we will use to handle the event:

 

[C#]

 

using CMS.DataEngine;

using CMS.GlobalHelper;

using CMS.EmailEngine;

 

2.Put the following code inside the OnAfterUpdate method.
 

      [C#]

 

       // type the data object as DataClass

       DataClass dataItem = (DataClass)dataObj;

            

       // we want to handle only updates of user objects

       if (dataItem.ClassName.ToLower() == "cms.user")

       {

               // we will use the CMS.EmailProvider to send e-mails

               EmailMessage email = new EmailMessage();

               email.From = "admin@domain.com";

               // get the user's e-mail address

               email.Recipients = ValidationHelper.GetString(dataItem.GetValue("Email"), "admin@domain.com");

               email.Subject = "Your password";

               // get the user's password

               email.Body = "Your password is:" + ValidationHelper.GetString(dataItem.GetValue("UserPassword"), "");                

               EmailSender.SendEmail(email);                

       }

 

3.Set the From and Recipients e-mail addresses to you e-mail address.
 
4.Compile and run the project. Edit some user profile that uses your e-mail address. You should receive the e-mail message with your password.