EnvironmentBase Class

An object that contains variables available to a script.

Definition

Namespace: MFiles.VAF.Common
Assembly: MFiles.VAF (in MFiles.VAF.dll) Version: 24.1.706.1
C#
public class EnvironmentBase : IEnvironment
Inheritance
Object    EnvironmentBase
Derived
Implements
IEnvironment

Remarks

Compare to EventHandlerEnvironment which can be used via COM with dynamic types.

Constructors

Properties

ActivityID Accessor for the activity id object. Clones the object to local process on first call.
ActivityIDExternal Original activity identifier object. The object may be physically located in other process.
CurrentTransactionID Accessor for the transaction id object. Clones the object to local process on first call.
CurrentTransactionIDExternal Original transaction identifier object. The object may be physically located in other process.
CurrentUserID The user id who caused the event handler call.
CurrentUserSessionInfo Returns the original user SessionInfo if it exists in the current context.
CurrentUserSessionInfoExternal The session info that represents the original (invoking) user session.
DisplayID The handled object or value list item display id. Relevant only for events that handle objects of value list items.
MasterTransactionID Accessor for the master transaction id object. Clones the object to local process on first call.
MasterTransactionIDExternal Original master transaction identifier object. The object may be physically located in other process.
ObjVer Accessor for the object version identifier object. Clones the object to local process on first call.
ObjVerEx Returns an ObjVerEx for the current environment's ObjVer, if it exists.
ObjVerExternal Original object identifier object. The object may be physically located in other process.
ParentTransactionID Accessor for the parent transaction id object. Clones the object to local process on first call.
ParentTransactionIDExternal Original parent transaction identifier object. The object may be physically located in other process.
SavepointVariables  
SavepointVariablesExternal  
TransactionCache Accessor for the transaction cache.
TransactionCacheExternal Original transaction cache object. The object may be physically located in other process.
Vault The vault object. The vault object session is bound with the ongoing database transaction.
VaultSharedVariables Accessor for the shared variables.
VaultSharedVariablesExternal Original vault shared variables object. The object may be physically located in other process.

Methods

GetObjectClass Resolves the class of the target object.
ReturnLocalCopy Makes a local copy of the typed value.

See Also