Click or drag to resize
SearchHandler Class
Search handler
Inheritance Hierarchy
SystemObject
  CMS.BaseAbstractHandler
    CMS.BaseAbstractAdvancedHandler
      CMS.BaseAdvancedHandlerSearchHandler, SearchEventArgs
        CMS.SearchSearchHandler

Namespace: CMS.Search
Assembly: CMS.Search (in CMS.Search.dll) Version: 11.0.0
Syntax
C#
public class SearchHandler : AdvancedHandler<SearchHandler, SearchEventArgs>

The SearchHandler type exposes the following members.

Constructors
  NameDescription
Public methodSearchHandler
Top
Properties
  NameDescription
Public propertyAllow
If true, the event is allowed to be raised
(Inherited from AdvancedHandlerTHandler, TArgs.)
Protected propertyContinue
Specifies whether the context of execution should continue. If set to false, no additional events will be fired.
(Inherited from AdvancedHandlerTHandler, TArgs.)
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
(Inherited from AdvancedHandlerTHandler, TArgs.)
Public propertyIsBound
Returns true if the handler has some events bound
(Inherited from AdvancedHandlerTHandler, TArgs.)
Public propertyIsStatic
True, if the handler is a static handler
(Inherited from AbstractHandler.)
Protected propertyLogItem
Handlers log item of this handler
(Inherited from AdvancedHandlerTHandler, TArgs.)
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
(Inherited from AdvancedHandlerTHandler, TArgs.)
Protected propertySupportsCancel
If true, the handler supports cancelling of the event. If set and handler is already cancelled, throws an exception.
(Inherited from AdvancedHandlerTHandler, TArgs.)
Public propertyWasExecuted
Returns true if the event was already executed
(Inherited from AbstractHandler.)
Protected propertyWasFinished
Flag indicating whether the event was finished or not
(Inherited from AdvancedHandlerTHandler, TArgs.)
Top
Methods
  NameDescription
Public methodAddAfter
Adds the conditional after handler
(Inherited from AdvancedHandlerTHandler, TArgs.)
Public methodAddBefore
Adds the conditional before handler
(Inherited from AdvancedHandlerTHandler, TArgs.)
Protected methodAddEventTHandler
Adds the event to the list
(Inherited from AbstractHandler.)
Public methodAddFailure
Adds the conditional after handler
(Inherited from AdvancedHandlerTHandler, TArgs.)
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.
(Inherited from AdvancedHandlerTHandler, TArgs.)
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
(Inherited from AdvancedHandlerTHandler, TArgs.)
Protected methodCountExecution
Counts the execution of the event
(Inherited from AbstractHandler.)
Public methodDispose
Disposes the object
(Inherited from AdvancedHandlerTHandler, TArgs.)
Protected methodFinish
Finishes the event and raises the After event actions
(Inherited from AdvancedHandlerTHandler, TArgs.)
Protected methodRaiseTArgs
Raises the list of events
(Inherited from AbstractHandler.)
Protected methodRaiseAfter
Raises the after event
(Inherited from AdvancedHandlerTHandler, TArgs.)
Protected methodRaiseBefore
Raises the before event
(Inherited from AdvancedHandlerTHandler, TArgs.)
Protected methodRaiseFailure
Raises the failure event
(Inherited from AdvancedHandlerTHandler, TArgs.)
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
(Inherited from AdvancedHandlerTHandler, TArgs.)
Public methodStartEvent
Initiates the new handler context
(Inherited from AdvancedHandlerTHandler, TArgs.)
Public methodStartEvent(EventArgs)
Initiates the new handler context
(Inherited from AdvancedHandlerTHandler, TArgs.)
Public methodStartEvent(TArgs, Boolean)
Initiates the new handler context
(Inherited from AdvancedHandlerTHandler, TArgs.)
Public methodStartEvent(SearchParameters, SearchResults)
Initiates the event handling
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
See Also