CitrixVirtualUser MembersC# API

The CitrixVirtualUser type exposes the following members.
Constructors

  NameDescription
Public methodCitrixVirtualUser
Creates a Citrix Virtual User
Back to Top
Methods

  NameDescription
Public methodAdd
Merges the specified IDataDictionary into this IDataDictionary.
(Inherited from VirtualUser.)
Protected methodAddInitialVirtualUserScript
Internal use only.
(Inherited from VirtualUser.)
Public methodAtEndOfIteration
Called at the end of each iteration. the user should not call this method directly.
(Overrides VirtualUser AtEndOfIteration .)
Public methodAtStartOfIteration
This method is called at the start of every iteration.
(Inherited from WebBrowserVirtualUser.)
Public methodAttachLogMessageSender
For internal use only.
(Inherited from WebBrowserVirtualUser.)
Public methodCheckForBitmapObsolete.
Checks if a bitmap has appeared in an expected position
Public methodCheckForImage(String)
Checks if an image has appeared anywhere on the screen.
Public methodCheckForImage(String, Int32, Int32, Int32, Int32, UInt32)
Checks if an image has appeared in an expected position
Public methodCheckForImage(String, Int32, Int32, Int32, Int32, Int32, Int32)
Checks if an image has appeared in an expected position
Public methodCheckForImage(String, Int32, Int32, Int32, Int32, Int32, Int32, UInt32)
Checks if an image has appeared in an expected position
Public methodCheckForWindowTitle
Checks to see if a window has been created.
Public methodClearEvents
Clear the OccurredEvents list
Public methodClearProgressPoint
Clears the current progress point set for this Virtual User.
(Inherited from VirtualUser.)
Public methodClick(String)
Click the hot spot of the image.
Public methodClick(Int32, Int32)
Click the left mouse button.
Public methodClick(String, Int32, Int32, Int32, Int32, Int32, Int32)
Wait for an image to appear in an area of the screen and then click on it
Public methodClickFoundLocation
Click the hot spot of the last found image location
Public methodCloseCitrixClient
Close the form that hosts the Citrix client
Public methodConnect
Connect to the Citrix server
Public methodCreateBackgroundScript
Creates a new background script and starts it if requested.
(Inherited from VirtualUser.)
Public methodDeleteIcaFile
Delete the ICA file at IcaFilePath
Public methodDisconnect
Disconnect from the Citrix server
Public methodDoubleClick(String)
Double click the hot spot of the image.
Public methodDoubleClick(Int32, Int32)
Double click the left mouse button
Public methodDoubleClick(String, Int32, Int32, Int32, Int32, Int32, Int32)
Wait for an image to appear in an area of the screen and then double clicks on it
Public methodDoubleClickFoundLocation
Double click the hot spot of the last found image location
Public methodEndRequest
For internal use only.
(Inherited from VirtualUser.)
Public methodEndTiming(String)
Writes an end timing event to the VU event log.
(Inherited from VirtualUser.)
Public methodEndTiming(String, Boolean, VirtualUserScript)
Writes an end timing event to the VU event log, specifying whether the timing passed.
(Inherited from VirtualUser.)
Public methodEndTransaction
Writes an end transaction event to the VU event log, specifying whether the transaction passed, and specifying a tag which appears in the Info column.
(Inherited from VirtualUser.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodError(Exception)
Writes an error message to the VU event log, which will consist of the details of the specified Exception.
(Inherited from VirtualUser.)
Public methodError(String)
Writes an error message to the VU event log.
(Inherited from VirtualUser.)
Public methodError(String, Exception)
Writes an error message to the VU event log, which will include the stack trace of the specified Exception.
(Inherited from VirtualUser.)
Public methodError(String, String)
Writes an error message to the VU event log, specifying an identifier which appears in the ID column.
(Inherited from VirtualUser.)
Public methodError(String, String, String)
Writes an error message and an image link to the VU event log, specifying an identifier which appears in the ID column.
(Inherited from VirtualUser.)
Public methodExecuteCommand
For internal use only.
(Inherited from VirtualUser.)
Public methodExitVU 
Stops execution of this Virtual User.
(Inherited from VirtualUser.)
Public methodExitVU(Boolean)
Stops execution of this Virtual User, specifying whether the script completed successfully.
(Inherited from VirtualUser.)
Public methodExitVU(String, Boolean)
Stops execution of this Virtual User, specifying whether the script completed successfully and a message to display at the end of the event log.
(Inherited from VirtualUser.)
Public methodFail
Writes a fail event to the VU event log.
(Inherited from VirtualUser.)
Public methodFailAction
Takes the specified action, using the specified error msg.
(Inherited from VirtualUser.)
Public methodFailTiming
Writes a fail timing event to the VU event log.
(Inherited from VirtualUser.)
Public methodFailTransaction(String)
Writes a fail transaction event to the VU event log.
(Inherited from VirtualUser.)
Public methodFailTransaction(String, String)
Writes a fail transaction event to the VU event log, specifying a tag which appears in the Info column.
(Inherited from VirtualUser.)
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 methodFinalSequence
Stops execution of the current script and then executes the scripts in the final section of the current workflow.
(Inherited from VirtualUser.)
Public methodFindText(String, Int32, Int32, Int32, Int32, OCROptions)
Use OCR to find some text in an area of the screen.
Public methodFindText(String, Int32, Int32, Int32, Int32, String, IList String , IList String , String, String, Rotation)
Use OCR to find some text in an area of the screen.
Public methodFinishIterating
Prevents further iterations of the iterated sequence of scripts for this Virtual User.
(Inherited from VirtualUser.)
Public methodFlushEventLog
Flushes the event log to disk.
(Inherited from VirtualUser.)
Public methodGet(String)
Returns a reference to an object held in the dictionary.
(Inherited from VirtualUser.)
Public methodGet(String, Object)
Returns an object value held in the dictionary, or the defaultValue if the key cannot be found.
(Inherited from VirtualUser.)
Public methodGet T (String, T)
Returns a reference to an object held in the dictionary.
(Inherited from VirtualUser.)
Public methodGetBackgroundScriptStatus
Returns a status of the given background script
(Inherited from VirtualUser.)
Public methodGetBoolean(String)
Returns a boolean value held in the dictionary.
(Inherited from VirtualUser.)
Public methodGetBoolean(String, Boolean)
Returns a boolean value held in the dictionary, or the defaultValue if the key cannot be found.
(Inherited from VirtualUser.)
Public methodGetDataDictionary
Gets the Data Dictionary named with the specified key and assigned to the Virtual User in eggPlant Performance Studio.
(Inherited from VirtualUser.)
Public methodGetDataTable
Gets the specified Data Table.
(Inherited from VirtualUser.)
Public methodGetDouble(String)
Returns a double value held in the dictionary.
(Inherited from VirtualUser.)
Public methodGetDouble(String, Double)
Returns a double value held in the dictionary, or the defaultValue if the key cannot be found.
(Inherited from VirtualUser.)
Public methodGetEnumerator
Gets an enumerator for iterating over the key/value pairs in this dictionary.
(Inherited from VirtualUser.)
Public methodGetFloat(String)
Returns a float value held in the dictionary.
(Inherited from VirtualUser.)
Public methodGetFloat(String, Single)
Returns a float value held in the dictionary, or the defaultValue if the key cannot be found.
(Inherited from VirtualUser.)
Public methodGetGroupSize
Gets the number of Virtual Users in the specified Virtual User group.
(Inherited from VirtualUser.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetImageInfo
Get the ImageInfo for an image file
Public methodGetInt(String)
Returns an int value held in the dictionary.
(Inherited from VirtualUser.)
Public methodGetInt(String, Int32)
Returns an int value held in the dictionary, or the defaultValue if the key cannot be found.
(Inherited from VirtualUser.)
Public methodGetList(String)
Returns an ArrayList value held in the dictionary.
(Inherited from VirtualUser.)
Public methodGetList(String, ArrayList)
Returns an ArrayList value held in the dictionary, or the defaultList if the key cannot be found.
(Inherited from VirtualUser.)
Public methodGetLong(String)
Returns a long value held in the dictionary.
(Inherited from VirtualUser.)
Public methodGetLong(String, Int64)
Returns a long value held in the dictionary, or the defaultValue if the key cannot be found.
(Inherited from VirtualUser.)
Public methodGetMap
Gets a Dictionary containing all the keys/values in this Virtual User.
(Inherited from VirtualUser.)
Public methodGetProtocol
Gets a Protocol by looking up a string in this Virtual User's data dictionary.
(Inherited from WebBrowserVirtualUser.)
Public methodGetService T 
Get a Service object of the given type.
(Inherited from VirtualUser.)
Public methodGetString(String)
Returns a string value held in the dictionary.
(Inherited from VirtualUser.)
Public methodGetString(String, String)
Returns a string value held in the dictionary, or the defaultValue if the key cannot be found.
(Inherited from VirtualUser.)
Public methodGetTimingElapsedTime
Gets the elapsed time of the current active timing.
(Inherited from VirtualUser.)
Public methodGetTransactionData
Get data about the specified transaction.
(Inherited from VirtualUser.)
Public methodGetTransactionElapsedTime
Gets the current elapsed time of the transaction with the specified id and tag.
(Inherited from VirtualUser.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetUniqueID
Gets a test-wide unique identifier for a specified Virtual User within a Virtual User group.
(Inherited from VirtualUser.)
Public methodHasKey
Determines whether the specified key is contained within the dictionary.
(Inherited from VirtualUser.)
Public methodKeyDown
Depress a key on the keyboard.
Public methodKeyUp
Release a key on the keyboard.
Public methodLoadIcaFile 
Load a Citrix ICA file from disk.
Public methodLoadIcaFile(String)
Load a Citrix ICA file from disk.
Public methodLogCurrentDataValues
Write all of the current data values to the VU event log
(Inherited from VirtualUser.)
Public methodLogoff
Logs off from the Citrix server
Public methodLogScreenshot(String, String)
Take a screenshot of the entire screen, and add a message and link to the screenshot into the event log.
Public methodLogScreenshot(String, Int32, Int32, Int32, Int32, String)
Take a screenshot of a portion of the screen, and add a message and link to the screenshot into the event log.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodMouseClick(Int32, Int32, Int32, Int32)
Click a mouse button.
Public methodMouseClick(MouseButton, KeyModifier, Int32, Int32)
Click a mouse button.
Public methodMouseDoubleClick(Int32, Int32, Int32, Int32)
Double click a mouse button.
Public methodMouseDoubleClick(MouseButton, KeyModifier, Int32, Int32)
Double click a mouse button.
Public methodMouseDown(Int32, Int32, Int32, Int32)
Press down a mouse button.
Public methodMouseDown(MouseButton, KeyModifier, Int32, Int32)
Press down a mouse button.
Public methodMouseDrag(Int32, Int32, Int32, Int32, Int32, Int32)
Drag the mouse to a point on the screen.
Public methodMouseDrag(Int32, Int32, Int32, Int32, Int32, Int32, Int32)
Drag the mouse to a point on the screen.
Public methodMouseDrag(MouseButton, KeyModifier, Int32, Int32, Int32, Int32, Int32)
Drag the mouse to a point on the screen.
Public methodMouseMove(String)
Wait for an image to appear anywhere on the screen and then move the mouse over it
Public methodMouseMove(MouseButton, KeyModifier, String)
Wait for an image to appear anywhere on the screen and then move the mouse over it
Public methodMouseMove(Int32, Int32, Int32, Int32)
Move the mouse cursor directly to a point on the screen.
Public methodMouseMove(MouseButton, KeyModifier, Int32, Int32)
Move the mouse cursor.
Public methodMouseMove(Int32, Int32, Int32, Int32, Int32, Int32)
Move the mouse cursor.
Public methodMouseMove(MouseButton, KeyModifier, Int32, Int32, Int32, Int32)
Move the mouse cursor.
Public methodMouseMove(String, Int32, Int32, Int32, Int32, Int32, Int32)
Wait for an image to appear in an area of the screen and then move the mouse over it
Public methodMouseMove(MouseButton, KeyModifier, String, Int32, Int32, Int32, Int32, Int32, Int32)
Wait for an image to appear in an area of the screen and then move the mouse over it
Public methodMouseUp
Releases a mouse button.
Public methodNextIteration
Stops execution of the current script, and starts execution of the next iteration.
(Inherited from VirtualUser.)
Public methodNextScript
Stops execution of the current script, and starts execution of the next script in the sequence.
(Inherited from VirtualUser.)
Public methodNextSequence
Stops execution of the current script and any other scripts in the current sequence, and starts execution of the next sequence of scripts.
(Inherited from VirtualUser.)
Protected methodOnEndTiming
This method is called whenever a timing is ended using the EndTiming(String, Boolean, VirtualUserScript) method.
(Inherited from VirtualUser.)
Protected methodOnEndTransaction
This method is called whenever a transaction is ended using the EndTransaction(String, Boolean, String, VirtualUserScript), FailTransaction(String) or FailTransaction(String, String) methods.
(Inherited from VirtualUser.)
Protected methodOnError
Called whenever an error occurrs. The user should not call this method directly.
(Overrides VirtualUser OnError(String, String).)
Protected methodOnException
This method is called whenever an unhandled exception is thrown by a script.
(Inherited from VirtualUser.)
Protected methodOnExitVU
This method is called whenever the Virtual User stops execution as a result of the ExitVU , ExitVU(Boolean) or ExitVU(String, Boolean) methods.
(Inherited from VirtualUser.)
Protected methodOnRaiseAlert
This method is called whenever an alert is raised using the RaiseAlert(AlertSeverity, String) method.
(Inherited from VirtualUser.)
Protected methodOnResumeTransaction
This method is called whenever a transaction is resumed using the ResumeTransaction(String, String, VirtualUserScript) method.
(Inherited from VirtualUser.)
Protected methodOnSetProgressPoint
This method is called whenever a progress point is set using the SetProgressPoint(String), SetProgressPoint(String, Boolean) or SetProgressPoint(String, String, Boolean, VirtualUserScript) methods.
(Inherited from VirtualUser.)
Public methodOnStartFinalSection
This method is called whenever the Virtual User is about to start executing the final sequence of scripts in its workflow.
(Inherited from WebBrowserVirtualUser.)
Public methodOnStartInitialSection
This method is called whenever the Virtual User is about to start executing the initial sequence of scripts in its workflow.
(Inherited from WebBrowserVirtualUser.)
Protected methodOnStartTiming
This method is called whenever a timing is started using the StartTiming(String, VirtualUserScript) method.
(Inherited from VirtualUser.)
Protected methodOnStartTransaction
This method is called whenever a transaction is started using the StartTransaction(String, String, VirtualUserScript) method.
(Inherited from VirtualUser.)
Protected methodOnSuspendTransaction
This method is called whenever a transaction is suspended using the SuspendTransaction(String, String, VirtualUserScript) method.
(Inherited from VirtualUser.)
Protected methodOnWarn
This method is called whenever a warning is written to the VU event log using the Warn(String) or Warn(String, String) methods.
(Inherited from VirtualUser.)
Protected methodOnWriteMessage
This method is called whenever an information message is written to the VU event log using the WriteMessage(String) or WriteMessage(String, String) methods.
(Inherited from VirtualUser.)
Public methodPause(VirtualUserScript)
Pauses the execution of the script.
(Inherited from VirtualUser.)
Public methodPause(Int32, VirtualUserScript)
Pauses the execution of the script for a specified interval (modified by PauseFactor).
(Inherited from VirtualUser.)
Public methodPing
Ping the citrix server
Protected methodPost
Called at the end of the test run. The user should not call this directly.
(Overrides VirtualUser Post .)
Protected methodPre
Called at the beginning of the test run. The user should not call this directly.
(Overrides VirtualUser Pre .)
Public methodPrepareRequest
This method is called immediately before a Request object is sent to the web server.
(Inherited from WebBrowserVirtualUser.)
Public methodProcessResponse
This method is called immediately after a Response is returned from the web server.
(Inherited from WebBrowserVirtualUser.)
Public methodRaiseAlert
Writes an alert of the specified severity to the Alerts table in Test Controller.
(Inherited from VirtualUser.)
Public methodReadText(Int32, Int32, Int32, Int32, OCROptions)
Use OCR to read some text from an area of the screen.
Public methodReadText(Int32, Int32, Int32, Int32, String, IList String , IList String , String, String, Rotation)
Use OCR to read some text from an area of the screen.
Public methodRecordMetric
Records a user metric.
(Inherited from VirtualUser.)
Public methodRecordMetrics
Records multiple user metrics simultaneously.
(Inherited from VirtualUser.)
Public methodRecordTransaction(String, DateTime, TimeSpan, Boolean, VirtualUserScript)
Records a transaction in the VU event log, specifying whether the transaction passed.
(Inherited from VirtualUser.)
Public methodRecordTransaction(String, Int32, Int32, Boolean, VirtualUserScript)
Records a transaction in the VU event log, specifying whether the transaction passed.
(Inherited from VirtualUser.)
Public methodRequestToStopBackgroundScript
Requests currently running background script to stop. Since it just requests it to stop, the background script must check periodically if it was asked to do so and gracefully exit when detects it by checking this.ct.IsCancellationRequested flag.
(Inherited from VirtualUser.)
Public methodResetDefaults
Reset the default values to the standard default settings.
Public methodResumeBackgroundScript
Resumes currently suspended background script.
(Inherited from VirtualUser.)
Public methodResumeTransaction
Resumes the timing of the specified transaction, identified by tag as well as id.
(Inherited from VirtualUser.)
Public methodRightClick(String)
Right click the hot spot of the image.
Public methodRightClick(Int32, Int32)
Click the right mouse button.
Public methodRightClick(String, Int32, Int32, Int32, Int32, Int32, Int32)
Wait for an image to appear in an area of the screen and then right clicks on it
Public methodRightClickFoundLocation
Right click the hot spot of the last found image location
Public methodRun
Internal use only.
(Inherited from VirtualUser.)
Public methodSaveIcaFile
Save the contents of an HTTP response as an ICA file.
Public methodSaveScreenshotToFile(String)
Saves a screenshot to file
Public methodSaveScreenshotToFile(Int32, Int32, Int32, Int32, String)
Save a screen portion to file
Public methodSelectRandomEntryFromList T 
Selects a random entry from a list stored in this Virtual User's data dictionary.
(Inherited from VirtualUser.)
Public methodSet(String, Object)
Sets an object value in the dictionary.
(Inherited from VirtualUser.)
Public methodSet T (String, T)
Sets an object value in the dictionary.
(Inherited from VirtualUser.)
Public methodSetBoolean
Sets a boolean value in the dictionary.
(Inherited from VirtualUser.)
Public methodSetDouble
Sets a double value in the dictionary.
(Inherited from VirtualUser.)
Public methodSetFloat
Sets a float value in the dictionary.
(Inherited from VirtualUser.)
Public methodSetIcaProperty
Set an ICA property before connecting to the Citrix server.
Public methodSetInt
Sets an int value in the dictionary.
(Inherited from VirtualUser.)
Public methodSetList
Sets an ArrayList value in the dictionary.
(Inherited from VirtualUser.)
Public methodSetLong
Sets a long value in the dictionary.
(Inherited from VirtualUser.)
Public methodSetProgressPoint(String)
Sets a progress point in the VU event log.
(Inherited from VirtualUser.)
Public methodSetProgressPoint(String, Boolean)
Sets a progress point in the VU event log, specifying whether the progress point passed.
(Inherited from VirtualUser.)
Public methodSetProgressPoint(String, String, Boolean, VirtualUserScript)
Sets a progress point in the VU event log, specifying whether the progress point passed, and specifying extra information which appears in the Info column.
(Inherited from VirtualUser.)
Public methodSetString
Sets a string value in the dictionary.
(Inherited from VirtualUser.)
Public methodSetSynchronizationPoint
Set a named synchronization point.
(Inherited from VirtualUser.)
Protected methodSetup
For internal use only.
(Inherited from VirtualUser.)
Public methodSleep
Sleep for a number of milliseconds
Public methodStartBackgroundScript
Starts previously created and not started background script
(Inherited from VirtualUser.)
Public methodStartCitrixClient
Create a form that hosts a citrix client
Protected methodStartCustomVUWatcher
Internal use only.
(Overrides VirtualUser StartCustomVUWatcher .)
Public methodStartRequest
For internal use only.
(Inherited from VirtualUser.)
Public methodStartTiming
Writes a start timing event to the VU event log.
(Inherited from VirtualUser.)
Public methodStartTransaction
Writes a start transaction event to the VU event log, specifying a tag which appears in the Info column.
(Inherited from VirtualUser.)
Public methodStopBackgroundScriptImmediately
Tells the script to stop immediately. It will result in the script terminating if it calls any API or exits itself by checking this.ct.IsCancellationRequested flag. Mind that if it does something in a tight loop or made a call to another library it can take as much time as it needed to finish those operations.
(Inherited from VirtualUser.)
Protected methodStopCustomVUWatcher
Internal use only.
(Overrides VirtualUser StopCustomVUWatcher .)
Public methodStopOCREngine
Stop the OCR engine for this Virtual User.
Public methodSuspendBackgroundScript
Suspends currently executing background script.
(Inherited from VirtualUser.)
Public methodSuspendTransaction
Suspends the timing of the specified transaction, identified by tag as well as id.
(Inherited from VirtualUser.)
Public methodTimeToPause
Gets the length of time that this Virtual User would pause for if Pause(Int32, VirtualUserScript) were called with the specified interval.
(Inherited from VirtualUser.)
Public methodToString
Returns a string representation of the IDataDictionary belonging to this Virtual User
(Inherited from VirtualUser.)
Public methodTypeText
Enter a string of characters.
Public methodUnsetSynchronizationPoint
Unset a named synchronization point.
(Inherited from VirtualUser.)
Public methodVerify
Verifies that a boolean expression is true.
(Inherited from VirtualUser.)
Public methodVerifyEQ(Int32, Int32, Boolean)
Verifies that two integers are equal.
(Inherited from VirtualUser.)
Public methodVerifyEQ(Int64, Int64, Boolean)
Verifies that two longs are equal.
(Inherited from VirtualUser.)
Public methodVerifyEQ(Double, Double, Double, Boolean)
Verifies that two doubles are equal.
(Inherited from VirtualUser.)
Public methodVerifyEQ(String, String, Boolean, Boolean)
Verifies that two strings are equal.
(Inherited from VirtualUser.)
Public methodVerifyLE(Int32, Int32, Boolean)
Verifies that one integer is less than or equal to another.
(Inherited from VirtualUser.)
Public methodVerifyLE(Int64, Int64, Boolean)
Verifies that one long is less than or equal to another.
(Inherited from VirtualUser.)
Public methodVerifyLE(Double, Double, Double, Boolean)
Verifies that one double is less than or equal to another.
(Inherited from VirtualUser.)
Public methodVerifyLE(String, String, Boolean, Boolean)
Verifies that one string is less than or equal to another.
(Inherited from VirtualUser.)
Public methodVerifyLT(Int32, Int32, Boolean)
Verifies that one integer is less than another.
(Inherited from VirtualUser.)
Public methodVerifyLT(Int64, Int64, Boolean)
Verifies that one long is less than another.
(Inherited from VirtualUser.)
Public methodVerifyLT(Double, Double, Double, Boolean)
Verifies that one double is less than another.
(Inherited from VirtualUser.)
Public methodVerifyLT(String, String, Boolean, Boolean)
Verifies that one string is less than another.
(Inherited from VirtualUser.)
Public methodWaitFor T 
Returns a reference to an object stored in the data dictionary. If the object is not yet in the data dictionary, then this method will wait for up to the timeout for the object to be added. For example, a foreground script may need to wait for a background script to put an object into the data dictionary before continuing.
(Inherited from VirtualUser.)
Public methodWaitForBackgroundScriptToFinish
Waits for the background script to finish work in the given timeout, if timeout is not provided or null it waits until the tasks finish (if at all), if timeout is not null, then it returns false if it expired before the timeout reached.
(Inherited from VirtualUser.)
Public methodWaitForBoolean
Returns a bool stored in the data dictionary. If the bool is not yet in the data dictionary, then this method will wait for up to the timeout for the bool to be added. For example, a foreground script may need to wait for a background script to put a bool into the data dictionary before continuing.
(Inherited from VirtualUser.)
Public methodWaitForDouble
Returns a double stored in the data dictionary. If the double is not yet in the data dictionary, then this method will wait for up to the timeout for the double to be added. For example, a foreground script may need to wait for a background script to put a double into the data dictionary before continuing.
(Inherited from VirtualUser.)
Public methodWaitForEvent(CitrixEvent)
Wait for a particular CitrixEvent to occur, timing out after the DefaultTimeout period
Public methodWaitForEvent(CitrixEventType)
Wait for a particular CitrixEvent to occur, timing out after the DefaultTimeout period
Public methodWaitForEvent(CitrixEventType, String)
Wait for a particular CitrixEvent to occur, timing out after the DefaultTimeout period.
Public methodWaitForEvent(CitrixEvent, Int32, WindowCaptionMatchType)
Wait for the given event to occur
Public methodWaitForEvent(CitrixEventType, String, WindowCaptionMatchType)
Wait for a particular CitrixEvent to occur, timing out after the DefaultTimeout period
Public methodWaitForEvent(CitrixEventType, String, WindowCaptionMatchType, Int32)
Wait for a particular CitrixEvent to occur
Public methodWaitForFloat
Returns a float stored in the data dictionary. If the float is not yet in the data dictionary, then this method will wait for up to the timeout for the float to be added. For example, a foreground script may need to wait for a background script to put a float into the data dictionary before continuing.
(Inherited from VirtualUser.)
Public methodWaitForImage(String)
Wait for an image to appear anywhere on the screen
Public methodWaitForImage(String, Int32, Int32, Int32, Int32, Int32)
Wait for an image to appear in an area of the screen
Public methodWaitForImage(String, Int32, Int32, Int32, Int32, Int32, Int32)
Wait for an image to appear in an area of the screen
Public methodWaitForImage(String, Int32, Int32, Int32, Int32, Int32, Int32, UInt32)
Wait for an image to appear in an area of the screen
Public methodWaitForInt
Returns an integer stored in the data dictionary. If the integer is not yet in the data dictionary, then this method will wait for up to the timeout for the integer to be added. For example, a foreground script may need to wait for a background script to put an integer into the data dictionary before continuing.
(Inherited from VirtualUser.)
Public methodWaitForList
Returns an ArrayList stored in the data dictionary. If the ArrayList is not yet in the data dictionary, then this method will wait for up to the timeout for the ArrayList to be added. For example, a foreground script may need to wait for a background script to put an ArrayList into the data dictionary before continuing.
(Inherited from VirtualUser.)
Public methodWaitForLong
Returns a long stored in the data dictionary. If the long is not yet in the data dictionary, then this method will wait for up to the timeout for the long to be added. For example, a foreground script may need to wait for a background script to put a long into the data dictionary before continuing.
(Inherited from VirtualUser.)
Public methodWaitForScreenChange(Int32, Int32, Int32, Int32, String, UInt32)
Wait for a portion of the screen to change.
Public methodWaitForScreenChange(Int32, Int32, Int32, Int32, String, Int32, Int32, UInt32, UInt32)
Wait for a portion of the screen to change.
Public methodWaitForScreenMatch(Int32, Int32, Int32, Int32, String, Int32, Int32, Int32, UInt32)Obsolete.
Wait for an image to appear in a specified portion of the screen.
Public methodWaitForScreenMatch(Int32, Int32, Int32, Int32, String, Int32, Int32, Int32, UInt32, UInt32)Obsolete.
Wait for an image to appear in a specified portion of the screen.
Public methodWaitForString
Returns a reference to a string stored in the data dictionary. If the string is not yet in the data dictionary, then this method will wait for up to the timeout for the string to be added. For example, a foreground script may need to wait for a background script to put a string into the data dictionary before continuing.
(Inherited from VirtualUser.)
Public methodWaitForSynchronizationPoint(String, Int64)
Wait for a named synchronization point to be set.
(Inherited from VirtualUser.)
Public methodWaitForSynchronizationPoint(String, TimeSpan)
Wait for a named synchronization point to be set.
(Inherited from VirtualUser.)
Public methodWaitForText(String, Int32, Int32, Int32, Int32, Int32, Int32, OCROptions)
Use OCR to wait for some text to appear in an area of the screen.
Public methodWaitForText(String, Int32, Int32, Int32, Int32, String, IList String , IList String , String, String, Rotation)
Use OCR to wait for some text to appear in an area of the screen.
Public methodWaitForText(String, Int32, Int32, Int32, Int32, Int32, Int32, String, IList String , IList String , String, String, Rotation)
Use OCR to wait for some text to appear in an area of the screen.
Public methodWarn(Exception)
Writes a warning message to the VU event log, consisting of the specified exception
(Inherited from VirtualUser.)
Public methodWarn(String)
Writes a warning message to the VU event log.
(Inherited from VirtualUser.)
Public methodWarn(String, String)
Writes a warning message to the VU event log, specifying an identifier which appears in the ID column.
(Inherited from VirtualUser.)
Public methodWarn(String, String, String)
Writes a warning message and an image link to the VU event log, specifying an identifier which appears in the ID column.
(Inherited from VirtualUser.)
Public methodWriteMessage(Exception)
Write an information message to the VU event log, consisting of the exception specified.
(Inherited from VirtualUser.)
Public methodWriteMessage(String)
Writes an information message to the VU event log.
(Inherited from VirtualUser.)
Public methodWriteMessage(String, String)
Writes an information message to the VU event log, specifying an identifier which appears in the ID column.
(Inherited from VirtualUser.)
Public methodWriteMessage(String, String, String)
Writes an information message to the VU event log and also a link to an image, specifying an identifier which appears in the ID column.
(Inherited from VirtualUser.)
Public methodWriteSystemLog(String)
Writes an alert of Error severity to the Alerts table in Test Controller.
(Inherited from VirtualUser.)
Public methodWriteSystemLog(String, String)
Writes an alert of Error severity to the Alerts table in Test Controller, specifying a heading to prefix to the message.
(Inherited from VirtualUser.)
Back to Top
Fields

  NameDescription
Protected fieldbackgroundScripts
Internal use only.
(Inherited from VirtualUser.)
Back to Top
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