Reference - Global system events

Insert

Before
After
Failure

ObjectEventArgs

Properties

• Object (BaseInfo)

Occurs when a new object is created.

Update

Before
After
Failure

ObjectEventArgs

Properties

• Object (BaseInfo)

Occurs when the data of an existing object is updated.

Delete

Before
After
Failure

ObjectEventArgs

Properties

• Object (BaseInfo)

Occurs when an object is deleted.

GetContent

Execute

ObjectEventArgs

Properties

• Content (string)
• Object (BaseInfo)

Occurs before the system writes an object’s data into smart search indexes (when building or updating indexes).

Allows you to determine exactly how search indexes store object content.

LogChange

Before
After
Failure

LogObjectChangeEventArgs

Properties

• Settings (LogObjectChangeSettings)

Occurs when the system logs object changes for the purposes of staging and integration. For example, allows you to exclude specific objects from staging.

See also: Excluding content from staging and integration

CheckPermissions

Before
After
Failure

ObjectSecurityEventArgs

Properties

• Object (BaseInfo)
• Permission (PermissionsEnum)
• User (UserInfo)
• SiteName (string)
• Result (AuthorizationResultEnum)

Occurs when the system checks permissions for objects of the given type.

Sort

Before
After
Failure

 ObjectSortEventArgs

Properties

• InfoObject (BaseInfo)
• Ascending (bool)
• OrderColumn (string)
• NameColumn (string)

Occurs when sorting of objects is requested.

ChangeOrder

Before
After
Failure

ObjectChangeOrderEventArgs

Properties

• InfoObject (BaseInfo)
• NewOrder (int)
• RelativeOrder (int)
• OrderColumn (string)

 Occurs when a change in the order of objects is requested.

Insert

Before
After
Failure

DocumentEventArgs

Properties

• TargetParentNodeID (int)
• Node (TreeNode)
• TreeProvider (TreeProvider)

Occurs when a new document is created.

InsertNewCulture

Before
After
Failure

DocumentEventArgs

Properties

• Node (TreeNode)
• TreeProvider (TreeProvider)

Occurs when a new culture version is created for a document.

InsertLink

Before
After
Failure

DocumentEventArgs

Properties

• TargetParentNodeID (int)
• Node (TreeNode)
• TreeProvider (TreeProvider)

Occurs when creating new linked documents.

Update

Before
After
Failure

DocumentEventArgs

Properties

• Node (TreeNode)
• TreeProvider (TreeProvider)

Occurs when an existing document is updated.

Move

Before
After
Failure

DocumentEventArgs

Properties

• TargetParentNodeID (int)
• Node (TreeNode)
• TreeProvider (TreeProvider)

Occurs when a document is moved to a different position in the site’s content tree.

Copy

Before
After
Failure

DocumentEventArgs

Properties

• TargetParentNodeID (int)
• IncludeChildren (bool)
• Node (TreeNode)
• TreeProvider (TreeProvider)

Occurs when a new copy of a document is created.

Delete

Before
After
Failure

DocumentEventArgs

Properties

• Node (TreeNode)
• TreeProvider (TreeProvider)

Occurs when a document is deleted.

GetContent

Execute

DocumentSearchEventArgs

Properties

• Content (string)
• Node (TreeNode)
• Settings (SearchIndexSettingsInfo)
• IndexInfo (ISearchIndexInfo)
• SearchDocument (ISearchDocument)
• IsCrawler (bool)

Occurs before the system writes a document’s data into a Smart search index (when building or updating indexes).

Allows you to determine exactly how search indexes store document content.

LogChange

Before
After
Failure

LogDocumentChangeEventArgs

Properties

• Settings (LogDocumentChangeSettings)

Occurs when the system logs document changes for the purposes of staging and integration. For example, allows you to exclude specific documents from staging.

See also: Excluding content from staging and integration

CheckPermissions

Before
After
Failure

DocumentSecurityEventArgs

Properties

• Node (TreeNode)
• Permission (PermissionsEnum)
• User (UserInfo)
• SiteName (string)
• Result (AuthorizationResultEnum)

Occurs when the system checks permissions for documents.

Sort

