CitrixVirtualUser PropertiesC# API
The CitrixVirtualUser 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 propertyBackgroundScriptIDs
Returns a list of currently registered with the VU background script IDs
(Inherited from VirtualUser.)
Public propertyConnected
Indicates if the Citrix session is connected to the server.
Protected propertyContextState
For internal use only.
(Inherited from VirtualUser.)
Public propertyCurrentIteration
Gets the number of the iteration that this Virtual User is currently executing (beginning at 1).
(Inherited from VirtualUser.)
Public propertyCurrentScript
Gets the currently-executing script.
(Inherited from VirtualUser.)
Public propertyCurrentTransaction
Gets the name of the transaction that is currently in progress.
(Inherited from VirtualUser.)
Protected propertyDataDictionary
Gets the Data Dictionary belonging to this Virtual User.
(Inherited from VirtualUser.)
Public propertyDataPath
Gets the path to the data folder.
(Inherited from VirtualUser.)
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 VirtualUser.)
Public propertyFilesDataPath
Gets the path of the data\Files folder.
(Inherited from VirtualUser.)
Public propertyFinishIteratingRequested
Gets a value that indicates whether this Virtual User has been requested to finish iterating.
(Inherited from VirtualUser.)
Protected propertyFlags
For internal use only.
(Inherited from VirtualUser.)
Protected propertyGroup
For internal use only.
(Inherited from VirtualUser.)
Public propertyGroupSize
Gets the number of Virtual Users in the group that this Virtual User belongs to.
(Inherited from VirtualUser.)
Public propertyGroupSizes
Gets the number of Virtual Users in each Virtual User group.
(Inherited from VirtualUser.)
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 VirtualUser.)
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 VirtualUser.)
Public propertyInjectorFamilyName
Returns the injector family name
(Inherited from VirtualUser.)
Public propertyInjectorName
Returns the injector machine name
(Inherited from VirtualUser.)
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 VirtualUser.)
Public propertyIsFirstScript
Gets a value that indicates whether the current executing script is the first script to be executed.
(Inherited from VirtualUser.)
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 VirtualUser.)
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 VirtualUser.)
Public propertyIsLastIteration
Gets a value that indicates whether more iterations will occur for the current Virtual User.
(Inherited from VirtualUser.)
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 VirtualUser.)
Public propertyIteration
Gets the number of the iteration that this Virtual User is currently executing (beginning at 0).
(Inherited from VirtualUser.)
Public propertyIterationDelay
Gets the delay time in milliseconds between iterations of the repeated sequence of scripts.
(Inherited from VirtualUser.)
Public propertyIterationForTime
Gets the time in milliseconds that the iterated sequence of scripts will iterate for.
(Inherited from VirtualUser.)
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 VirtualUser.)
Public propertyLastError
Gets the most recent error encountered by this Virtual User.
(Inherited from VirtualUser.)
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 VirtualUser.)
Public propertyLastTransaction
Gets the name of the most recent transaction to have ended.
(Inherited from VirtualUser.)
Public propertyMaxFailures
Gets the maximum number of failures allowed in the script before this Virtual User terminates.
(Inherited from VirtualUser.)
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 VirtualUser.)
Public propertyNextKeyDelay
Delay between key presses (internally the wait before keydown).
Public propertyNowSeconds
For internal use only.
(Inherited from VirtualUser.)
Public propertyNumberOfErrors
Gets the number of errors that have been reported for this Virtual User.
(Inherited from VirtualUser.)
Public propertyNumberOfFailures
Gets the current number of script failures for this Virtual User.
(Inherited from VirtualUser.)
Public propertyNumberOfIterations
Gets the total number of iterations that the repeated sequence of scripts will execute.
(Inherited from VirtualUser.)
Public propertyNumberOfWarmupIterations
Gets or sets the number of warm-up iterations for this Virtual User.
(Inherited from VirtualUser.)
Public propertyNumberOfWarnings
Gets the number of warnings that have been reported for this Virtual User.
(Inherited from VirtualUser.)
Public propertyOccurredEvents
Get the list of Citrix Events that have occurred.
Public propertyPauseFactor
Gets or sets the current percentage pause factor.
(Inherited from VirtualUser.)
Public propertyProgressPoint
Gets the text of the most recent progress point that was set.
(Inherited from VirtualUser.)
Public propertyReadOnly
Gets a value that indicates whether this dictionary is read-only.
(Inherited from VirtualUser.)
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 VirtualUser.)
Public propertySandboxPath
Gets the path to the sandbox location.
(Inherited from VirtualUser.)
Public propertyScreenHeight
Get the height of the screen in pixels
Public propertyScreenWidth
Get the width of the screen in pixels
Public propertyStartTimeSeconds
For internal use only.
(Inherited from VirtualUser.)
Public propertyTransactionLoggingOn
Gets or sets a value that indicates whether transactions should be logged for this VU.
(Inherited from VirtualUser.)
Public propertyUniqueID
Gets a test-wide unique identifier for this Virtual User.
(Inherited from VirtualUser.)
Public propertyVerboseLogging
Get/set whether to add more information to the VU event log. Set to false to reduce the log sizes.
Public propertyVUName
Gets the name of the group that this Virtual User belongs to.
(Inherited from VirtualUser.)
Public propertyWebBrowser
Gets the WebBrowser belonging to this Virtual User.
(Inherited from WebBrowserVirtualUser.)
Public propertyWindowsEvents
Filter for Citrix Events.
Back to Top
See Also