Click or drag to resize

EnvironmentBase 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 EnvironmentBase : IEnvironment

The EnvironmentBase type exposes the following members.

Constructors
  NameDescription
Public methodEnvironmentBase
Initializes a new instance of the EnvironmentBase class
Top
Properties
  NameDescription
Public propertyActivityID
Accessor for the activity id object. Clones the object to local process on first call.
Public propertyActivityIDExternal
Original activity identifier object. The object may be physically located in other process.
Public propertyCurrentTransactionID
Accessor for the transaction id object. Clones the object to local process on first call.
Public propertyCurrentTransactionIDExternal
Original transaction identifier object. The object may be physically located in other process.
Public propertyCurrentUserID
The user id who caused the event handler call.
Public propertyCurrentUserSessionInfo
Returns the original user SessionInfo if it exists in the current context.
Public propertyCurrentUserSessionInfoExternal
The session info that represents the original (invoking) user session.
Public propertyDisplayID
The handled object or value list item display id. Relevant only for events that handle objects of value list items.
Public propertyMasterTransactionID
Accessor for the master transaction id object. Clones the object to local process on first call.
Public propertyMasterTransactionIDExternal
Original master transaction identifier 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.
Public propertyObjVerEx
Returns an ObjVerEx for the current environment's ObjVer, if it exists.
Public propertyObjVerExternal
Original object identifier object. The object may be physically located in other process.
Public propertyParentTransactionID
Accessor for the parent transaction id object. Clones the object to local process on first call.
Public propertyParentTransactionIDExternal
Original parent transaction identifier object. The object may be physically located in other process.
Public propertyTransactionCache
Accessor for the transaction cache.
Public propertyTransactionCacheExternal
Original transaction cache 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.
Public propertyVaultSharedVariables
Accessor for the shared variables.
Public propertyVaultSharedVariablesExternal
Original vault shared variables 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.
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.)
Protected methodStatic memberReturnLocalCopy
Makes a local copy of the typed value.
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