Before
After
Failure

DocumentSortEventArgs

Properties

• ParentNodeId (int)
• Ascending (bool)
• SortType (DocumentSortEnum)

Occurs when sorting of documents is requested.

ChangeOrder

Before
After
Failure

DocumentChangeOrderEventArgs

Properties

• Node (TreeNode)

• OrderType (DocumentOrderEnum) Properties

• Node (TreeNode)

• NewOrder (int)

• RelativeOrder (bool)

Occurs when a change in the order of documents is requested.

SaveAttachment

Before
After
Failure

DocumentEventArgs

Properties

• Attachment (AttachmentInfo)
• Node (TreeNode)
• TreeProvider (TreeProvider)

Occurs when a file attachment is added to a document or updated.

DeleteAttachment

Before
After
Failure

DocumentEventArgs

Properties

• Attachment (AttachmentInfo)
• Node (TreeNode)
• TreeProvider (TreeProvider)

Occurs when a file attachment is removed from a document.

AuthorizeDocument

Execute

DocumentAuthorizationEventArgs

Properties

• User (UserInfo)
• Data (DataSet)
• Document (TreeNode)
• PermissionName (string)
• AuthorizationResult (AuthorizationResultEnum)

Occurs when the system performs a security check for the permissions of specific documents.

FilterDataSetByPermissions

Execute

DocumentAuthorizationEventArgs

Properties

• User (UserInfo)
• Data (DataSet)
• Document (TreeNode)
• PermissionName (string)
• AuthorizationResult (AuthorizationResultEnum)

Occurs when the system filters a set of documents according to the document permissions of a user.

Approve

Before
After
Failure

WorkflowEventArgs

Properties

• Document (TreeNode)
• PreviousStep (WorkflowStepInfo) - only in the After event
• TreeProvider (TreeProvider)

Occurs when a document is approved to the next step.

Reject

Before
After
Failure

WorkflowEventArgs

Properties

• Document (TreeNode)
• PreviousStep (WorkflowStepInfo) - only in the After event
• TreeProvider (TreeProvider)

Occurs when a document is rejected back to a previous step

Publish

Before
After
Failure

WorkflowEventArgs

Properties

• Document (TreeNode)
• PublishedDocument(TreeNode) - only in the After event
• PreviousStep (WorkflowStepInfo) - only in the After event
• TreeProvider (TreeProvider)

Occurs when a document reaches the published step.

Archive

Before
After
Failure

WorkflowEventArgs

Properties

• Document (TreeNode)
• PreviousStep (WorkflowStepInfo) - only in the After event
• TreeProvider (TreeProvider)

Occurs when a document is archived.

Action

Before
After
Failure

WorkflowActionEventArgs<TreeNode, BaseInfo, WorkflowActionEnum>

Requires references to:

• CMS.WorkflowEngine
• CMS.DataEngine

Occurs when executing advanced workflow action steps.

SaveVersion

Before
After
Failure

WorkflowEventArgs

Properties

• Document (TreeNode)
• VersionHistory (VersionHistoryInfo)
• VersionNumber (string)
• VersionComment (string)
• TreeProvider (TreeProvider)

Occurs when the edited version of a document is updated.

SaveAttachmentVersion

Before
After
Failure

WorkflowEventArgs

Properties

• Document (TreeNode)
• Attachment (AttachmentInfo)
• TreeProvider (TreeProvider)

Occurs when an attachment is updated or inserted for the edited version of a document.

RemoveAttachmentVersion

Before
After
Failure

WorkflowEventArgs

Properties

• Document (TreeNode)
• Attachment (AttachmentInfo)
• TreeProvider (TreeProvider)

Occurs when an attachment is removed for the edited version of a document.

CheckOut

Before
After
Failure

WorkflowEventArgs

Properties

• Document (TreeNode)
• TreeProvider (TreeProvider)

Occurs when a document is checked-out.

CheckIn

Before
After
Failure

WorkflowEventArgs

Properties

• Document (TreeNode)
• TreeProvider (TreeProvider)

Occurs when a document is checked-in.

UndoCheckOut

Before
After
Failure

WorkflowEventArgs

