CitrixVirtualUserScript PropertiesC# API
The CitrixVirtualUserScript type exposes the following members.
Properties

  NameDescription
Public propertyActiveWindows
Get the list of active windows
Public propertyAddress
Get/set the Address of the Citrix server.
Public propertyApplication
The name of the Citrix application.
Public propertyAxICAClient
Get the underlying Citrix ActiveX control.
Public propertyBackgroundScriptID
Gets the script ID, which was provided when this script was started as a background script.
(Inherited from VirtualUserScript.)
Public propertyBackgroundScriptIDs
Returns a list of currently registered wtih the VU background script IDs.
(Inherited from VirtualUserScript.)
Public propertyConnected
Indicates if the Citrix session is connected to the server.
Public propertyCurrentIteration
Gets the number of the iteration that this Virtual User is currently executing (beginning at 1).
(Inherited from VirtualUserScript.)
Public propertyCurrentTransaction
Gets the name of the transaction that is currently in progress.
(Inherited from VirtualUserScript.)
Public propertyDataDictionary
Gets the Data Dictionary belonging to this VirtualUser.
(Inherited from VirtualUserScript.)
Public propertyDataPath
Gets the path to the data folder.
(Inherited from VirtualUserScript.)
Public propertyDefaultImageMatchTolerance
Get/set the default tolerance for matching each pixel in an image
Public propertyDefaultLanguage
Get/set the default language to use for OCR
Public propertyDefaultMaxDiscrepancy
Get/set the default maximum discrepancy for image matches.
Public propertyDefaultPollFrequency
The default poll frequency for screen matches/changes, in milliseconds.
Public propertyDefaultSearchRadius
The default search radius to use when searching for bitmaps.
Public propertyDefaultTimeout
Get/set the default timeout period for checks, in milliseconds.
Public propertyDefaultWorkInterval
The default time delay before a mouse or keyboard action is performed.
Public propertyDoubleClickDelay
Get/set the time in milliseconds between the first MouseUp and second MouseDown in a DoubleClick.
Public propertyElapsedTime
Gets the elapsed time since the beginning of the test, in milliseconds.
(Inherited from VirtualUserScript.)
Public propertyFilesDataPath
Gets the path of the data\Files folder.
(Inherited from VirtualUserScript.)
Public propertyFinishIteratingRequested
Gets a value that indicates whether this Virtual User has been requested to finish iterating.
(Inherited from VirtualUserScript.)
Public propertyGroupSize
Gets the number of Virtual Users in the group that this Virtual User belongs to.
(Inherited from VirtualUserScript.)
Public propertyGroupSizes
Gets the number of Virtual Users in each Virtual User group.
(Inherited from VirtualUserScript.)
Public propertyIcaClientCallTimeout
Get/set the default ICA client call timeout.
Public propertyIcaFilePath
Get the path of the ICA file for this VU.
Public propertyIndex
Gets the index number of this Virtual User within the Virtual User group that it belongs to.
(Inherited from VirtualUserScript.)
Public propertyInitialDelay
Gets the initial delay for this Virtual User, between the start of the test and the start of the first script execution.
(Inherited from VirtualUserScript.)
Public propertyInjectorFamilyName
Returns the injector family name
(Inherited from VirtualUserScript.)
Public propertyInjectorName
Returns the injector machine name
(Inherited from VirtualUserScript.)
Public propertyIsFinalScript
Gets a value that indicates whether the current executing script is within the final section of this Virtual User's workflow.
(Inherited from VirtualUserScript.)
Public propertyIsFirstScript
Gets a value that indicates whether the current executing script is the first script to be executed.
(Inherited from VirtualUserScript.)
Public propertyIsInitialScript
Gets a value that indicates whether the current executing script is within the initial section of this Virtual User's workflow.
(Inherited from VirtualUserScript.)
Public propertyIsIteratedScript
Gets a value that indicates whether the current executing script is within the repeated section of this Virtual User's workflow.
(Inherited from VirtualUserScript.)
Public propertyIsLastIteration
Gets a value that indicates whether more iterations will occur for the current Virtual User.
(Inherited from VirtualUserScript.)
Public propertyIsPacing
Gets a value that indicates whether this Virtual User will adjust the delay between iterations to maintain a steady pace of iterations.
(Inherited from VirtualUserScript.)
Public propertyIteration
Gets the number of the iteration that this Virtual User is currently executing (beginning at 0).
(Inherited from VirtualUserScript.)
Public propertyIterationDelay
Gets the delay time in milliseconds between iterations of the repeated sequence of scripts.
(Inherited from VirtualUserScript.)
Public propertyIterationForTime
Gets the time in milliseconds that the iterated sequence of scripts will iterate for.
(Inherited from VirtualUserScript.)
Public propertyKeyDownDelay
Delay between keydown and keyup (internally the wait before keydown).
Public propertyKeys
Gets an enumerator that can be used to iterate over the keys in this dictionary.
(Inherited from VirtualUserScript.)
Public propertyLastError
Gets the most recent error encountered by this Virtual User.
(Inherited from VirtualUserScript.)
Public propertyLastFoundLocation
Get a Rectangle marking the location of the last image or piece of text that has been found.
Public propertyLastImageMatched
Get the name of the last image to have been found.
Public propertyLastIterationDelay
Gets the delay time in milliseconds between the previous iteration and the current iteration.
(Inherited from VirtualUserScript.)
Public propertyLastTransaction
Gets the name of the most recent transaction to have ended.
(Inherited from VirtualUserScript.)
Public propertyMaxFailures
Gets the maximum number of failures allowed in the script before this Virtual User terminates.
(Inherited from VirtualUserScript.)
Public propertyMouseClickDelay
Get/set the time in milliseconds between MouseDown and MouseUp actions
Public propertyMouseMoveTime
Get/set the time in milliseconds to move the mouse.
Public propertyName
Gets or sets the name of this dictionary.
(Inherited from VirtualUserScript.)
Public propertyNextKeyDelay
Delay between key presses (internally the wait before keydown).
Public propertyNumberOfErrors
Gets the number of errors that have been reported for this Virtual User.
(Inherited from VirtualUserScript.)
Public propertyNumberOfFailures
Gets the current number of script failures for this Virtual User.
(Inherited from VirtualUserScript.)
Public propertyNumberOfIterations
Gets the total number of iterations that the repeated sequence of scripts will execute.
(Inherited from VirtualUserScript.)
Public propertyNumberOfWarmupIterations
Gets or sets the number of warm-up iterations for this Virtual User.
(Inherited from VirtualUserScript.)
Public propertyNumberOfWarnings
Gets the number of warnings that have been reported for this Virtual User.
(Inherited from VirtualUserScript.)
Public propertyOccurredEvents
Get the list of Citrix Events that have occurred.
Public propertyPauseFactor
Gets or sets the current percentage pause factor.
(Inherited from VirtualUserScript.)
Public propertyProgressPoint
Gets the text of the most recent progress point that was set.
(Inherited from VirtualUserScript.)
Public propertyReadOnly
Gets a value that indicates whether this dictionary is read-only.
(Inherited from VirtualUserScript.)
Public propertyRecordScreenshotOnError
Get/set a value indicating whether we should attempt to record a screenshot of the current state whenever an error occurs
Public propertyRunPath
Gets the path to the test run results.
(Inherited from VirtualUserScript.)
Public propertySandboxPath
Gets the path to the sandbox location.
(Inherited from VirtualUserScript.)
Public propertyScreenHeight
Get the height of the screen in pixels
Public propertyScreenWidth
Get the width of the screen in pixels
Public propertyScriptName
Gets the name of this Virtual User Script.
(Inherited from VirtualUserScript.)
Public propertyTransactionLoggingOn
Gets or sets a value that indicates whether transactions should be logged for this VU.
(Inherited from VirtualUserScript.)
Public propertyUniqueID
Gets a test-wide unique identifier for this Virtual User.
(Inherited from VirtualUserScript.)
Public propertyVerboseLogging
Get/set whether to add more information to the VU event log. Set to false to reduce the log sizes.
Public propertyVU
Get the underlying CitrixVirtualUser
Public propertyVUName
Gets the name of the group that this Virtual User belongs to.
(Inherited from VirtualUserScript.)
Public propertyWebBrowser
Gets the WebBrowser belonging to this Virtual User.
(Inherited from WebBrowserScript.)
Public propertyWindowsEvents
Filter for Citrix Events.
Back to Top
See Also