Class ApplicationEvents
Holds events that allow performing of custom logic at specific points within the application's life cycle.
public sealed class ApplicationEvents- Inheritance
-
objectApplicationEvents
- Extension Methods
Remarks
The events are represented by fields of the SimpleHandler type. Handler methods need to be assigned to the Execute event of individual fields.
Some of the ApplicationEvents are not raised out of web-based applications without the CMSApplication module (when using the Kentico API externally).
Fields
End
Occurs just before the application shuts down.
public static SimpleHandler EndField Value
Remarks
Fires only once during the application lifetime.
This event only occurs for web-based applications. For example, does not occur when using the Kentico API in an external console application.
Do not use this event for performing critical actions. Code execution can be forcibly interrupted after a short period of time.
Error
Occurs when an unhandled exception is thrown.
public static SimpleHandler ErrorField Value
Remarks
This event only occurs for web-based applications. For example, does not occur when using the Kentico API in an external console application.
ExecuteMigrations
Occurs when an custom programmatic migrations are executed during update process.
public static MigrationExecutionHandler ExecuteMigrationsField Value
Finalize
Occurs just before the application shuts down, after the End application event.
public static SimpleHandler FinalizeField Value
Remarks
This event is not intended to be used in custom code. Use End instead.
The purpose of the event is to call actions after custom code execution within the End event.
Fires only once during the application lifetime.
This event only occurs for web-based applications. For example, does not occur when using the Kentico API in an external console application.
Do not use this event for performing critical actions. Code execution can be forcibly interrupted after a short period of time.
Initialized
Occurs after the application finishes initialization.
public static SimpleHandler InitializedField Value
Remarks
When this event occurs, the database connection is available and all modules are initialized.
Fires only once during the application lifetime. Handlers need to be attached in the PreInit or Init of modules.
PostStart
Occurs after the end of the first application request after successful initialization.
public static SimpleHandler PostStartField Value
Remarks
Fires only once during the application lifetime. Use to perform additional async tasks needed for application startup.
Response time can be affected by long running operations.
This event only occurs for web-based applications. For example, does not occur when using the Kentico API in an external console application.
PreInitialized
Occurs after the application pre-initialization.
public static SimpleHandler PreInitializedField Value
Remarks
Fires only once during the application lifetime. Handlers need to be attached in the PreInit of modules.
UpdateData
Occurs when the application is ready to perform an upgrade routine (code-based migrations).
public static SimpleHandler UpdateDataField Value
Remarks
This event is not intended to be used in custom code.
This event fires on every application start after application core life-cycle is complete Init().
UpdateSqlData
Occurs when the application is ready to perform SQL migrations.
public static SimpleHandler UpdateSqlDataField Value
Remarks
This event is not intended to be used in custom code.
This event fires on every application start before application core life-cycle is complete Init().