SearchHandler Class

Search handler

Inheritance Hierarchy

System.Object
  CMS.Base.AbstractHandler
    CMS.Base.AbstractAdvancedHandler
      CMS.Base.AdvancedHandler<SearchHandler, SearchEventArgs>
        CMS.Search.SearchHandler

Namespace: CMS.Search
Assembly: CMS.Search (in CMS.Search.dll) Version: 11.0.0

Syntax

public class SearchHandler : AdvancedHandler<SearchHandler, SearchEventArgs>

The SearchHandler type exposes the following members.

Constructors

	Name	Description
Public method	SearchHandler

Properties

	Name	Description
Public property	Allow	If true, the event is allowed to be raised (Inherited from AdvancedHandler<THandler, TArgs>.)
Protected property	Continue	Specifies whether the context of execution should continue. If set to false, no additional events will be fired. (Inherited from AdvancedHandler<THandler, TArgs>.)
Public property	ControlRecursion	If true, the recursion control is enabled on this handler. (Inherited from AbstractHandler.)
Public property	Debug	If true, the handler is included in debug (Inherited from AbstractHandler.)
Public property	EventArguments	Handler arguments (Inherited from AdvancedHandler<THandler, TArgs>.)
Public property	IsBound	Returns true if the handler has some events bound (Inherited from AdvancedHandler<THandler, TArgs>.)
Public property	IsStatic	True, if the handler is a static handler (Inherited from AbstractHandler.)
Protected property	LogItem	Handlers log item of this handler (Inherited from AdvancedHandler<THandler, TArgs>.)
Public property	Name	Event name. The name serves for debug purposes and to uniquely identify the handler. (Inherited from AbstractHandler.)
Public property	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.)
Public property	Parent	Parent handler (Inherited from AdvancedHandler<THandler, TArgs>.)
Protected property	SupportsCancel	If true, the handler supports cancelling of the event. If set and handler is already cancelled, throws an exception. (Inherited from AdvancedHandler<THandler, TArgs>.)
Public property	WasExecuted	Returns true if the event was already executed (Inherited from AbstractHandler.)
Protected property	WasFinished	Flag indicating whether the event was finished or not (Inherited from AdvancedHandler<THandler, TArgs>.)

Methods

	Name	Description
Public method	AddAfter	Adds the conditional after handler (Inherited from AdvancedHandler<THandler, TArgs>.)
Public method	AddBefore	Adds the conditional before handler (Inherited from AdvancedHandler<THandler, TArgs>.)
Protected method	AddEvent<THandler>	Adds the event to the list (Inherited from AbstractHandler.)
Public method	AddFailure	Adds the conditional after handler (Inherited from AdvancedHandler<THandler, TArgs>.)
Protected method	AssignCurrentHandler	Assigns the current handler to the event arguments (Inherited from AbstractHandler.)
Protected method	CheckBase	Checks if the handler is base handler instance, and fires an exception if not (Inherited from AbstractHandler.)
Protected method	CheckContinue	Checks whether the action can continue and if not, fires an exception. (Inherited from AdvancedHandler<THandler, TArgs>.)
Protected method	CheckEvent	Checks if the handler is event handler instance, and fires an exception if not (Inherited from AbstractHandler.)
Public method	Clear	Clears all bound event handlers from the event and resets the number of executions of the event (Inherited from AdvancedHandler<THandler, TArgs>.)
Protected method	CountExecution	Counts the execution of the event (Inherited from AbstractHandler.)
Public method	Dispose	Disposes the object (Inherited from AdvancedHandler<THandler, TArgs>.)
Protected method	Finish	Finishes the event and raises the After event actions (Inherited from AdvancedHandler<THandler, TArgs>.)
Protected method	Raise<TArgs>	Raises the list of events (Inherited from AbstractHandler.)
Protected method	RaiseAfter	Raises the after event (Inherited from AdvancedHandler<THandler, TArgs>.)
Protected method	RaiseBefore	Raises the before event (Inherited from AdvancedHandler<THandler, TArgs>.)
Protected method	RaiseFailure	Raises the failure event (Inherited from AdvancedHandler<THandler, TArgs>.)
Protected method	RemoveEvent<THandler>	Removes the event from the list (Inherited from AbstractHandler.)
Public method	Reset	Resets the number of executions of the event (Inherited from AbstractHandler.)
Public method	SetParent	Sets the parent event of the event (Inherited from AdvancedHandler<THandler, TArgs>.)
Public method	StartEvent()	Initiates the new handler context (Inherited from AdvancedHandler<THandler, TArgs>.)
Public method	StartEvent(EventArgs)	Initiates the new handler context (Inherited from AdvancedHandler<THandler, TArgs>.)
Public method	StartEvent(TArgs, Boolean)	Initiates the new handler context (Inherited from AdvancedHandler<THandler, TArgs>.)
Public method	StartEvent(SearchParameters, SearchResults)	Initiates the event handling

Extension Methods

	Name	Description
Public Extension Method	CanContinue	Checks whether the context of execution should continue. (Defined by HandlersExtensions.)
Public Extension Method	DontSupportCancel	Disables the ability to cancel continuation of the execution context. (Defined by HandlersExtensions.)
Public Extension Method	FinishEvent	Finishes the event and raises the After event actions. (Defined by HandlersExtensions.)

Events

	Name	Description
Public event	After	Raised after the event occurs (Inherited from AdvancedHandler<THandler, TArgs>.)
Public event	Before	Raised before the event occurs (Inherited from AdvancedHandler<THandler, TArgs>.)
Public event	Failure	Raised in case the event handler didn't properly call finalization (Inherited from AdvancedHandler<THandler, TArgs>.)