Click or drag to resize
AdvancedHandlerTHandler, TArgs Class
Generic handler class
Inheritance Hierarchy
SystemObject
  CMS.BaseAbstractHandler
    CMS.BaseAbstractAdvancedHandler
      CMS.BaseAdvancedHandlerTHandler, TArgs
        More...

Namespace: CMS.Base
Assembly: CMS.Base (in CMS.Base.dll) Version: 12.0.0
Syntax
C#
public abstract class AdvancedHandler<THandler, TArgs> : AbstractAdvancedHandler
where THandler : new(), AdvancedHandler<THandler, TArgs>
where TArgs : new(), CMSEventArgs

Type Parameters

THandler
TArgs

The AdvancedHandlerTHandler, TArgs type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyAllow
If true, the event is allowed to be raised
Protected propertyContinue
Specifies whether the context of execution should continue. If set to false, no additional events will be fired.
(Overrides AbstractAdvancedHandlerContinue.)
Public propertyControlRecursion
If true, the recursion control is enabled on this handler.
(Inherited from AbstractHandler.)
Public propertyDebug
If true, the handler is included in debug
(Inherited from AbstractHandler.)
Public propertyEventArguments
Handler arguments
Public propertyIsBound
Returns true if the handler has some events bound
Public propertyIsStatic
True, if the handler is a static handler
(Inherited from AbstractHandler.)
Protected propertyLogItem
Handlers log item of this handler
Public propertyName
Event name. The name serves for debug purposes and to uniquely identify the handler.
(Inherited from AbstractHandler.)
Public propertyOneTime
If true, this event can be executed only once. If the event was already executed, and new handler is added, it executes immediately.
(Inherited from AbstractHandler.)
Public propertyParent
Parent handler
Protected propertySupportsCancel
If true, the handler supports cancelling of the event. If set and handler is already cancelled, throws an exception.
(Overrides AbstractAdvancedHandlerSupportsCancel.)
Public propertyWasExecuted
Returns true if the event was already executed
(Inherited from AbstractHandler.)
Protected propertyWasFinished
Flag indicating whether the event was finished or not
Top
Methods
  NameDescription
Public methodAddAfter
Adds the conditional after handler
Public methodAddBefore
Adds the conditional before handler
Protected methodAddEventTHandler
Adds the event to the list
(Inherited from AbstractHandler.)
Public methodAddFailure
Adds the conditional after handler
Protected methodAssignCurrentHandler
Assigns the current handler to the event arguments
(Inherited from AbstractHandler.)
Protected methodCheckBase
Checks if the handler is base handler instance, and fires an exception if not
(Inherited from AbstractHandler.)
Protected methodCheckContinue
Checks whether the action can continue and if not, fires an exception.
Protected methodCheckEvent
Checks if the handler is event handler instance, and fires an exception if not
(Inherited from AbstractHandler.)
Public methodClear
Clears all bound event handlers from the event and resets the number of executions of the event
(Overrides AbstractHandlerClear.)
Protected methodCountExecution
Counts the execution of the event
(Inherited from AbstractHandler.)
Public methodDispose
Disposes the object
(Overrides AbstractHandlerDispose.)
Protected methodFinish
Finishes the event and raises the After event actions
(Overrides AbstractAdvancedHandlerFinish.)
Protected methodRaiseTArgs
Raises the list of events
(Inherited from AbstractHandler.)
Protected methodRaiseAfter
Raises the after event
Protected methodRaiseBefore
Raises the before event
Protected methodRaiseFailure
Raises the failure event
Protected methodRemoveEventTHandler
Removes the event from the list
(Inherited from AbstractHandler.)
Public methodReset
Resets the number of executions of the event
(Inherited from AbstractHandler.)
Public methodSetParent
Sets the parent event of the event
(Overrides AbstractHandlerSetParent(AbstractHandler).)
Public methodStartEvent
Initiates the new handler context
Public methodStartEvent(EventArgs)
Initiates the new handler context
Public methodStartEvent(TArgs, Boolean)
Initiates the new handler context
Top
Extension Methods
  NameDescription
Public Extension MethodCanContinue
Checks whether the context of execution should continue.
(Defined by HandlersExtensions.)
Public Extension MethodDontSupportCancel
Disables the ability to cancel continuation of the execution context.
(Defined by HandlersExtensions.)
Public Extension MethodFinishEvent
Finishes the event and raises the After event actions.
(Defined by HandlersExtensions.)
Top
Events
  NameDescription
