An event is an activity that occurs within Ektron and is exposed through the Extension Framework. An event handler is a method that executes when an event occurs.

NOTE: onBefore lets you manipulate the current data before it is updated. In contrast, onAfter events do not let you change a value in the contentData object for the content being affected. onAfter events only update data somewhere else (such as within Ektron or a third party database).

Ektron.Cms.Extensibility.CommunityGroupStrategy

• OnAdd(Ektron.Cms.CommunityGroupData, Ektron.Cms.Extensibility.CmsEventArgs)—called after a new Community Group is added.
  
• OnAfterUserAdd(long, long, Ektron.Cms.Extensibility.CmsEventArgs)—called after a user is added to a Community Group.
  
• OnAfterUserDelete(long, long, Ektron.Cms.Extensibility.CmsEventArgs)—called after a user is removed from a Community Group
  
• OnDelete(long, Ektron.Cms.Extensibility.CmsEventArgs)—called after a Community Group is deleted.
  
• OnUpdate(Ektron.Cms.CommunityGroupData, Ektron.Cms.Extensibility.CmsEventArgs)—called after a Community Group is updated.

Ektron.Cms.Extensibility.ContentStrategy

• OnAfterAddContent(Ektron.Cms.ContentData, Ektron.Cms.Extensibility.CmsEventArgs)—called after new content is added.
  
• OnAfterDeleteContent(long, Ektron.Cms.Extensibility.CmsEventArgs)—called after content is deleted.
  
• OnAfterPublishContent(Ektron.Cms.ContentData, Ektron.Cms.Extensibility.CmsEventArgs)—called after content is published.
  
• OnAfterUpdateContent(Ektron.Cms.ContentData, Ektron.Cms.Extensibility.CmsEventArgs)—called after content is saved.
  
• OnBeforeAddContent(Ektron.Cms.ContentData, Ektron.Cms.Extensibility.CmsEventArgs)—called before content is added.
  
• OnBeforeDeleteContent(long, Ektron.Cms.Extensibility.CmsEventArgs)—called before content is deleted.
  
• OnBeforePublishContent(Ektron.Cms.ContentData, Ektron.Cms.Extensibility.CmsEventArgs)—called before content is published.
  
• OnBeforeUpdateContent(Ektron.Cms.ContentData, Ektron.Cms.Extensibility.CmsEventArgs)—called before content is saved.

Ektron.Cms.Extensibility.FolderStrategy

• OnAfterAddFolder(Ektron.Cms.FolderData, Ektron.Cms.Extensibility.CmsEventArgs)—called after a new folder is added.
  
• OnAfterDeleteFolder(long, Ektron.Cms.Extensibility.CmsEventArgs)—called after a folder is deleted.
  
• OnAfterUpdateFolder(Ektron.Cms.FolderData, Ektron.Cms.Extensibility.CmsEventArgs)—called after folder is updated.
  
• OnBeforeAddFolder(Ektron.Cms.FolderData, Ektron.Cms.Extensibility.CmsEventArgs)—called before a folder is added.
  
• OnBeforeDeleteFolder(long, Ektron.Cms.Extensibility.CmsEventArgs)—called before a folder is deleted.
  
• OnBeforeUpdateFolder(Ektron.Cms.FolderData, Ektron.Cms.Extensibility.CmsEventArgs)—called before changes to a folder are saved.

Ektron.Cms.Extensibility.MessageBoardStrategy

• OnAdd(Ektron.Cms.MessageBoardData, Ektron.Cms.Extensibility.CmsEventArgs)—called after new Message Board item/post is added.
  
• OnAfterReplyAdd(Ektron.Cms.MessageBoardData, Ektron.Cms.Extensibility.CmsEventArgs)—called after someone replies to Message Board post.
  
• OnDelete(long, Ektron.Cms.Extensibility.CmsEventArgs)—called after a Message Board post is deleted.
  
• OnMessageApprove(Ektron.Cms.MessageBoardData, Ektron.Cms.Extensibility.CmsEventArgs)—called before Message Board post is approved.
  
• OnUpdate(Ektron.Cms.MessageBoardData, Ektron.Cms.Extensibility.CmsEventArgs)—called after Message Board post is updated.

Ektron.Cms.Extensibility.MicroMessageStrategy

• OnAfterAdd(Ektron.Cms.MicroMessageData, Ektron.Cms.Extensibility.CmsEventArgs)—called after new Micro Message post is added.
  
• OnAfterDelete(long, Ektron.Cms.Extensibility.CmsEventArgs)—called after a Micro Message post is deleted.
  
• OnBeforeAdd(Ektron.Cms.MicroMessageData, Ektron.Cms.Extensibility.CmsEventArgs)—called before a Micro Message post is added.
  
• OnBeforeDelete(long, Ektron.Cms.Extensibility.CmsEventArgs)—called before a Micro Message post is deleted.

Ektron.Cms.Extensibility.TagStrategy

