Click or drag to resize

ScriptEnvironment Class

A COM-Visible object that contains variables available to a script.
Inheritance Hierarchy
SystemObject
  MFiles.VAFScriptEnvironment

Namespace:  MFiles.VAF
Assembly:  MFiles.VAF (in MFiles.VAF.dll) Version: 2.1.0.1 (2.1.0.1)
Syntax
C#
public class ScriptEnvironment

The ScriptEnvironment type exposes the following members.

Constructors
  NameDescription
Public methodScriptEnvironment
Parameter-less constructor required for COM Interop.
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 methodStatic memberGetEventHandlerEnvironment
Implicitly converts a ScriptEnvironment object to a EventHandlerEnvironment.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodStatic memberGetPropertyEnvironment
Implicitly converts a ScriptEnvironment object to a PropertyEnvironment.
Public methodStatic memberGetStateEnvironment
Implicitly converts a ScriptEnvironment object to a StateEnvironment.
Public methodStatic memberGetStateTransitionEnvironment
Implicitly converts a ScriptEnvironment object to a StateTransitionEnvironment.
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
Fields
  NameDescription
Public fieldActivityID
Activity id object. Set by the calling VBScript event handler.
Public fieldCurrentTransactionID
Current transaction id object. Set by the calling VBScript event handler.
Public fieldCurrentUserID
The current user id. Set by the calling VBScript event handler.
Public fieldCurrentUserSessionInfo
The session info that represents the current (invoker) user session.
Public fieldDisplayID
The display id of the target object or value list item. Set by the calling VBScript event handler.
Public fieldFileTransferSessionID
The file transfer session id. Set by the calling VBScript event handler.
Public fieldFileVer
File version identifier. Set by the calling VBScript event handler.
Public fieldInitialNextStateID
The initial next state id. Set by the calling VBScript event handler.
Public fieldInput
The input string. Set by the calling VBScript event handler.
Public fieldIsCancellable
Tells if the operation can be cancelled by throwing an error.
Public fieldLastUsed
The last used automatic number. Is used only with automatic numbering. Set by the calling VBScript event handler.
Public fieldLoggedOutUserID
The logged out user id. Set by the calling VBScript event handler.
Public fieldLoginAccount
The login account. Set by the calling VBScript event handler.
Public fieldMasterTransactionID
Master transaction id object. Set by the calling VBScript event handler.
Public fieldObjectAccessControlList
Object ACL. Set by the calling VBScript event handler.
Public fieldObjVer
Object version identifier. Set by the calling VBScript event handler.
Public fieldParentTransactionID
Parent transaction id object. Set by the calling VBScript event handler.
Public fieldPropertyDefinition
Property definition object. Set by the calling VBScript event handler.
Public fieldPropertyValue
Property value object. Set by the calling VBScript event handler.
Public fieldPropertyValues
Property values. Set by the calling VBScript event handler.
Public fieldStateID
The state id. Set by the calling VBScript event handler.
Public fieldStateTransitionID
The state transition id. Set by the calling VBScript event handler.
Public fieldTransactionCache
Transaction cache object. Set by the calling VBScript event handler.
Public fieldType
The event handler type. Set by the calling VBScript event handler.
Public fieldUserAccount
User accout object. Set by the calling VBScript event handler.
Public fieldUserGroupAdmin
User group admin object. Set by the calling VBScript event handler.
Public fieldValueListItem
The value list item. Set by the calling VBScript event handler.
Public fieldVault
The vault object. Set by the calling VBScript event handler.
Public fieldVaultExtensionMethodName
The vault extension method to call.
Public fieldVaultSharedVariables
Vault shared variables. Set by the calling VBScript event handler.
Public fieldView
View object. Set by the calling VBScript event handler.
Top
Remarks
This should only be used via COM in the VBScript delegation.
See Also