The EventHandler namespace contains fundamental classes and base classes that define events and event handlers.
Classes
Class | Description | |
---|---|---|
![]() | Application |
Creates application instances.
|
![]() | Artifact |
Creates artifact instances.
|
![]() | Choice |
Creates choice instances.
|
![]() | ChoiceCollection |
A class used to as a container for choice values.
|
![]() | ChoiceFieldValue |
Creates choice field value instances.
|
![]() | Console |
Creates console instances.
|
![]() | ConsoleButton |
Creates console button instances.
|
![]() | ConsoleControlTitle |
Creates a Blue Console Title
|
![]() | ConsoleEventHandler |
Creates console event handler instances.
|
![]() | ConsoleHeader |
Creates a Relativity styled header.
|
![]() | ConsoleLinkButton |
Creates a styled link button with the LinkButtonCssClass default CSS class.
|
![]() | ConsoleLiteral |
Creates console literal instances.
|
![]() | ConsoleSeparator |
Creates a Relativity styled separator.
|
![]() | Constants |
Contains default CSS class names for a variety of console components.
|
![]() | DatabaseConnection |
Creates database connection instances.
|
![]() | EventHandlerBase |
This is a base class for event handlers.
|
![]() | Field |
Creates field instances.
|
![]() | FieldCollection |
Creates a collection of fields.
|
![]() | FieldValue |
Creates field value instances.
|
![]() | FileFieldValue |
Creates file field value instances.
|
![]() | FileValue |
Creates file field value instances.
|
![]() | Helper |
Helper class containing numerous enums useful for event handlers.
|
![]() | InstallEventHandlerBase |
Base class for install event handler instances.
|
![]() | Layout |
Creates layout instances.
|
![]() | PageInteractionEventHandler |
Defines Page Interaction Event Handler.
|
![]() | PostCopyEventHandler |
Defines a Post Copy event handler.
|
![]() | PostInstallEventHandler |
Creates post install event handler instances.
|
![]() | PostSaveEventHandler |
Defines a Post Save event handler.
|
![]() | PostWorkspaceCreateEventHandlerBase |
Defines Post Workspace Create Event Handler base class.
|
![]() | PreCascadeDeleteEventHandler |
Defines a Pre Cascade Delete event handler.
|
![]() | PreCopyEventHandler |
Defines a Pre Copy event handler.
|
![]() | PreDeleteEventHandler |
Defines a Pre Delete event handler.
|
![]() | PreInstallEventHandler |
Creates pre install event handler instances.
|
![]() | PreLoadEventHandler |
Defines a Pre Load event handler.
|
![]() | PreMassDeleteEventHandler |
Defines a Pre Mass Delete event handler.
|
![]() | PreSaveEventHandler |
Defines a Pre Save event handler.
|
![]() | PreUninstallEventHandler |
Creates pre uninstall event handler instances.
|
![]() | PreWorkspaceDeleteEventHandlerBase |
Defines Pre Workspace Delete Event Handler base class.
|
![]() | Response |
Defines a response object for event handlers.
|
![]() | SaveEventHandler |
Defines a Save event handler.
|
![]() | ScriptBlock |
Defines a script block for event handlers.
|
![]() | UriImprinter |
Imprints a query value onto a URL.
|
![]() | User |
Creates a user instances.
|
![]() | WorkspaceEventHandlerBase |
Base class for Workspace Event Handlers.
|
Interfaces
Interface | Description | |
---|---|---|
![]() | ICanExecuteWithLimitedContext |
Functions as a marker interface for executing event handlers without context information through the Object Manager service.
|
![]() | IConsoleElement |
Provides the interface for console elements.
|
![]() | IConsoleItem |
Provides the interface for console items.
|
![]() | IDataEnabled |
Allows event handlers to interact with a database.
|
![]() | IExecutable |
Allows event handlers to run execute method.
|
![]() | IInstallEventHandlerProperties |
Interface that defines storage properties needed by the InstallEventHandlerBase class
|
![]() | IPostExecuteActionAware | |
![]() | IRequiredFields |
Allows event handlers to get required fields property.
|
![]() | IStreamFactory | |
![]() | ISuppressDelete |
When implemented by a PreCascadeDeleteEventHandler, signals that the event handler will execute the delete instead of Relativity.
With this event handler, default delete behavior can be continued as normal by adding the ContinueDefaultDelete PostExecuteAction to the event hander's Execute response
|
Enumerations
Enumeration | Description | |
---|---|---|
![]() | ConsoleEventHandler.PageEvent |
Page events; currently only Load and PreRender are handled.
|
![]() | Helper.EventHandlerType |
Enum specifying event handler types.
|
![]() | Helper.PageMode |
Enum specifying page modes.
|
![]() | Helper.RunTargets |
An enum type which specifies values available for a RunTarget custom attribute class.
|