• OnAdd(Ektron.Cms.TagData, Ektron.Cms.Extensibility.CmsEventArgs)—called after Tag is added.
  
• OnDelete(long, Ektron.Cms.Extensibility.CmsEventArgs)—called after a Tag is deleted.
  
• OnUpdate(Ektron.Cms.TagData, Ektron.Cms.Extensibility.CmsEventArgs)—called after a Tag is updated.

Ektron.Cms.Extensibility.TaxonomyStrategy

• OnAfterAdd(Ektron.Cms.TaxonomyData, Ektron.Cms.Extensibility.CmsEventArgs)—called after a new Taxonomy is added.
  
• OnAfterAssignItem(Ektron.Cms.TaxonomyRequest, Ektron.Cms.Extensibility.CmsEventArgs)—called after a Taxonomy Item is added/assigned to Taxonomy.
  
• OnAfterDelete(long, Ektron.Cms.Extensibility.CmsEventArgs)—called after Taxonomy is deleted.
  
• OnAfterUpdate(Ektron.Cms.TaxonomyData, Ektron.Cms.Extensibility.CmsEventArgs)—called after a Taxonomy is updated.
  
• OnBeforeAdd(Ektron.Cms.TaxonomyData, Ektron.Cms.Extensibility.CmsEventArgs)—called before a new Taxonomy is added.
  
• OnBeforeAssignItem(Ektron.Cms.TaxonomyRequest, Ektron.Cms.Extensibility.CmsEventArgs)—called before Taxonomy item is added/assigned to Taxonomy.
  
• OnBeforeDelete(long, Ektron.Cms.Extensibility.CmsEventArgs)—called before a Taxonomy is deleted.
  
• OnBeforeUpdate(Ektron.Cms.TaxonomyData, Ektron.Cms.Extensibility.CmsEventArgs)—called before a Taxonomy is updated.

Ektron.Cms.Extensibility.UserStrategy

• OnAfterAddColleague(long, long, Ektron.Cms.Extensibility.CmsEventArgs)—called after a colleague/friend is added.
  
• OnAfterAddUser(Ektron.Cms.UserData, Ektron.Cms.Extensibility.CmsEventArgs)—called after a new user is added.
  
• OnAfterColleagueRequest(Ektron.Cms.Community.ActionRequestData, Ektron.Cms.Extensibility.CmsEventArgs)—called after a colleague/friend request is sent.
  
• OnAfterDeleteUser(long, Ektron.Cms.Extensibility.CmsEventArgs)—called after a user is deleted.
  
• OnAfterLogin(Ektron.Cms.UserData, Ektron.Cms.Extensibility.CmsEventArgs)—called after a user logs in.
  
• OnAfterUpdateUser(Ektron.Cms.UserData, Ektron.Cms.Extensibility.CmsEventArgs)—called after a user is updated.
  
• OnBeforeAddUser(Ektron.Cms.UserData, Ektron.Cms.Extensibility.CmsEventArgs)—called before a new user is added to CMS.
  
• OnBeforeDeleteUser(long, Ektron.Cms.Extensibility.CmsEventArgs)—called before a user is deleted from CMS.
  
• OnBeforeLogin(Ektron.Cms.UserData, Ektron.Cms.Extensibility.CmsEventArgs)—called before a user logs in.
  
• OnBeforeUpdateUser(Ektron.Cms.UserData, Ektron.Cms.Extensibility.CmsEventArgs)—called before a user is updated.

Ektron.Cms.Extensibility.WebEventStrategy

• OnAfterAdd(Ektron.Cms.Common.Calendar.WebEventData, Ektron.Cms.Extensibility.CmsEventArgs)—called after a new Web calendar event is added
  
• OnAfterAddVariance(Ektron.Cms.Common.Calendar.WebEventData, Ektron.Cms.Extensibility.CmsEventArgs)—called after a Web calendar event variance is added.
  
• OnAfterCancelOccurrence(Ektron.Cms.Common.Calendar.WebEventData, Ektron.Cms.Extensibility.CmsEventArgs)—called after a single occurrence of Web calendar event (recursive event) is cancelled.
  
• OnAfterDelete(long, Ektron.Cms.Extensibility.CmsEventArgs)—called after a Web calendar event is deleted.
  OnAfterPublish(Ektron.Cms.Common.Calendar.WebEventData, Ektron.Cms.Extensibility.CmsEventArgs)—called after a Web calendar event is published.
  
• OnAfterUpdate(Ektron.Cms.Common.Calendar.WebEventData, Ektron.Cms.Extensibility.CmsEventArgs)—called after a Web calendar event is updated.
  
• OnBeforeAdd(Ektron.Cms.Common.Calendar.WebEventData, Ektron.Cms.Extensibility.CmsEventArgs)—called before a new Web calendar event is added.
  
• OnBeforeAddVariance(Ektron.Cms.Common.Calendar.WebEventData, Ektron.Cms.Extensibility.CmsEventArgs)—called before a Web calendar event variance is added.
  
