StateEnvironment 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 StateEnvironment : EnvironmentBase, 
	IStateEnvironment, IEnvironment
Inheritance
Object    EnvironmentBase    StateEnvironment
Implements
IEnvironment, IStateEnvironment

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.
(Inherited from EnvironmentBase)
ActivityIDExternal Original activity identifier object. The object may be physically located in other process.
(Inherited from EnvironmentBase)
CurrentTransactionID Accessor for the transaction id object. Clones the object to local process on first call.
(Inherited from EnvironmentBase)
CurrentTransactionIDExternal Original transaction identifier object. The object may be physically located in other process.
(Inherited from EnvironmentBase)
CurrentUserID The user id who caused the event handler call.
(Inherited from EnvironmentBase)
CurrentUserSessionInfo Returns the original user SessionInfo if it exists in the current context.
(Inherited from EnvironmentBase)
CurrentUserSessionInfoExternal The session info that represents the original (invoking) user session.
(Inherited from EnvironmentBase)
DisplayID The handled object or value list item display id. Relevant only for events that handle objects of value list items.
(Inherited from EnvironmentBase)
InitialNextStateID The initial next state ID.
MasterTransactionID Accessor for the master transaction id object. Clones the object to local process on first call.
(Inherited from EnvironmentBase)
MasterTransactionIDExternal Original master transaction identifier object. The object may be physically located in other process.
(Inherited from EnvironmentBase)
ObjVer Accessor for the object version identifier object. Clones the object to local process on first call.
(Inherited from EnvironmentBase)
ObjVerEx Returns an ObjVerEx for the current environment's ObjVer, if it exists.
(Inherited from EnvironmentBase)
ObjVerExternal Original object identifier object. The object may be physically located in other process.
(Inherited from EnvironmentBase)
ParentTransactionID Accessor for the parent transaction id object. Clones the object to local process on first call.
(Inherited from EnvironmentBase)
ParentTransactionIDExternal Original parent transaction identifier object. The object may be physically located in other process.
(Inherited from EnvironmentBase)
PropertyValues Accessor for the property values object. Clones the object to local process on first call.
PropertyValuesExternal Original property values object. The object may be physically located in other process.
SavepointVariables
(Inherited from EnvironmentBase)
SavepointVariablesExternal
(Inherited from EnvironmentBase)
StateID The id of the state that acts as an execution context.
TransactionCache Accessor for the transaction cache.
(Inherited from EnvironmentBase)
TransactionCacheExternal Original transaction cache object. The object may be physically located in other process.
(Inherited from EnvironmentBase)
Vault The vault object. The vault object session is bound with the ongoing database transaction.
(Inherited from EnvironmentBase)
VaultSharedVariables Accessor for the shared variables.
(Inherited from EnvironmentBase)
VaultSharedVariablesExternal Original vault shared variables object. The object may be physically located in other process.
(Inherited from EnvironmentBase)

Methods

GetObjectClass Resolves the class of the target object.
(Inherited from EnvironmentBase)

See Also