Click or drag to resize
AddDocumentValueEventArgs Class
Arguments of event represented by AddDocumentValueHandler.
Inheritance Hierarchy
SystemObject
  SystemEventArgs
    CMS.BaseCMSEventArgs
      CMS.Search.AzureAddDocumentValueEventArgs

Namespace: CMS.Search.Azure
Assembly: CMS.Search.Azure (in CMS.Search.Azure.dll) Version: 13.0.131
Syntax
C#
public class AddDocumentValueEventArgs : CMSEventArgs

The AddDocumentValueEventArgs type exposes the following members.

Constructors
  NameDescription
Public methodAddDocumentValueEventArgs
Top
Properties
  NameDescription
Public propertyAzureName
Name of resulting field in Azure Search Document.
Public propertyCurrentHandler
Currently executing handler
(Inherited from CMSEventArgs.)
Public propertyDocument
Azure Search document for which the document value is being created.
Public propertyFields
Enumeration of Azure Search fields corresponding to the Document.
Public propertyName
Name of field in SearchDocument for which Azure Search Document value is being created.
Public propertyOriginalEventArgs Obsolete.
Original event arguments for the event
(Inherited from CMSEventArgs.)
Public propertySearchable
Searchable for which the document value is being created.
Public propertySearchDocument
Search document for which the document value is being created.
Public propertySearchIndex
Index for which the document value is being created.
Public propertyValue
Azure Search Document value to be assigned.
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