Click or drag to resize
IsIndexFieldEventArgs Class
Argument of event represented by IsIndexFieldHandler.
Inheritance Hierarchy
SystemObject
  SystemEventArgs
    CMS.BaseCMSEventArgs
      CMS.DataEngineIsIndexFieldEventArgs

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 13.0.131
Syntax
C#
public class IsIndexFieldEventArgs : CMSEventArgs

The IsIndexFieldEventArgs type exposes the following members.

Constructors
  NameDescription
Public methodIsIndexFieldEventArgs
Top
Properties
  NameDescription
Public propertyCurrentHandler
Currently executing handler
(Inherited from CMSEventArgs.)
Public propertyIndex
Index for which to indicate whether field represented by SearchSettings is an index field, or null to perform index agnostic detection (i.e. whether field is included in any index type).
Public propertyOriginalEventArgs Obsolete.
Original event arguments for the event
(Inherited from CMSEventArgs.)
Public propertyResult
Indicates whether field is to be added to search index.
Public propertySearchSettings
Search settings representing field for which to detect whether it is an index field.
Top
Methods
  NameDescription
Public methodCallOnDispose
Adds the given action to the list of actions called when the handler object is disposed
(Inherited from CMSEventArgs.)
Public methodCallWhenFinished
Adds the given action to be called when the handler finishes
(Inherited from CMSEventArgs.)
Public methodCancel
Cancels the current handler execution
(Inherited from CMSEventArgs.)
Public methodDetectRecursion
Prevents the recursion of the handler execution using the given unique key. The handler won't execute again with the given key until the current execution is finished. Returns true, if recursion is detected and the code shouldn't continue. Otherwise returns false.
(Inherited from CMSEventArgs.)
Public methodDispose
Make sure the objects get disposed
(Inherited from CMSEventArgs.)
Public methodLock Obsolete.
Locks the event on the given lock object. The context stays locked until the handler is disposed.
(Inherited from CMSEventArgs.)
Public methodUsing
Adds the given object to the list of object that get disposed when the handler object is disposed
(Inherited from CMSEventArgs.)
Top
See Also