EnvironmentBase Class |
An object that contains variables available to a script.
Inheritance HierarchySystemObject
MFiles.VAF.CommonEnvironmentBase
MFiles.VAF.CommonEventHandlerEnvironment
MFiles.VAF.CommonPropertyEnvironment
MFiles.VAF.CommonStateEnvironment
MFiles.VAF.CommonStateTransitionEnvironment
MFiles.VAF.CommonEnvironmentBase
MFiles.VAF.CommonEventHandlerEnvironment
MFiles.VAF.CommonPropertyEnvironment
MFiles.VAF.CommonStateEnvironment
MFiles.VAF.CommonStateTransitionEnvironment
Namespace: MFiles.VAF.Common
Assembly: MFiles.VAF (in MFiles.VAF.dll) Version: 2.1.0.1 (2.1.0.1)
SyntaxC#
public class EnvironmentBase : IEnvironment
The EnvironmentBase type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | EnvironmentBase | Initializes a new instance of the EnvironmentBase class |
Properties| Name | Description | |
|---|---|---|
 | 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.
|
| 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| Name | Description | |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetObjectClass |
Resolves the class of the target object.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
 | ReturnLocalCopy |
Makes a local copy of the typed value.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Remarks
Compare to EventHandlerEnvironment which can be used via COM with dynamic types.
See Also