Extending Umbraco with Event Handlers

Before you start, I recommend taking a look at this page, it'll explain most of the things you need to know about what each event handler does.

To create a custom event handler, you need to create a new class in your website and extend from ApplicationEventHandler:

using Umbraco.Core;
using Umbraco.Core.Events;
using Umbraco.Core.Models;
using Umbraco.Core.Publishing;
using Umbraco.Core.Services;

namespace My.Namespace
{
    public class MyEventHandler : ApplicationEventHandler
    {
    }
}

The class will automatically loaed into your websie when it starts, but before u can put it to use, you need to add a few extra methods:

using Umbraco.Core;
using Umbraco.Core.Events;
using Umbraco.Core.Models;
using Umbraco.Core.Publishing;
using Umbraco.Core.Services;

namespace My.Namespace
{
    public class MyEventHandler : ApplicationEventHandler
    {
        public MyEventHandler()
        {
            
        }

        public void OnApplicationInitialized(UmbracoApplicationBase umbracoApplication, ApplicationContext applicationContext)
        { }

        public void OnApplicationStarting(UmbracoApplicationBase umbracoApplication, ApplicationContext applicationContext)
        { }

        public void OnApplicationStarted(UmbracoApplicationBase umbracoApplication, ApplicationContext applicationContext)
        { }
    }
}

Then you can add your event handlers:

using Umbraco.Core;
using Umbraco.Core.Events;
using Umbraco.Core.Models;
using Umbraco.Core.Publishing;
using Umbraco.Core.Services;

namespace My.Namespace
{
    public class MyEventHandler : ApplicationEventHandler
    {
        public MyEventHandler()
        {
            ContentService.Trashing += Document_Trash;
        }

        private void Document_Trash(IContentService sender, MoveEventArgs e)
        {
            // Perform action here when node is sent to trash
        }

        public void OnApplicationInitialized(UmbracoApplicationBase umbracoApplication, ApplicationContext applicationContext)
        { }

        public void OnApplicationStarting(UmbracoApplicationBase umbracoApplication, ApplicationContext applicationContext)
        { }

        public void OnApplicationStarted(UmbracoApplicationBase umbracoApplication, ApplicationContext applicationContext)
        { }
    }
}

And thats it! You can add more event handlers if needed, and you're using Visual Studio, you can see what each devent handler requires by browsing to their definition.


Published at

Tags: Umbraco,Event Handler,Exending,ContentService

Luke Alderton

Comments

Post a comment
Sit tight...
We're adding your comment.
Thank you.
Your comment has been added.
There's been a problem.
Please try again later.
Share with
Tags
Latest Comments
By jack of ass on Replacing the Xamarin Header/Navigation bar with a custom view/template
16 Feb 2019, 03:13 AM
By Zal on Xamarin MasterDetailPage has large margin/padding at top
7 Feb 2019, 12:20 PM
By AndrewEcopE1 on MVC forms in Umbraco
7 Feb 2019, 01:16 AM
By AndrewEcopE1 on MVC forms in Umbraco
4 Feb 2019, 23:53 PM
By Ramachandran on Reducing Umbraco memory usage by enabling 32-bit applications
4 Feb 2019, 17:39 PM
By encoderu9 on MVC forms in Umbraco
4 Feb 2019, 10:51 AM
By AndrewEcopE1 on MVC forms in Umbraco
28 Jan 2019, 19:48 PM
By Luca Ziegler on Xamarin Forms app not updating after deploy
25 Jan 2019, 11:00 AM
Categories
App Development
Event
Game Development
Mapping
Modelling
Programming
Review
Robotics
Tutorial
Web Development