CitrixVirtualUserScript MethodsC# API
The CitrixVirtualUserScript type exposes the following members.
Methods

  NameDescription
Public methodAcceptCancellation
Called to accept the script response to the requested cancellation. It means this script would have ScriptStatus.Canceleld when afterwards. If this method is not called and the scipt is successefuly finished, then the status of the script is ScriptStatus.RanToCompletion
(Inherited from VirtualUserScript.)
Public methodAdd
Merges the specified IDataDictionary into this IDataDictionary.
(Inherited from VirtualUserScript.)
Public methodCheckForBitmap(Int32, Int32, Int32, Int32, String, Int32, UInt32)Obsolete.
Checks if a bitmap has appeared in an expected position
Public methodCheckForBitmap(Int32, Int32, Int32, Int32, String, TimeSpan, UInt32)Obsolete.
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 VirtualUserScript.)
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 center 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 VirtualUserScript.)
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 VirtualUserScript.)
Public methodEndTiming(String)
Writes an end timing event to the VU event log.
(Inherited from VirtualUserScript.)
Public methodEndTiming(String, Boolean)
Writes an end timing event to the VU event log, specifying whether the timing passed.
(Inherited from VirtualUserScript.)
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 VirtualUserScript.)
Public methodEnterText(String)Obsolete.
Type the text string
Public methodEnterText(String, Int32)Obsolete.
Type the text string
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 VirtualUserScript.)
Public methodError(String)
Writes an error message to the VU event log.
(Inherited from VirtualUserScript.)
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 VirtualUserScript.)
Public methodError(String, String)
Writes an error message to the VU event log, specifying an identifier which appears in the ID column.
(Inherited from VirtualUserScript.)
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 VirtualUserScript.)
Public methodExitVU 
Stops execution of this Virtual User.
(Inherited from VirtualUserScript.)
Public methodExitVU(Boolean)
Stops execution of this Virtual User, specifying whether the script completed successfully.
(Inherited from VirtualUserScript.)
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 VirtualUserScript.)
Public methodFail
Writes a fail event to the VU event log.
(Inherited from VirtualUserScript.)
Public methodFailTiming
Writes a fail timing event to the VU event log.
(Inherited from VirtualUserScript.)
Public methodFailTransaction(String)
Writes a fail transaction event to the VU event log.
(Inherited from VirtualUserScript.)
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 VirtualUserScript.)
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 VirtualUserScript.)
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 VirtualUserScript.)
Public methodFlushEventLog
Flushes the event log to disk.
(Inherited from VirtualUserScript.)
Public methodGet(String)
Returns a reference to an object held in the dictionary.
(Inherited from VirtualUserScript.)
Public methodGet(String, Object)
Returns an object value held in the dictionary, or the defaultValue if the key cannot be found.
(Inherited from VirtualUserScript.)
Public methodGet T (String, T)
Returns a reference to an object held in the dictionary.
(Inherited from VirtualUserScript.)
Public methodGetBackgroundScriptStatus
Returns a status of the given background script
(Inherited from VirtualUserScript.)
Public methodGetBoolean(String)
Returns a boolean value held in the dictionary.
(Inherited from VirtualUserScript.)
Public methodGetBoolean(String, Boolean)
Returns a boolean value held in the dictionary, or the defaultValue if the key cannot be found.
(Inherited from VirtualUserScript.)
Public methodGetDataDictionary
Gets the Data Dictionary named with the specified key and assigned to the Virtual User in eggPlant Performance Studio.
(Inherited from VirtualUserScript.)
Public methodGetDataTable
Gets the specified Data Table.
(Inherited from VirtualUserScript.)
Public methodGetDouble(String)
Returns a double value held in the dictionary.
(Inherited from VirtualUserScript.)
Public methodGetDouble(String, Double)
Returns a double value held in the dictionary, or the defaultValue if the key cannot be found.
(Inherited from VirtualUserScript.)
Public methodGetEnumerator
Gets an enumerator for iterating over the key/value pairs in this dictionary.
(Inherited from VirtualUserScript.)
Public methodGetFloat(String)
Returns a float value held in the dictionary.
(Inherited from VirtualUserScript.)
Public methodGetFloat(String, Single)
Returns a float value held in the dictionary, or the defaultValue if the key cannot be found.
(Inherited from VirtualUserScript.)
Public methodGetGroupSize
Gets the number of Virtual Users in the specified Virtual User group.
(Inherited from VirtualUserScript.)
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 VirtualUserScript.)
Public methodGetInt(String, Int32)
Returns an int value held in the dictionary, or the defaultValue if the key cannot be found.
(Inherited from VirtualUserScript.)
Public methodGetList(String)
Returns an ArrayList value held in the dictionary.
(Inherited from VirtualUserScript.)
Public methodGetList(String, ArrayList)
Returns an ArrayList value held in the dictionary, or the defaultList if the key cannot be found.
(Inherited from VirtualUserScript.)
Public methodGetLong(String)
Returns a long value held in the dictionary.
(Inherited from VirtualUserScript.)
Public methodGetLong(String, Int64)
Returns a long value held in the dictionary, or the defaultValue if the key cannot be found.
(Inherited from VirtualUserScript.)
Public methodGetProtocol
Gets a Protocol by looking up a string in this Virtual User's data dictionary.
(Inherited from WebBrowserScript.)
Public methodGetService T 
Get a Service object of the given type.
(Inherited from VirtualUserScript.)
Public methodGetString(String)
Returns a string value held in the dictionary.
(Inherited from VirtualUserScript.)
Public methodGetString(String, String)
Returns a string value held in the dictionary, or the defaultValue if the key cannot be found.
(Inherited from VirtualUserScript.)
Public methodGetTimingElapsedTime
Gets the elapsed time of the current active timing.
(Inherited from VirtualUserScript.)
Public methodGetTransactionData
Get data about the specified transaction.
(Inherited from VirtualUserScript.)
Public methodGetTransactionElapsedTime
Gets the current elapsed time of the transaction with the specified id and tag.
(Inherited from VirtualUserScript.)
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 VirtualUserScript.)
Public methodHasKey
Determines whether the specified key is contained within the dictionary.
(Inherited from VirtualUserScript.)
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 VirtualUserScript.)
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(Int32, Int32, Int32, Int32, Int32)Obsolete.
Move the mouse cursor directly to a point on the screen.
Public methodMouseMove(MouseButton, KeyModifier, Int32, Int32, Int32)Obsolete.
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 methodNextIteration
Stops execution of the current script, and starts execution of the next iteration.
(Inherited from VirtualUserScript.)
Public methodNextScript
Stops execution of the current script, and starts execution of the next script in the sequence.
(Inherited from VirtualUserScript.)
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 VirtualUserScript.)
Protected methodOnBackgroundScriptCancellation
Called when the background script executing in a loop is cancelled
(Inherited from VirtualUserScript.)
Public methodPause(Int32)
Pauses the execution of the script for a specified interval (modified by PauseFactor).
(Inherited from VirtualUserScript.)
Public methodPause(VirtualUserScript)
Pauses the execution of the script.
(Inherited from VirtualUserScript.)
Public methodPing
Ping the Citrix server
Public methodPre
This method is called just before this script is executed for the first time.
(Inherited from VirtualUserScript.)
Public methodRaiseAlert
Writes an alert of the specified severity to the Alerts table in Test Controller.
(Inherited from VirtualUserScript.)
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 VirtualUserScript.)
Public methodRecordMetrics
Records multiple user metrics simultaneously.
(Inherited from VirtualUserScript.)
Public methodRecordTransaction(String, DateTime, TimeSpan, Boolean)
Records a transaction in the VU event log, specifying whether the transaction passed.
(Inherited from VirtualUserScript.)
Public methodRecordTransaction(String, Int32, Int32, Boolean)
Records a transaction in the VU event log, specifying whether the transaction passed.
(Inherited from VirtualUserScript.)
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 VirtualUserScript.)
Public methodResetDefaults
Reset the default values to the standard default settings.
Public methodResume
Resumes the background script (which was previously suspended)
(Inherited from VirtualUserScript.)
Public methodResumeBackgroundScript
Resumes currently suspended background script.
(Inherited from VirtualUserScript.)
Public methodResumeTransaction
Resumes the timing of the specified transaction, identified by tag as well as id.
(Inherited from VirtualUserScript.)
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 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 methodScript
This is the method which will be run by the VirtualUser when it executes this script, and is where you should write your test script code.
(Inherited from VirtualUserScript.)
Public methodSelectRandomEntryFromList T 
Selects a random entry from a list stored in this Virtual User's data dictionary.
(Inherited from VirtualUserScript.)
Public methodSet(String, Object)
Sets an object value in the dictionary.
(Inherited from VirtualUserScript.)
Public methodSet T (String, T)
Sets an object value in the dictionary.
(Inherited from VirtualUserScript.)
Public methodSetBoolean
Sets a boolean value in the dictionary.
(Inherited from VirtualUserScript.)
Public methodSetDouble
Sets a double value in the dictionary.
(Inherited from VirtualUserScript.)
Public methodSetFloat
Sets a float value in the dictionary.
(Inherited from VirtualUserScript.)
Public methodSetIcaProperty
Set an ICA property before connecting to the Citrix server.
Public methodSetInt
Sets an int value in the dictionary.
(Inherited from VirtualUserScript.)
Public methodSetList
Sets an ArrayList value in the dictionary.
(Inherited from VirtualUserScript.)
Public methodSetLong
Sets a long value in the dictionary.
(Inherited from VirtualUserScript.)
Public methodSetProgressPoint(String)
Sets a progress point in the VU event log.
(Inherited from VirtualUserScript.)
Public methodSetProgressPoint(String, Boolean)
Sets a progress point in the VU event log, specifying whether the progress point passed.
(Inherited from VirtualUserScript.)
Public methodSetProgressPoint(String, String, Boolean)
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 VirtualUserScript.)
Public methodSetString
Sets a string value in the dictionary.
(Inherited from VirtualUserScript.)
Public methodSetSynchronizationPoint
Set a named synchronization point.
(Inherited from VirtualUserScript.)
Public methodSleep
Sleep for a number of milliseconds
Public methodStartBackgroundScript
Starts previously created and not started background script
(Inherited from VirtualUserScript.)
Public methodStartCitrixClient
Create a form that hosts a citrix client
Public methodStartRequest
For internal use only.
(Inherited from VirtualUserScript.)
Public methodStartTiming
Writes a start timing event to the VU event log.
(Inherited from VirtualUserScript.)
Public methodStartTransaction
Writes a start transaction event to the VU event log, specifying a tag which appears in the Info column.
(Inherited from VirtualUserScript.)
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 VirtualUserScript.)
Public methodStopOCREngine
Stop the OCR engine for this Virtual User.
Public methodSuspend
Asks the background script to suspend
(Inherited from VirtualUserScript.)
Public methodSuspendBackgroundScript
Suspends currently executing background script.
(Inherited from VirtualUserScript.)
Public methodSuspendTransaction
Suspends the timing of the specified transaction, identified by tag as well as id.
(Inherited from VirtualUserScript.)
Public methodTimeToPause
Gets the length of time that this Virtual User would pause for if Pause(Int32) were called with the specified interval.
(Inherited from VirtualUserScript.)
Public methodToString
Returns a string representation of the IDataDictionary belonging to this Virtual User
(Inherited from VirtualUserScript.)
Public methodTryToSuspend
Try to suspend a background script. It won't succeed if it is already locked by another script/VU.
(Inherited from VirtualUserScript.)
Public methodTypeText
Enter a string of characters.
Public methodUnsetSynchronizationPoint
Unset a named synchronization point.
(Inherited from VirtualUserScript.)
Public methodVerify
Verifies that a boolean expression is true.
(Inherited from VirtualUserScript.)
Public methodVerifyEQ(Int32, Int32, Boolean)
Verifies that two integers are equal.
(Inherited from VirtualUserScript.)
Public methodVerifyEQ(Int64, Int64, Boolean)
Verifies that two longs are equal.
(Inherited from VirtualUserScript.)
Public methodVerifyEQ(Double, Double, Double, Boolean)
Verifies that two doubles are equal.
(Inherited from VirtualUserScript.)
Public methodVerifyEQ(String, String, Boolean, Boolean)
Verifies that two strings are equal.
(Inherited from VirtualUserScript.)
Public methodVerifyLE(Int32, Int32, Boolean)
Verifies that one integer is less than or equal to another.
(Inherited from VirtualUserScript.)
Public methodVerifyLE(Int64, Int64, Boolean)
Verifies that one long is less than or equal to another.
(Inherited from VirtualUserScript.)
Public methodVerifyLE(Double, Double, Double, Boolean)
Verifies that one double is less than or equal to another.
(Inherited from VirtualUserScript.)
Public methodVerifyLE(String, String, Boolean, Boolean)
Verifies that one string is less than or equal to another.
(Inherited from VirtualUserScript.)
Public methodVerifyLT(Int32, Int32, Boolean)
Verifies that one integer is less than another.
(Inherited from VirtualUserScript.)
Public methodVerifyLT(Int64, Int64, Boolean)
Verifies that one long is less than another.
(Inherited from VirtualUserScript.)
Public methodVerifyLT(Double, Double, Double, Boolean)
Verifies that one double is less than another.
(Inherited from VirtualUserScript.)
Public methodVerifyLT(String, String, Boolean, Boolean)
Verifies that one string is less than another.
(Inherited from VirtualUserScript.)
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 VirtualUserScript.)
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 VirtualUserScript.)
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 VirtualUserScript.)
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 VirtualUserScript.)
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(CitrixEvent, TimeSpan, 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 VirtualUserScript.)
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 VirtualUserScript.)
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 VirtualUserScript.)
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 VirtualUserScript.)
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, 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)Obsolete.
Wait for an image to appear in a specified portion of the screen.
Public methodWaitForScreenMatch(Int32, Int32, Int32, Int32, String, TimeSpan, TimeSpan, Int32, UInt32)Obsolete.
Wait for an image to appear in a specified portion of the screen.
Public methodWaitForScreenMatch(Int32, Int32, Int32, Int32, String, TimeSpan, TimeSpan, 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 VirtualUserScript.)
Public methodWaitForSynchronizationPoint(String, Int64)
Wait for a named synchronization point to be set.
(Inherited from VirtualUserScript.)
Public methodWaitForSynchronizationPoint(String, TimeSpan)
Wait for a named synchronization point to be set.
(Inherited from VirtualUserScript.)
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 VirtualUserScript.)
Public methodWarn(String)
Writes a warning message to the VU event log.
(Inherited from VirtualUserScript.)
Public methodWarn(String, String)
Writes a warning message to the VU event log, specifying an identifier which appears in the ID column.
(Inherited from VirtualUserScript.)
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 VirtualUserScript.)
Public methodWhereAmI
Returns a stack trace for this Virtual User.
(Inherited from VirtualUserScript.)
Public methodWriteMessage(Exception)
Write an information message to the VU event log, consisting of the exception specified.
(Inherited from VirtualUserScript.)
Public methodWriteMessage(String)
Writes an information message to the VU event log.
(Inherited from VirtualUserScript.)
Public methodWriteMessage(String, String)
Writes an information message to the VU event log, specifying an identifier which appears in the ID column.
(Inherited from VirtualUserScript.)
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 VirtualUserScript.)
Public methodWriteSystemLog(String)
Writes an alert of Error severity to the Alerts table in Test Controller.
(Inherited from VirtualUserScript.)
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 VirtualUserScript.)
Back to Top
See Also