• OnBeforeCancelOccurrence(Ektron.Cms.Common.Calendar.WebEventData, Ektron.Cms.Extensibility.CmsEventArgs)—called before a single occurrence of a Web calendar event (recursive event) is canceled.
  
• OnBeforeDelete(long, Ektron.Cms.Extensibility.CmsEventArgs)—called before a Web calendar event is deleted.
  
• OnBeforePublish(Ektron.Cms.Common.Calendar.WebEventData, Ektron.Cms.Extensibility.CmsEventArgs)—called before a Web calendar event is published.
  
• OnBeforeUpdate(Ektron.Cms.Common.Calendar.WebEventData, Ektron.Cms.Extensibility.CmsEventArgs)—called before a Web calendar event is updated.

eSync Strategies—see Using eSync Strategies

Creating a New CMS Extension with Visual Studio

1. In Visual Studio, open your website.
2. Add a new C# class to the App_Code directory.
3. The Class1.cs code page appears in the editor.
   —Image—

   

4. Add references to the following assemblies if they are not already added.

   Ektron.CMS.Common
   Ektron.CMS.Contracts
   Ektron.CMS.ObjectFactory

   If the assemblies are not installed in Visual Studio, you can find them in the siteroot/bin directory.

5. Add the following using statements to the top of the class.

   using Ektron.Cms;
   using Ektron.Cms.Common;
   using Ektron.Cms.Extensibility;
   using Ektron.Cms.Extensibility.Content; 

6. Update the class to extend Ektron.Cms.Extensibility.ContentStrategy.

   namespace Cms.Extensions.Samples { public class ContentExtensionsSample : ContentStrategy { } }

   NOTE: The namespace in this code is Cms.Extensions.Samples.

7. Override the method for the event you want to catch; in this example, override OnBeforeAddContent(). The code to modify the Title is as follows.

   public override void 
     OnBeforeAddContent(ContentData contentData, CmsEventArgs eventArgs)
     { contentData.Title += " modified"; } 

8. This is what the final code looks like.
   

   using System;
   using System.Collections.Generic;
   using System.Text;
   using Ektron.Cms;
   using Ektron.Cms.Common;
   using Ektron.Cms.Extensibility;
   using Ektron.Cms.Extensibility.Content;
   namespace Cms.Extensions.Samples
   {
   public class ContentExtensionsSample : ContentStrategy 
     { public override void 
       OnBeforeAddContent(ContentData contentData, CmsEventArgs eventArgs) 
       { contentData.Title += " modified"; }
     }
   }
   

   NOTE: More examples of extensions are found in the Ektron SDK folder. The default location for this folder is Program Files\Ektron\CMS400SDK\CMS Extensions. Also, sample eCommerce extensions are found in Program Files\Ektron\CMS400SDK\Commerce\Events.

Registering a New Extension in the ObjectFactory

After creating an extension, register it in the <webroot>/ObjectFactory.config file. This file already contains GoogleGeoCoder objectStrategies, so you need to add a new Name in the Content area. In this example, the code looks like this.

<objectFactory>
  <objectStrategies>
    <add name="Content">
      <strategies>
        <add name="MyFirstExample" 
          type="Cms.Extensions.Samples.ContentExtensionsSample"/>
        <add name="GoogleGeoCoder" 
          type="Cms.Extensions.GoogleGeoCoder.ContentStrategy"/>
      </strategies>
    </add>
    <add name="User">
      <strategies>
        <add name="GoogleGeoCoder" 
          type="Cms.Extensions.GoogleGeoCoder.UserStrategy"/>
      </strategies>
    </add>
  </objectStrategies>
</objectFactory> 

More information about ObjectFactory objectStrategies

• Register extensions in the <objectStrategies> element of the siteroot/ObjectFactory.config file.
• For the element directly below <objectStrategies>, <addname>, enter a name to identify extension type. A list of valid names is in the following list.
  —Valid names—

  • Basket
  • BasketCalculator
  • Blog
  • CatalogEntry
  • CommunityGroup
  • Content
  • Country
  • Coupon
  • CouponCalculator
  • Customer
  • Folder
  • Forum
  • Inventory
  • MessageBoard
  • MicroMessage
  • Order
  • Region
  • ShippingCalculator
  • Tag
  • TaxCalculator
  • Taxonomy
  • User
  • WebEvent
• Within a <strategies> element, add one or more content extensions. For each extension, insert a name and type. For example:

  <strategies> 
    <add name="MyFirstExample" 
      type="Cms.Extensions.Samples.ContentExtensionsSample"/>
  </strategies>

  • name is free-text.
  • Type is a fully-qualified name of the extension you are registering. It consists of namespace + “.” + name of the class.

Testing the New Extension

The new extension (created in the examples) adds "modified" to the end of a new content item's title. To test this, create new content in the Workarea; "modified" will be appended to the end of the title.