AddDocumentValueEventArgs Class

Arguments of event represented by AddDocumentValueHandler.

Inheritance Hierarchy

System.Object
  System.EventArgs
    CMS.Base.CMSEventArgs
      CMS.Search.Azure.AddDocumentValueEventArgs

Namespace: CMS.Search.Azure
Assembly: CMS.Search.Azure (in CMS.Search.Azure.dll) Version: 13.0.131

Syntax

public class AddDocumentValueEventArgs : CMSEventArgs

The AddDocumentValueEventArgs type exposes the following members.

Constructors

	Name	Description
Public method	AddDocumentValueEventArgs

Properties

	Name	Description
Public property	AzureName	Name of resulting field in Azure Search Document.
Public property	CurrentHandler	Currently executing handler (Inherited from CMSEventArgs.)
Public property	Document	Azure Search document for which the document value is being created.
Public property	Fields	Enumeration of Azure Search fields corresponding to the Document.
Public property	Name	Name of field in SearchDocument for which Azure Search Document value is being created.
Public property	OriginalEventArgs	Obsolete. Original event arguments for the event (Inherited from CMSEventArgs.)
Public property	Searchable	Searchable for which the document value is being created.
Public property	SearchDocument	Search document for which the document value is being created.
Public property	SearchIndex	Index for which the document value is being created.
Public property	Value	Azure Search Document value to be assigned.

Methods

	Name	Description
Public method	CallOnDispose	Adds the given action to the list of actions called when the handler object is disposed (Inherited from CMSEventArgs.)
Public method	CallWhenFinished	Adds the given action to be called when the handler finishes (Inherited from CMSEventArgs.)
Public method	Cancel	Cancels the current handler execution (Inherited from CMSEventArgs.)
Public method	DetectRecursion	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 method	Dispose	Make sure the objects get disposed (Inherited from CMSEventArgs.)
Public method	Lock	Obsolete. Locks the event on the given lock object. The context stays locked until the handler is disposed. (Inherited from CMSEventArgs.)
Public method	Using	Adds the given object to the list of object that get disposed when the handler object is disposed (Inherited from CMSEventArgs.)