Creates console event handler instances.
Inheritance Hierarchy
System.MarshalByRefObject
kCura.EventHandler.EventHandlerBase
kCura.EventHandler.ConsoleEventHandler
Namespace: kCura.EventHandler
Assembly: kCura.EventHandler (in kCura.EventHandler.dll) Version: 17.0.1.1 588f15fd7550dbf54835f3417a0142d4ea37dbb5
Syntax
[SerializableAttribute] public abstract class ConsoleEventHandler : EventHandlerBase, IRequiredFields [SerializableAttribute] public abstract class ConsoleEventHandler : EventHandlerBase, IRequiredFields
The ConsoleEventHandler type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
 | ActiveArtifact |
Gets and/or sets an active artifact of the event handler.
(Inherited from EventHandlerBase.) |
| ActiveLayout |
Gets and/or sets an active layout of the event handler.
(Inherited from EventHandlerBase.) |
| ActiveUser | Obsolete.
Gets and/or sets an active user of the event handler.
(Inherited from EventHandlerBase.) |
| Application |
Gets and/or sets an application of the event handler.
(Inherited from EventHandlerBase.) |
| DatabaseConnection | Obsolete.
Returns a database connection of the event handler.
(Inherited from EventHandlerBase.) |
| Description |
This property is being deprecated. Please assign a kCura.EventHandler.CustomAttributes.Description attribute to your class.
(Inherited from EventHandlerBase.) |
| Helper |
Gets and/or sets the Helper property of the event hendler which returns IEHHelper object from Relativity.API.
(Inherited from EventHandlerBase.) |
| MasterDatabaseConnection | Obsolete.
Returns a master database connection of the event handler.
(Inherited from EventHandlerBase.) |
| PageMode |
Gets and/or sets a page mode of the event handler.
(Inherited from EventHandlerBase.) |
| RequiredFields |
Returns a collection of required fields of the event handler.
|
Methods
| Name | Description | |
|---|---|---|
 | CreateObjRef | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.) |
| Dispose | (Inherited from EventHandlerBase.) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetArtifactIdByGuid |
Returns the corresponding artifact ID for the given guid identifier. Throws an exception if the artifact guid is not found.
(Inherited from EventHandlerBase.) |
| GetAuthenticationToken | Obsolete.
Returns an authentication session token used for an event handler interaction with Relativity.
(Inherited from EventHandlerBase.) |
| GetConsole |
Returns a console instance based on a page event.
|
| GetGuidsByArtifactId |
Returns the corresponding artifact guids for the given Artifact ID.
(Inherited from EventHandlerBase.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetLifetimeService | Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| Initialize | (Inherited from EventHandlerBase.) |
| InitializeLifetimeService |
Returns an object used to control the lifetime policy for this instance
(Inherited from EventHandlerBase.) |
| OnButtonClick |
Handles a console button click event.
|
| SetDatabaseConnection | Obsolete.
Sets a database connection for a given event handler.
(Inherited from EventHandlerBase.) |
| SetMasterDatabaseConnection | Obsolete.
Sets a master database connection for a given event handler.
(Inherited from EventHandlerBase.) |
| SetSessionToken |
Sets an authentication session token for a given event handler.
(Inherited from EventHandlerBase.) |
| SetUser | (Inherited from EventHandlerBase.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Remarks
See Also