Properties

• Document (TreeNode)
• TreeProvider (TreeProvider)

Occurs when a user performs the undo check-out action.

Authenticate

Execute

AuthenticationEventArgs

Properties

• User (UserInfo)
• UserName (string)
• Password (string)

Occurs when authenticating users.

See also: Handling custom external authentication

AuthenticationRequested

Execute

AuthenticationRequestEventArgs

Properties

• RequestedUrl (string)

Occurs when a user accesses a restricted section of Kentico and the user’s authentication is required.

MultiFactorAuthenticate

Execute

AuthenticationEventArgs

Properties

• Passcode (string)
• UserName (string)
• Password (string)

Occurs when a user tries to sign in to Kentico with multi-factor authentication enabled.

AuthorizeResource

Execute

AuthorizationEventArgs

Properties

• User (UserInfo)
• ResourceName (string)
• PermissionName (string)
• Authorized (bool)

Occurs when checking the permissions for modules.

AuthorizeClass

Execute

AuthorizationEventArgs

Properties

• User (UserInfo)
• ClassName (string)
• PermissionName (string)
• Authorized (bool)

Occurs when performing security checks for object type or document type permissions.

AuthorizeUIElement

Execute

AuthorizationEventArgs

Properties

• User (UserInfo)
• ElementName (string)
• PermissionName (string)
• Authorized (bool)

Occurs when checking permissions for UI elements.

SignOut

Before
After
Failure

SignOutEventArgs

Properties

• User (UserInfo)
• SignOutUrl (string)

Occurs when a user signs out from a website.

LogTask

Before
After
Failure

StagingLogTaskEventArgs

Properties

• Object (BaseInfo)
• Task (StagingTaskInfo)

Occurs when creating staging tasks on the source server after a document or object is changed in the system.

See also:

• Excluding content from staging and integration
• Automatically synchronizing staging and integration tasks

Synchronize

Before
After
Failure

CMSEventArgs

Occurs on the source server when synchronizing staging tasks — once per synchronize action, even when processing multiple tasks.

SynchronizeTask

Before
After
Failure

StagingTaskEventArgs

Properties

• Task (StagingTaskInfo)

Occurs on the source server when synchronizing staging tasks — separately for every processed task.

ProcessTask

Before
After
Failure

StagingSynchronizationEventArgs

Properties

• TaskType (TaskTypeEnum)
• ObjectType (string)
• TaskData (DataSet)
• TaskBinaryData (DataSet)
• TaskHandled (bool)
• SyncManager (ISyncManager)

Occurs on the target server when processing incoming staging tasks.

The processing of the staging tasks then also triggers the corresponding ObjectEvents (Insert, Update, Delete, etc.). If the CMSStagingUseTreeCustomHandlers web.config key is set to true, the DocumentEvents are triggered, too.

LogInternalTask

Before
After
Failure

IntegrationTaskEventArgs

Properties

• Task (IntegrationTaskInfo)
• Object (BaseInfo)

Occurs when creating outgoing integration tasks after a document or object in the system is changed.

LogExternalTask

Before
After
Failure

IntegrationTaskEventArgs

Properties

• Task (IntegrationTaskInfo)
• Object (BaseInfo)

 Occurs when the system creates incoming tasks provided by an integration connector.

Import

Before
After
Failure

ImportBaseEventArgs

Properties

• Settings (SiteImportSettings)

Occurs at the start of the import process.

ImportObject

Before
After
Failure

ImportEventArgs

Properties

• Settings (SiteImportSettings)
• Object (BaseInfo)
• ParentObject (BaseInfo)
• Parameters (ImportParameters)

Occurs once for every imported object.

ImportObjects

Before
After
Failure

ImportDataEventArgs

Properties

• Settings (SiteImportSettings)
• Data (DataSet)
• ObjectType (string)
• SiteObjects (bool)
• ParentImported (bool)

Occurs when importing sets of objects.

ImportBinding

Before
After
Failure

ImportEventArgs

Properties

• Settings (SiteImportSettings)
• Object (BaseInfo)
• ParentObject (BaseInfo)
• Parameters (ImportParameters)

