PageInteractionEventHandler Class

 Relativity Event Handlers
Defines Page Interaction Event Handler.
Inheritance Hierarchy
System.Object
  System.MarshalByRefObject
    kCura.EventHandler.EventHandlerBase
      kCura.EventHandler.PageInteractionEventHandler

Namespace:  kCura.EventHandler
Assembly:  kCura.EventHandler (in kCura.EventHandler.dll) Version: 17.0.1.1 588f15fd7550dbf54835f3417a0142d4ea37dbb5
Syntax
Copy
[SerializableAttribute]
public abstract class PageInteractionEventHandler : EventHandlerBase, 
	IRequiredFields, IExecutable

[SerializableAttribute]
public abstract class PageInteractionEventHandler : EventHandlerBase, 
	IRequiredFields, IExecutable

The PageInteractionEventHandler type exposes the following members.

Properties
  NameDescription
Public propertyActiveArtifact
Gets and/or sets an active artifact of the event handler.
(Inherited from EventHandlerBase.)
Public propertyActiveLayout
Gets and/or sets an active layout of the event handler.
(Inherited from EventHandlerBase.)
Public propertyActiveUser Obsolete.
Gets and/or sets an active user of the event handler.
(Inherited from EventHandlerBase.)
Public propertyAdditionalHostedFileNames
Gets a list of additional file names that need to be hosted for the PageInteraction EventHandler to properly execute. These files must be added to the Relativity Application associated with this EventHandler and will be hosted on Relativity web servers.
Public propertyApplication
Gets and/or sets an application of the event handler.
(Inherited from EventHandlerBase.)
Public propertyClientScripts
Gets a list of client script blocks registered on a page.
Public propertyDatabaseConnection Obsolete.
Returns a database connection of the event handler.
(Inherited from EventHandlerBase.)
Public propertyDescription
This property is being deprecated. Please assign a kCura.EventHandler.CustomAttributes.Description attribute to your class.
(Inherited from EventHandlerBase.)
Public propertyHelper
Gets and/or sets the Helper property of the event hendler which returns IEHHelper object from Relativity.API.
(Inherited from EventHandlerBase.)
Public propertyMasterDatabaseConnection Obsolete.
Returns a master database connection of the event handler.
(Inherited from EventHandlerBase.)
Public propertyPageMode
Gets and/or sets a page mode of the event handler.
(Inherited from EventHandlerBase.)
Public propertyQuerystringFingerprintKey
Gets a key for querystring fingerprint.
Public propertyQuerystringFingerprintValue
Gets the executing assembly version.
Public propertyRequiredFields
Gets a field collection specified for the event handler.
Public propertyScriptFileNames
Gets a list of JavaScript file names to register with the web application. These files must be added to the Relativity application associated with this EventHandler and will be hosted on Relativity web servers.
Public propertyStartupScripts
Gets a list of startup script blocks registered on a page.
Top
Methods
  NameDescription
Public methodCreateObjRef
Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
(Inherited from MarshalByRefObject.)
Public methodDispose (Inherited from EventHandlerBase.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetArtifactIdByGuid
Returns the corresponding artifact ID for the given guid identifier. Throws an exception if the artifact guid is not found.
(Inherited from EventHandlerBase.)
Public methodGetAuthenticationToken Obsolete.
Returns an authentication session token used for an event handler interaction with Relativity.
(Inherited from EventHandlerBase.)
Public methodGetGuidsByArtifactId
Returns the corresponding artifact guids for the given Artifact ID.
(Inherited from EventHandlerBase.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetLifetimeService
Retrieves the current lifetime service object that controls the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodInitialize (Inherited from EventHandlerBase.)
Public methodInitializeLifetimeService
Returns an object used to control the lifetime policy for this instance
(Inherited from EventHandlerBase.)
Public methodPopulateScriptBlocks
Populates script block section of the page.
Public methodRegisterClientScriptBlock
Registers client script block on a page.
Public methodRegisterLinkedClientScript
Registers client script section on a page.
Public methodRegisterLinkedCss
Registers css file on a page.
Public methodRegisterLinkedStartupScript
Registers startup script on a page.
Public methodRegisterStartupScriptBlock
Registers startup script block on a page.
Public methodSetDatabaseConnection Obsolete.
Sets a database connection for a given event handler.
(Inherited from EventHandlerBase.)
Public methodSetMasterDatabaseConnection Obsolete.
Sets a master database connection for a given event handler.
(Inherited from EventHandlerBase.)
Public methodSetSessionToken
Sets an authentication session token for a given event handler.
(Inherited from EventHandlerBase.)
Public methodSetUser (Inherited from EventHandlerBase.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Remarks
See Also

Reference

kCura.EventHandler Namespace