DocumentImportHandler Class |
Namespace: CMS.DocumentEngine
public class DocumentImportHandler : AdvancedHandler<DocumentImportHandler, DocumentImportEventArgs>
The DocumentImportHandler type exposes the following members.
Name | Description | |
---|---|---|
![]() | DocumentImportHandler |
Name | Description | |
---|---|---|
![]() | Allow |
If true, the event is allowed to be raised
(Inherited from AdvancedHandlerTHandler, TArgs.) |
![]() | Continue |
Specifies whether the context of execution should continue. If set to false, no additional events will be fired.
(Inherited from AdvancedHandlerTHandler, TArgs.) |
![]() | ControlRecursion |
If true, the recursion control is enabled on this handler.
(Inherited from AbstractHandler.) |
![]() | Debug |
If true, the handler is included in debug
(Inherited from AbstractHandler.) |
![]() | EventArguments |
Handler arguments
(Inherited from AdvancedHandlerTHandler, TArgs.) |
![]() | IsBound |
Returns true if the handler has some events bound
(Inherited from AdvancedHandlerTHandler, TArgs.) |
![]() | IsStatic |
True, if the handler is a static handler
(Inherited from AbstractHandler.) |
![]() | LogItem |
Handlers log item of this handler
(Inherited from AdvancedHandlerTHandler, TArgs.) |
![]() | Name |
Event name. The name serves for debug purposes and to uniquely identify the handler.
(Inherited from AbstractHandler.) |
![]() | OneTime |
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.) |
![]() | Parent |
Parent handler
(Inherited from AdvancedHandlerTHandler, TArgs.) |
![]() | SupportsCancel |
If true, the handler supports cancelling of the event. If set and handler is already cancelled, throws an exception.
(Inherited from AdvancedHandlerTHandler, TArgs.) |
![]() | WasExecuted |
Returns true if the event was already executed
(Inherited from AbstractHandler.) |
![]() | WasFinished |
Flag indicating whether the event was finished or not
(Inherited from AdvancedHandlerTHandler, TArgs.) |
Name | Description | |
---|---|---|
![]() | AddAfter |
Adds the conditional after handler
(Inherited from AdvancedHandlerTHandler, TArgs.) |
![]() | AddBefore |
Adds the conditional before handler
(Inherited from AdvancedHandlerTHandler, TArgs.) |
![]() | AddEventTHandler |
Adds the event to the list
(Inherited from AbstractHandler.) |
![]() | AddFailure |
Adds the conditional after handler
(Inherited from AdvancedHandlerTHandler, TArgs.) |
![]() | AssignCurrentHandler |
Assigns the current handler to the event arguments
(Inherited from AbstractHandler.) |
![]() | Clear |
Clears all bound event handlers from the event and resets the number of executions of the event
(Inherited from AdvancedHandlerTHandler, TArgs.) |
![]() | CountExecution |
Counts the execution of the event
(Inherited from AbstractHandler.) |
![]() | Dispose |
Disposes the object
(Inherited from AdvancedHandlerTHandler, TArgs.) |
![]() | Finish |
Finishes the event and raises the After event actions
(Inherited from AdvancedHandlerTHandler, TArgs.) |
![]() | CheckBase |
Checks if the handler is base handler instance, and fires an exception if not
(Inherited from AbstractHandler.) |
![]() | CheckContinue |
Checks whether the action can continue and if not, fires an exception.
(Inherited from AdvancedHandlerTHandler, TArgs.) |
![]() | CheckEvent |
Checks if the handler is event handler instance, and fires an exception if not
(Inherited from AbstractHandler.) |
![]() | RaiseTArgs |
Raises the list of events
(Inherited from AbstractHandler.) |
![]() | RaiseAfter |
Raises the after event
(Inherited from AdvancedHandlerTHandler, TArgs.) |
![]() | RaiseBefore |
Raises the before event
(Inherited from AdvancedHandlerTHandler, TArgs.) |
![]() | RaiseFailure |
Raises the failure event
(Inherited from AdvancedHandlerTHandler, TArgs.) |
![]() | RemoveEventTHandler |
Removes the event from the list
(Inherited from AbstractHandler.) |
![]() | Reset |
Resets the number of executions of the event
(Inherited from AbstractHandler.) |
![]() | SetParent |
Sets the parent event of the event
(Inherited from AdvancedHandlerTHandler, TArgs.) |
![]() | StartEvent |
Initiates the new handler context
(Inherited from AdvancedHandlerTHandler, TArgs.) |
![]() | StartEvent(EventArgs) |
Initiates the new handler context
(Inherited from AdvancedHandlerTHandler, TArgs.) |
![]() | StartEvent(TArgs, Boolean) |
Initiates the new handler context
(Inherited from AdvancedHandlerTHandler, TArgs.) |
![]() | StartEvent(SiteImportSettings, TranslationHelper) |
Initiates the event handling
|
![]() | StartEvent(SiteImportSettings, TranslationHelper, TreeNode) |
Initiates the event handling
|
Name | Description | |
---|---|---|
![]() | CanContinue |
Checks whether the context of execution should continue.
(Defined by HandlersExtensions.) |
![]() | DontSupportCancel |
Disables the ability to cancel continuation of the execution context.
(Defined by HandlersExtensions.) |
![]() | FinishEvent |
Finishes the event and raises the After event actions.
(Defined by HandlersExtensions.) |
Name | Description | |
---|---|---|
![]() | After |
Raised after the event occurs
(Inherited from AdvancedHandlerTHandler, TArgs.) |
![]() | Before |
Raised before the event occurs
(Inherited from AdvancedHandlerTHandler, TArgs.) |
![]() | Failure |
Raised in case the event handler didn't properly call finalization
(Inherited from AdvancedHandlerTHandler, TArgs.) |