Occurs once for every imported binding object.

ImportBindings

Before
After
Failure

ImportEventArgs

Properties

• Settings (SiteImportSettings)
• Object (BaseInfo)
• ParentObject (BaseInfo)
• Parameters (ImportParameters)

Occurs when importing binding objects.

ImportChild

Before
After
Failure

ImportEventArgs

Properties

• Settings (SiteImportSettings)
• Object (BaseInfo)
• ParentObject (BaseInfo)
• Parameters (ImportParameters)

Occurs once for every imported child object.

ImportChildren

Before
After
Failure

ImportEventArgs

Properties

• Settings (SiteImportSettings)
• Object (BaseInfo)
• ParentObject (BaseInfo)
• Parameters (ImportParameters)

Occurs when importing child objects.

GetImportData

Before
After
Failure

ImportGetDataEventArgs

Properties

• Settings (SiteImportSettings)
• Data (DataSet)
• Object (BaseInfo)
• ObjectType (string)
• SiteObjects (bool)
• SelectionOnly (bool)

Occurs when importing data. Allows you to work with the data set in the import package created for a specific object types.

• Use the Before event type to modify the data in the import package (for example add data from an external source).
• Use the After event type to modify the data after the import package has been loaded.

ProcessFileOperation

Before
After
Failure

ImportProcessFileOperationEventArgs

Properties

• Operation (FileOperation)
• Settings (SiteImportSettings)

Occurs when processing file/folder operations in the import package.

ImportCanceled

Execute

ImportBaseEventArgs

Properties

• Settings (SiteImportSettings)

Occurs when a user cancels the import process.

ImportError

Execute

ImportErrorEventArgs

Properties

• Exception (Exception)
• Settings (SiteImportSettings)

Fires when an error occurs during the import process.

Export

Before
After
Finished
Failure

ExportEventArgs

Properties

• Settings (SiteExportSettings)
• SiteObjects (bool)

Occurs at the start of the export process.

ExportObjects

Before
After
Failure

ExportEventArgs

Properties

• Settings (SiteExportSettings)
• Data (DataSet)
• ObjectType (string)
• SiteObjects (bool)

Occurs when exporting objects.

GetExportData

Before
After
Failure

ExportGetDataEventArgs

Properties

• Settings (SiteExportSettings)
• Data (DataSet)
• ObjectType (string)
• WhereCondition (string)
• ChildData (bool)
• SelectionOnly (bool)
• Parameters(QueryDataParameters)

Occurs when exporting data. Allows you to work with the data set in the export package created for specific object types.

• Use the Before event type to extract data from the export package.
• Use the After event type to modify the data in the export package.

SingleExportSelection

Execute

SingleExportSelectionEventArgs

Properties

• Settings (SiteExportSettings)
• InfoObject (BaseInfo)
• SelectedObject (List<string>)

Occurs when selecting related objects during single object export. Allows you to attach related objects to the export package.

ExportCanceled

Execute

ExportBaseEventArgs

Properties

• Settings (SiteExportSettings)

Occurs when a user cancels the export process.

ExportError

Execute

ExportErrorEventArgs

Properties

• Exception (Exception)
• Settings (SiteExportSettings)

Fires when an error occurs during the export process.

ExportDocuments

Before
After
Failure

DocumentsExportEventArgs

Properties

• Settings (SiteExportSettings)
• Data (DataSet)
• ObjectType (string)
• SiteObjects (bool)

Occurs when exporting documents.

ImportDocument

Before
After
Failure

DocumentImportEventArgs

Properties

• Document (TreeNode)
• Settings (SiteImportSettings)

Occurs once for every imported document.

ImportDocuments

Before
After
Failure

DocumentImportEventArgs

Properties

• Document (TreeNode)
• Settings (SiteImportSettings)

Occurs when importing documents.

RegisterRecords

Execute

ColumnsTranslationEventArgs

Properties

• ObjectType (string)
• Data (IDataContainer)
• TranslationHelper (TranslationHelper)

Occurs when exporting objects. Allows you to provide additional information for the translation of custom ID fields.

TranslateColumns

Execute

ColumnsTranslationEventArgs

Properties

