[This is preliminary documentation and is subject to change.]

void EventHandler(
	string eventXmlArguments,
	string customData,
	ICSContentContainer content,
	ICSCredentialsContainer credentials,
	ref bool cancel,
	out int status,
	out string statusText
)

Sub EventHandler ( 
	eventXmlArguments As String,
	customData As String,
	content As ICSContentContainer,
	credentials As ICSCredentialsContainer,
	ByRef cancel As Boolean,
	<OutAttribute> ByRef status As Integer,
	<OutAttribute> ByRef statusText As String
)

Parameters

eventXmlArguments

Type: SystemString

An xml document sent to the implementer from Content Studio.

The exact content varies between different events. The sample is typical for a document event (ex. OnDocumentSave or OnDocumentApprove).

Copy

<event type="Integer value"
        event="String value"
        msgid="String value" >
    <timestamp>Date value</timestamp>
    <connectionid>Integer value</connectionid>
    <callerinfo sid="String value" 
              logonname="String value" 
              email="String value" 
              fullname="String value" 
              userkey="String value" 
              sessionid="Integer value" />
    <objectdata>
        <documentid>Integer value</documentid>
        <documentname>String value</documentname>
        <filename>String value</filename>
        <encoding>String value</encoding>
        <categoryid>Integer value</categoryid>
        <documenttitle>String value</documenttitle>
    </objectdata>
</event>

Element	Attribute	Description
event		This element acts as the root node of the document.
	type	The numeric identifier of the event.
	event	The name the event.
	msgid	A unique identifier of the specific event message
timestamp		The date and time of the event
connectionid		An identifier of the Web site
callerinfo		This element has attributes that contain data about the caller.
	sid	The caller's security identifier in the SDL format (ex. S-1-5-16)
	logonname	The caller's logon name in the DOMAIN\USERNAME format
	email	The caller's email address, if registered in CS
	fullname	The caller's fullname, if registered in CS
	userkey	The caller's Content Studio userkey
	sessionid	The caller's session identifier
objectdata		This element act as root node for elements that contains data about the affected document.
documentid		The identifier of the document
documentname		The logical file name of the affected document (ex. Unit1/Category1/pic1.gif).
filename		The file name of the affected document as it appears on disc.
encoding		The encoding (ex. utf-8), if existing, of the affected document.
categoryid		An identifier of the category where the affected document is placed.
documenttitle		The name of the affected document.

customData

Type: SystemString
User defined static data that has been specified for the Event action definition that triggered this event. The data is supplied via the command text field in the Event actions property window.

content

Type: ContentStudio.EventActionsICSContentContainer
A reference to Content Studio's implementation of the ICSContentContainer interface. The document content as it exists in Content Studio when the event is raised. Not all events supply content and the members of this ICSContentContainer can be null.

credentials

Type: ContentStudio.EventActionsICSCredentialsContainer
A reference to Content Studio's implementation of the ICSCredentialsContainer interface. This is used to pass system defined credentials to the custom implementation. The event handler can use these credentials when ex. communicating with an external system such as a database or a mail server.

cancel

Type: SystemBoolean
A reference to a Boolean parameter. Event handlers sets this parameter to true to indicate that all changes in the Content Studio event that triggered the event should be rolled back. If the value remains false after the call, the event in Content Studio will not be rolled back, regardless of the outcome of the operation performed by the event handler..

status

Type: SystemInt32
Implementations should set this parameter to zero to indicate success. All other values will throw an error in the Content Studio event that triggered the event causing data to be rolled back.

statusText

Type: SystemString
The textual representation of the error indicated in the Status parameter

Note
This interface was added in Content Studio version 5.3

The following sample shows a complete implementation of a very simple custom event handler that prevents document to be deleted in a category regardless of the permission of the caller. When a delete operation occurs, Content Studio raises the event and if the event handler sets the cancel parameter to trueContent Studio rolls back any change made to the system.

Compile the sample code to a DLL named SyncEventHandler.dll and place the resulting DLL in the same directory as the Content Studio binaries are installed (ex. C:\Program files\Teknikhuset\Content Studio 5\CSServer). In the Content Studio administrative interface navigate to the category where the event handler should be used and in the Category properties dialog, open the Event Actions dialog. If you have sufficient permissions you should be able to create a new event handler for a Synchronous event handler object. Select the OnDocumentDelete event and in the ProgId textbox write the following string:

SyncEventHandler.OnDocumentDeleteHandler, SyncEventHandler
This will tell Content Studio Service that it can find an implementation of the ICSEventHandler2 interface in a class named SyncEventHandler.OnDocumentDeleteHandler located in the assembly SyncEventHandler. Content Studio locates the assembly, creates an instance of the OnDocumentDeleteHandler class and casts the instance to its implementation of the ICSEventHandlerinterface and calls the EventHandler method on the retrieved interface.

using System;
using ContentStudio.EventActions;

namespace SyncEventHandler
{
    public class OnDocumentDeleteHandler : ContentStudio.EventActions.ICSEventHandler2
    {
        void ICSEventHandler2.EventHandler(string eventXMLArguments, 
                                           string customData, 
                                           ICSContentContainer content, 
                                           ICSCredentialsContainer credentials, 
                                           ref bool cancel, 
                                           out int status, 
                                           out string statusText)
        {
            status = -1;
            //Any custom message passed in?
            if((customData != null) || (customData.Length == 0))
                statusText = customData;
            else
                statusText = "Delete is forbidden in this category";
            cancel = true;
        }
    }
}

Imports System
Imports ContentStudio.EventActions

Namespace SyncEventHandler
    Public Class OnDocumentDeleteHandler 
                 Implements ContentStudio.EventActions.ICSEventHandler2

        Private Sub EventHandler(eventXMLArguments As String, _ 
                                 customData As String, _
                                 content As ICSContentContainer, _
                                 credentials As ICSCredentialsContainer, _
                                 ByRef cancel As Boolean, _
                                 <OutAttribute> ByRef ctatus As Integer, _
                                 <OutAttribute> ByRef ctatusText As String) _
                    Implements ICSEventHandler2.EventHandler

            status = -1
            'Handle the case when CustomData is Nothing
            If customData Is Nothing Then 
                customData = String.Empty
            End If
            'Any custom message passed in?
            If customData.Length = 0 Then
               statusText = "Delete is forbidden in this category"
            Else
                statusText = CustomData
            End If
            cancel = True
        End Sub
    End Class
End Namespace

Reference

Other Resources