Click or drag to resize

EventHandlerEnvironment Class

An object that contains variables available to a script.
Inheritance Hierarchy

Namespace:  MFiles.VAF.Common
Assembly:  MFiles.VAF (in MFiles.VAF.dll) Version: 2.1.0.1 (2.1.0.1)
Syntax
C#
public class EventHandlerEnvironment : EnvironmentBase, 
	IEventHandlerEnvironment, IEnvironment

The EventHandlerEnvironment type exposes the following members.

Constructors
  NameDescription
Public methodEventHandlerEnvironment
Initializes a new instance of the EventHandlerEnvironment class
Top
Properties
  NameDescription
Public propertyActivityID
Accessor for the activity id object. Clones the object to local process on first call.
(Inherited from EnvironmentBase.)
Public propertyActivityIDExternal
Original activity identifier object. The object may be physically located in other process.
(Inherited from EnvironmentBase.)
Public propertyCurrentTransactionID
Accessor for the transaction id object. Clones the object to local process on first call.
(Inherited from EnvironmentBase.)
Public propertyCurrentTransactionIDExternal
Original transaction identifier object. The object may be physically located in other process.
(Inherited from EnvironmentBase.)
Public propertyCurrentUserID
The user id who caused the event handler call.
(Inherited from EnvironmentBase.)
Public propertyCurrentUserSessionInfo
Returns the original user SessionInfo if it exists in the current context.
(Inherited from EnvironmentBase.)
Public propertyCurrentUserSessionInfoExternal
The session info that represents the original (invoking) user session.
(Inherited from EnvironmentBase.)
Public propertyDisplayID
The handled object or value list item display id. Relevant only for events that handle objects of value list items.
(Inherited from EnvironmentBase.)
Public propertyEventType
Accessor for the event type.
Public propertyFileTransferSessionID
The file transfer session id. Available only for file transfer related events.
Public propertyFileVer
Accessor for the file version. Clones the object to local process on first call.
Public propertyFileVerExternal
Original file version object. The object may be physically located in other process.
Public propertyInput
The input string for vault extension method.
Public propertyInputParams
An array of input parameters passed. (Assumes they were in JSON array format)
Public propertyIsCancellable
Tells if the operation can be cancelled by throwing an error.
Public propertyIsObjectEvent
Resolves if the event is object version specific event.
Public propertyIsRecordObject
Resolves if the event target is a record object.
Public propertyIsTemplateObject
Resolves if the event target is a template object.
Public propertyLoggedOutUserID
The user id for logged out user. Available only for logout event.
Public propertyLoginAccount
Accessor for the login account. Clones the object to local process on first call.
Public propertyLoginAccountExternal
Original login account object. The object may be physically located in other process.
Public propertyMasterTransactionID
Accessor for the master transaction id object. Clones the object to local process on first call.
(Inherited from EnvironmentBase.)
Public propertyMasterTransactionIDExternal
Original master transaction identifier object. The object may be physically located in other process.
(Inherited from EnvironmentBase.)
Public propertyObjectAccessControlList
Accessor for the ACL object. Clones the object to local process on first call.
Public propertyObjectAccessControlListExternal
Original ACL object. The object may be physically located in other process.
Public propertyObjVer
Accessor for the object version identifier object. Clones the object to local process on first call.
(Inherited from EnvironmentBase.)
Public propertyObjVerEx
Returns an ObjVerEx for the current environment's ObjVer, if it exists.
(Inherited from EnvironmentBase.)
Public propertyObjVerExternal
Original object identifier object. The object may be physically located in other process.
(Inherited from EnvironmentBase.)
Public propertyParentTransactionID
Accessor for the parent transaction id object. Clones the object to local process on first call.
(Inherited from EnvironmentBase.)
Public propertyParentTransactionIDExternal
Original parent transaction identifier object. The object may be physically located in other process.
(Inherited from EnvironmentBase.)
Public propertyPropertyValues
Accessor for the property values object. Clones the object to local process on first call.
Public propertyPropertyValuesExternal
Original property values object. The object may be physically located in other process.
Public propertyTransactionCache
Accessor for the transaction cache.
(Inherited from EnvironmentBase.)
Public propertyTransactionCacheExternal
Original transaction cache object. The object may be physically located in other process.
(Inherited from EnvironmentBase.)
Public propertyType
The event type for which this event handler environment was built.
Public propertyUserAccount
Accessor for the user account object. Clones the object to local process on first call.
Public propertyUserAccountExternal
Original user account object. The object may be physically located in other process.
Public propertyUserGroupAdmin
Accessor for the user group admin object. Clones the object to local process on first call.
Public propertyUserGroupAdminExternal
Original user group admin object. The object may be physically located in other process.
Public propertyValueListItem
Accessor for the value list item object. Clones the object to local process on first call.
Public propertyValueListItemExternal
Original value list item object. The object may be physically located in other process.
Public propertyVault
The vault object. The vault object session is bound with the ongoing database transaction.
(Inherited from EnvironmentBase.)
Public propertyVaultExtensionMethodName
The vault extension method to call.
Public propertyVaultSharedVariables
Accessor for the shared variables.
(Inherited from EnvironmentBase.)
Public propertyVaultSharedVariablesExternal
Original vault shared variables object. The object may be physically located in other process.
(Inherited from EnvironmentBase.)
Public propertyView
Accessor for the external view object.
Public propertyViewExternal
Original view object. The object may be physically located in other process.
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetObjectClass
Resolves the class of the target object.
(Inherited from EnvironmentBase.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Remarks
Compare to EventHandlerEnvironment which can be used via COM with dynamic types.
See Also