• ObjectType (string)
• Data (IDataContainer)
• TranslationHelper (TranslationHelper)

Occurs when importing objects. Allows you to translate the values of custom ID fields using the provided information.

Insert

Before
After
Failure

BizFormItemEventArgs

Properties

• Item (BizFormItem)

Occurs when inserting new form items (data records of on-line forms).

Update

Before
After
Failure

BizFormItemEventArgs

Properties

• Item (BizFormItem)

Occurs when updating form data records.

Delete

Before
After
Failure

BizFormItemEventArgs

Properties

• Item (BizFormItem)

Occurs when deleting data records from forms.

ResolveMacros

Before
After
Failure 

ResolveMacroEventArgs

Properties

• MacroResolver (MacroResolver)
• TextToResolve (string)
• Newsletter (NewsletterInfo)
• Issue (IssueInfo)

Fires when all newsletter text macros are being resolved.

LogConversion

Before
After
Failure

CMSEventArgs<LogRecord>

Properties

• Conversion (LogRecord)

Occurs when a conversion is logged.

ProcessLogRecord

Before
After
Failure

CMSEventArgs<LogRecord>

Properties

• LogRecord (LogRecord)

Occurs when the web analytics log is being processed.

ActivityLogged

Before
After
Failure

ActivityLoggedEventArgs

Properties

• ActivityData (ActivityData)

Fires immediately when on-line marketing activities of any type occur in the system.

The event does not trigger for custom activities logged using the ActivityInfoProvider.SetActivityInfo method.

MoveToNextStep

Before
After
Failure

AutomationEventArgs

Properties

• InfoObject (BaseInfo)
• StateObject (AutomationStateInfo)
• PreviousStep (WorkflowStepInfo)

Occurs when an automation process moves to the next step.

MoveToPreviousStep

Before
After
Failure

AutomationEventArgs

Properties

• InfoObject (BaseInfo)
• StateObject (AutomationStateInfo)
• PreviousStep (WorkflowStepInfo)

Occurs when an automation process moves back to the previous step.

Action

Before
After
Failure

WorkflowActionEventArgs<BaseInfo, AutomationStateInfo, AutomationActionEnum>

Requires references to:

• CMS.WorkflowEngine
• CMS.DataEngine

Occurs when the system executes a marketing automation action step.

ProcessTrigger

Before
After
Failure

AutomationProcessTriggerEventArgs

Properties

• Options (TriggerOptions)
• TriggerInfo (ObjectWorkflowTriggerInfo)

Occurs when processing triggers for automation processes.

Evaluates the trigger condition and allows you to, for example, insert data into the condition.

PageNotFound

Before
After
Failure

URLRewritingEventArgs

Properties

• Parameters (URLRewritingParams)

Occurs when the system redirects users to a Page not found error page (after requesting a URL that returns a 404 HTTP status code).

ProcessRewritingResult

Before
After
Failure

 URLRewritingEventArgs

Properties

• Parameters (URLRewritingParams)

Occurs at the end of the rewriting process for all URLs. If there are redirects during the rewriting, the event is only triggered for the final URL at the end of the process.

Use the Before event if you need to perform custom rewriting. Use the After event to perform additional custom actions after the default rewriting.

ProcessABTest

Execute

ProcessABTestEventArgs

Properties

• PageInfo (PageInfo)
• ReturnedPageInfo (PageInfo)
• SiteName (String)
• ViewMode (ViewModeEnum)

Occurs when the system starts rewriting the URL of a page with a running A/B test.

Exception

Execute

SystemEventArgs

Properties

• Exception (Exception)
• LogException (bool)

Fires when an unhandled exception occurs in the system.

Delete

Before
After
Failure

SiteDeletionEventArgs

Properties

• User (UserInfo)
• Context (CMSActionContext)
• Info (DeletionInfo)

Occurs when a site is deleted from the system.

ExecuteQuery

Before
After
Failure

ExecuteQueryEventArgs<DataSet>

Properties

• Connection (IDataConnection)
• Query (QueryParameters)
• Result (DataSet)

Occurs when the system executes a database query.

See also: Working with database queries in the API

ExecuteNonQuery