Public eventAfter
Raised after the event occurs
Public eventBefore
Raised before the event occurs
Public eventFailure
Raised in case the event handler didn't properly call finalization
Top
See Also
Inheritance Hierarchy
SystemObject
  CMS.BaseAbstractHandler
    CMS.BaseAbstractAdvancedHandler
      CMS.BaseAdvancedHandlerTHandler, TArgs
        CMS.ActivitiesActivityBulkInsertPerformedHandler
        CMS.AutomationAutomationActionHandler
        CMS.AutomationAutomationHandler
        CMS.AutomationAutomationProcessTriggerHandler
        CMS.BaseAdvancedHandler
        CMS.BaseAdvancedHandlerTParameter
        CMS.BaseQueryHandler
        CMS.BaseThreadHandler
        CMS.BaseThreadQueueWorkerHandlerTItem
        CMS.Base.Web.UIGetMediaDataHandler
        CMS.Base.Web.UIHeaderActionControlCreatedHandler
        CMS.CMSImportExportExportGetDataHandler
        CMS.CMSImportExportExportHandler
        CMS.CMSImportExportImportBaseHandler
        CMS.CMSImportExportImportBindingsHandler
        CMS.CMSImportExportImportDataHandler
        CMS.CMSImportExportImportGetDataHandler
        CMS.CMSImportExportImportHandler
        CMS.CMSImportExportImportObjectTypeHandler
        CMS.CMSImportExportImportProcessFileOperationHandler
        CMS.CMSImportExportProcessDeleteTaskHandler
        CMS.CMSImportExportTranslateColumnsHandler
        CMS.ContactManagementRecalculateAfterContactActionsBatchHandler
        CMS.ContactManagementRecalculateScoreForAllContactsHandler
        CMS.CustomTablesCustomTableItemHandler
        CMS.DataEngineBulkDeleteHandler
        CMS.DataEngineBulkInsertDataHandler
        CMS.DataEngineBulkInsertHandler
        CMS.DataEngineBulkUpdateHandler
        CMS.DataEngineDataDefinitionItemChangeHandler
        CMS.DataEngineDataDefinitionItemHandler
        CMS.DataEngineExecuteQueryHandlerTResult
        CMS.DataEngineLogObjectChangeHandler
        CMS.DataEngineObjectChangeOrderHandler
        CMS.DataEngineObjectDataEventHandler
        CMS.DataEngineObjectHandler
        CMS.DataEngineObjectSecurityHandler
        CMS.DataEngineObjectSortHandler
        CMS.DocumentEngineDocumentChangeOrderHandler
        CMS.DocumentEngineDocumentDataEventHandler
        CMS.DocumentEngineDocumentHandler
        CMS.DocumentEngineDocumentImportHandler
        CMS.DocumentEngineDocumentSecurityHandler
        CMS.DocumentEngineDocumentsExportHandler
        CMS.DocumentEngineDocumentsImportHandler
        CMS.DocumentEngineDocumentSortHandler
        CMS.DocumentEngineLogDocumentChangeHandler
        CMS.DocumentEnginePageInfoHandler
        CMS.DocumentEngineWorkflowActionHandler
        CMS.DocumentEngineWorkflowHandler
        CMS.EventLogEventLogHandler
        CMS.IOIOHandler
        CMS.MembershipSignOutHandler
        CMS.ModulesBuildNuSpecManifestHandler
        CMS.NewslettersGeneratePreviewHandler
        CMS.NewslettersGenerateQueueItemsHandler
        CMS.NewslettersResolveMacrosHandler
        CMS.OnlineFormsBizFormItemHandler
        CMS.OutputFilterOutputCacheHandler
        CMS.PortalEngineMoveWebPartHandler
        CMS.PortalEnginePageTemplateCloneHandler
        CMS.PortalEngineRemoveWebPartHandler
        CMS.Search.AzureCreateDocumentHandler
        CMS.Search.AzureCreateFieldHandler
        CMS.Search.AzureCreateFieldsHandler
        CMS.SearchSearchHandler
        CMS.SiteProviderSiteDeletionHandler
        CMS.SynchronizationIntegrationTaskHandler
        CMS.SynchronizationStagingLogTaskHandler
        CMS.SynchronizationStagingSynchronizationHandler
        CMS.SynchronizationStagingTaskHandler
        CMS.TranslationServicesCreateSubmissionItemHandler
        CMS.TranslationServicesProcessTranslationHandler
        CMS.URLRewritingEngineURLRewritingHandler
        CMS.WebAnalyticsGenerateStatisticsHandler
        CMS.WebAnalyticsInsertAnalyticsJSHandler
        CMS.WebAnalyticsLogConversionHandler
        CMS.WebAnalyticsProcessAnalyticsServiceHandler
        CMS.WebAnalyticsProcessLogRecordHandler
        Kentico.Forms.Web.MvcSaveBizFormItemHandler