Before
After
Failure

ExecuteQueryEventArgs<int>

Properties

• Connection (IDataConnection)
• Result (DataSet)

Occurs when the system executes a non-query database operation.

ExecuteScalar

Before
After
Failure

ExecuteQueryEventArgs<object>

Properties

• Connection (IDataConnection)
• Query (QueryParameters)
• Result (DataSet)

Occurs when the system executes a scalar query.

ExecuteReader

Before
After
Failure

ExecuteQueryEventArgs<DbDataReader>

Properties

• Connection (IDataConnection)
• Result (DataSet)

Occurs when the system runs a database DataReader.

PreInitialized

Execute

EventArgs

Occurs when the application finishes pre-initialization (preparation of things unrelated to the database).

Handlers need to be assigned in the PreInit method of modules or CMSLoaderAttribute classes in App_Code.

Initialized

Execute

EventArgs

Occurs when the application finishes initialization and starts (including the database connection). Handle this event to perform standard application start events.

PostStart

Execute

EventArgs

Occurs at the end of the first application request. Allows you to perform asynchronous tasks needed for application startup that do not influence the output of requests.

End

Execute

EventArgs

Occurs when the application ends.

Error

Execute

EventArgs

Fires when an error occurs in the application.

SessionStart

Execute

EventArgs

Occurs when an HTTP session starts for a client.

SessionEnd

Execute

EventArgs

Occurs when an HTTP session ends for a client. May not be raised if the application is configured to use a session state mode different than InProc.

GetVaryByCustomString

Execute

GetVaryByCustomStringEventArgs

Properties

• Result (string)
• Context (HttpContext)
• Custom (string)

Occurs when the application processes variables in custom names of output cache keys.

Prepare

Execute

EventArgs

Occurs before the request processing begins.

Begin

Execute

EventArgs

Occurs when the request processing starts.

Authenticate

Execute

EventArgs

Occurs when authenticating requests.

Authorize

Execute

EventArgs

Occurs when authorizing requests. If the application loads the response from the output cache, the life cycle skips to the End event.

PostAuthorize

Execute

EventArgs

Occurs after the request’s user is authorized.

MapRequestHandler

Execute

EventArgs

Occurs when a handler is selected to respond to the request. The system performs URL rewriting during the event. After this event, the application can access the context of the displayed page and current document (page info).

PostMapRequestHandler

Execute

EventArgs

Occurs when the application has mapped the request to the appropriate event handler.

AcquireRequestState

Execute

EventArgs

Occurs when acquiring the request state.

End

Execute

EventArgs

Occurs at the end of the request processing (last chance to perform actions before the client receives the response).

RunEndRequestTasks

Execute

EventArgs

Allows you to execute background tasks at the end of the request processing, but cannot influence the response sent to the client.

Finalize

Execute

EventArgs

Occurs when the request is finalized. Use to cleanup and release any resources used by the request.

UpdateSession

Before
After
Failure

CMSEventArgs

Occurs when an HTTP session is updated.

UpdateSessionData

Execute

CMSEventArgs<SessionInfo>

Properties

• Parameter (SessionInfo)

Occurs when the data of an HTTP session is updated.

OnBeforeUserControlInit

EventArgs

bool

OnAfterUserControlInit

EventArgs

void

OnBeforeUserControlLoad

EventArgs

bool

OnAfterUserControlLoad

EventArgs

void

OnBeforeUserControlPreRender

EventArgs

bool

OnAfterUserControlPreRender

EventArgs

void

OnBeforeUserControlRender

HtmlTextWriter

bool

OnAfterUserControlRender

HtmlTextWriter

void

OnBeforePagePreInit

EventArgs

bool

OnAfterPagePreInit

EventArgs

void

OnBeforePageInit

EventArgs

bool

OnAfterPageInit

EventArgs

void

OnBeforePageLoad

EventArgs

bool

OnAfterPageLoad

EventArgs

void

OnBeforePagePreRender

EventArgs

bool

OnAfterPagePreRender

EventArgs

void

OnBeforePageRender

HtmlTextWriter

bool

OnAfterPageRender

HtmlTextWriter

void