Initializes a new instance of the CitrixVirtualUserScript class

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

Merges the specified IDataDictionary into this IDataDictionary.

Checks if a bitmap has appeared in an expected position

Checks if a bitmap has appeared in an expected position

Checks if an image has appeared anywhere on the screen.

Checks if an image has appeared in an expected position

Checks if an image has appeared in an expected position

Checks if an image has appeared in an expected position

Checks to see if a window has been created.

Clear the OccurredEvents list

Clears the current progress point set for this Virtual User.

Click the hot spot of the image.

Click the left mouse button.

Wait for an image to appear in an area of the screen and then click on it

Click the center of the last found image location

Close the form that hosts the Citrix client

Connect to the Citrix server

Creates a new background script and starts it if requested.

Delete the ICA file at IcaFilePath

Disconnect from the Citrix server

Double click the hot spot of the image.

Double click the left mouse button

Wait for an image to appear in an area of the screen and then double clicks on it

Double click the hot spot of the last found image location

For internal use only.

Writes an end timing event to the VU event log.

Writes an end timing event to the VU event log, specifying whether the timing passed.

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.

Type the text string

Type the text string

Determines whether the specified object is equal to the current object.

Writes an error message to the VU event log, which will consist of the details of the specified Exception.

Writes an error message to the VU event log.

Writes an error message to the VU event log, which will include the stack trace of the specified Exception.

Writes an error message to the VU event log, specifying an identifier which appears in the ID column.

Writes an error message and an image link to the VU event log, specifying an identifier which appears in the ID column.

Stops execution of this Virtual User.

Stops execution of this Virtual User, specifying whether the script completed successfully.

Stops execution of this Virtual User, specifying whether the script completed successfully and a message to display at the end of the event log.

Writes a fail event to the VU event log.

Writes a fail timing event to the VU event log.

Writes a fail transaction event to the VU event log.

Writes a fail transaction event to the VU event log, specifying a tag which appears in the Info column.

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.

Stops execution of the current script and then executes the scripts in the final section of the current workflow.

Use OCR to find some text in an area of the screen.

Use OCR to find some text in an area of the screen.

Prevents further iterations of the iterated sequence of scripts for this Virtual User.

Flushes the event log to disk.

Returns a reference to an object held in the dictionary.

Returns an object value held in the dictionary, or the defaultValue if the key cannot be found.

Returns a reference to an object held in the dictionary.

Returns a status of the given background script

Returns a boolean value held in the dictionary.

Returns a boolean value held in the dictionary, or the defaultValue if the key cannot be found.

Gets the Data Dictionary named with the specified key and assigned to the Virtual User in eggPlant Performance Studio.

Gets the specified Data Table.

Returns a double value held in the dictionary.

Returns a double value held in the dictionary, or the defaultValue if the key cannot be found.

Gets an enumerator for iterating over the key/value pairs in this dictionary.

Returns a float value held in the dictionary.

Returns a float value held in the dictionary, or the defaultValue if the key cannot be found.

Gets the number of Virtual Users in the specified Virtual User group.

Serves as the default hash function.

Get the ImageInfo for an image file

Returns an int value held in the dictionary.

Returns an int value held in the dictionary, or the defaultValue if the key cannot be found.

Returns an ArrayList value held in the dictionary.

Returns an ArrayList value held in the dictionary, or the defaultList if the key cannot be found.

Returns a long value held in the dictionary.

Returns a long value held in the dictionary, or the defaultValue if the key cannot be found.

Gets a Protocol by looking up a string in this Virtual User's data dictionary.

Get a Service object of the given type.

Returns a string value held in the dictionary.

Returns a string value held in the dictionary, or the defaultValue if the key cannot be found.

Gets the elapsed time of the current active timing.

Get data about the specified transaction.

Gets the current elapsed time of the transaction with the specified id and tag.

Gets the Type of the current instance.

Gets a test-wide unique identifier for a specified Virtual User within a Virtual User group.

Determines whether the specified key is contained within the dictionary.

Depress a key on the keyboard.

Release a key on the keyboard.

Load a Citrix ICA file from disk.

Load a Citrix ICA file from disk.

Write all of the current data values to the VU event log

Logs off from the Citrix server

Take a screenshot of the entire screen, and add a message and link to the screenshot into the event log.

Take a screenshot of a portion of the screen, and add a message and link to the screenshot into the event log.

Creates a shallow copy of the current Object.

Click a mouse button.

Click a mouse button.

Double click a mouse button.

Double click a mouse button.

Press down a mouse button.

Press down a mouse button.

Drag the mouse to a point on the screen.

Drag the mouse to a point on the screen.

Drag the mouse to a point on the screen.

Wait for an image to appear anywhere on the screen and then move the mouse over it

Wait for an image to appear anywhere on the screen and then move the mouse over it

Move the mouse cursor directly to a point on the screen.

Move the mouse cursor directly to a point on the screen.

Move the mouse cursor.

Move the mouse cursor.

Move the mouse cursor.

Wait for an image to appear in an area of the screen and then move the mouse over it

Wait for an image to appear in an area of the screen and then move the mouse over it

Stops execution of the current script, and starts execution of the next iteration.

Stops execution of the current script, and starts execution of the next script in the sequence.

Stops execution of the current script and any other scripts in the current sequence, and starts execution of the next sequence of scripts.

Called when the background script executing in a loop is cancelled

Pauses the execution of the script for a specified interval (modified by PauseFactor).

Pauses the execution of the script.

Ping the Citrix server

This method is called just before this script is executed for the first time.

Writes an alert of the specified severity to the Alerts table in Test Controller.

Use OCR to read some text from an area of the screen.

Use OCR to read some text from an area of the screen.

Records a user metric.

Records multiple user metrics simultaneously.

Records a transaction in the VU event log, specifying whether the transaction passed.

Records a transaction in the VU event log, specifying whether the transaction passed.

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.

Reset the default values to the standard default settings.

Resumes the background script (which was previously suspended)

Resumes currently suspended background script.

Resumes the timing of the specified transaction, identified by tag as well as id.

Right click the hot spot of the image.

Click the right mouse button.

Wait for an image to appear in an area of the screen and then right clicks on it

Right click the hot spot of the last found image location

Save the contents of an HTTP response as an ICA file.

Saves a screenshot to file

Save a screen portion to file

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.

Selects a random entry from a list stored in this Virtual User's data dictionary.

Sets an object value in the dictionary.

Sets an object value in the dictionary.

Sets a boolean value in the dictionary.

Sets a double value in the dictionary.

Sets a float value in the dictionary.

Set an ICA property before connecting to the Citrix server.

Sets an int value in the dictionary.

Sets an ArrayList value in the dictionary.

Sets a long value in the dictionary.

Sets a progress point in the VU event log.

Sets a progress point in the VU event log, specifying whether the progress point passed.

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.

Sets a string value in the dictionary.

Set a named synchronization point.

Sleep for a number of milliseconds

Starts previously created and not started background script

Create a form that hosts a citrix client

For internal use only.

Writes a start timing event to the VU event log.

Writes a start transaction event to the VU event log, specifying a tag which appears in the Info column.

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.

Stop the OCR engine for this Virtual User.

Asks the background script to suspend

Suspends currently executing background script.

Suspends the timing of the specified transaction, identified by tag as well as id.

Gets the length of time that this Virtual User would pause for if Pause(Int32) were called with the specified interval.

Returns a string representation of the IDataDictionary belonging to this Virtual User

Try to suspend a background script. It won't succeed if it is already locked by another script/VU.

Enter a string of characters.

Unset a named synchronization point.

Verifies that a boolean expression is true.

Verifies that two integers are equal.

Verifies that two longs are equal.

Verifies that two doubles are equal.

Verifies that two strings are equal.

Verifies that one integer is less than or equal to another.

Verifies that one long is less than or equal to another.

Verifies that one double is less than or equal to another.

Verifies that one string is less than or equal to another.

Verifies that one integer is less than another.

Verifies that one long is less than another.

Verifies that one double is less than another.

Verifies that one string is less than another.

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.

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.

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.

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.

Wait for a particular CitrixEvent to occur, timing out after the DefaultTimeout period

Wait for a particular CitrixEvent to occur, timing out after the DefaultTimeout period

Wait for a particular CitrixEvent to occur, timing out after the DefaultTimeout period.

Wait for the given event to occur

Wait for the given event to occur

Wait for a particular CitrixEvent to occur, timing out after the DefaultTimeout period

Wait for a particular CitrixEvent to occur

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.

Wait for an image to appear anywhere on the screen

Wait for an image to appear in an area of the screen

Wait for an image to appear in an area of the screen

Wait for an image to appear in an area of the screen

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.

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.

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.

Wait for a portion of the screen to change.

Wait for a portion of the screen to change.

Wait for an image to appear in a specified portion of the screen.

Wait for an image to appear in a specified portion of the screen.

Wait for an image to appear in a specified portion of the screen.

Wait for an image to appear in a specified portion of the screen.

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.

Wait for a named synchronization point to be set.

Wait for a named synchronization point to be set.

Use OCR to wait for some text to appear in an area of the screen.

Use OCR to wait for some text to appear in an area of the screen.

Use OCR to wait for some text to appear in an area of the screen.

Writes a warning message to the VU event log, consisting of the specified exception

Writes a warning message to the VU event log.

Writes a warning message to the VU event log, specifying an identifier which appears in the ID column.

Writes a warning message and an image link to the VU event log, specifying an identifier which appears in the ID column.

Returns a stack trace for this Virtual User.

Write an information message to the VU event log, consisting of the exception specified.

Writes an information message to the VU event log.

Writes an information message to the VU event log, specifying an identifier which appears in the ID column.

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.

Writes an alert of Error severity to the Alerts table in Test Controller.

Writes an alert of Error severity to the Alerts table in Test Controller, specifying a heading to prefix to the message.

A helper object used to communicate between main and foreground scripts. Background script is normally use it to check to see if it needs to exit.

Internal use only.

The Rectangle that is returned if no match can be found for an image search

Get the list of active windows

Get/set the Address of the Citrix server.

The name of the Citrix application.

Get the underlying Citrix ActiveX control.

Gets the script ID, which was provided when this script was started as a background script.

Returns a list of currently registered wtih the VU background script IDs.

Indicates if the Citrix session is connected to the server.

Gets the number of the iteration that this Virtual User is currently executing (beginning at 1).

Gets the name of the transaction that is currently in progress.

Gets the Data Dictionary belonging to this VirtualUser.

Gets the path to the data folder.

Get/set the default tolerance for matching each pixel in an image

Get/set the default language to use for OCR

Get/set the default maximum discrepancy for image matches.

The default poll frequency for screen matches/changes, in milliseconds.

The default search radius to use when searching for bitmaps.

Get/set the default timeout period for checks, in milliseconds.

The default time delay before a mouse or keyboard action is performed.

Get/set the time in milliseconds between the first MouseUp and second MouseDown in a DoubleClick.

Gets the elapsed time since the beginning of the test, in milliseconds.

Gets the path of the data\Files folder.

Gets a value that indicates whether this Virtual User has been requested to finish iterating.

Gets the number of Virtual Users in the group that this Virtual User belongs to.

Gets the number of Virtual Users in each Virtual User group.

Get/set the default ICA client call timeout.

Get the path of the ICA file for this VU.

Gets the index number of this Virtual User within the Virtual User group that it belongs to.

Gets the initial delay for this Virtual User, between the start of the test and the start of the first script execution.

Returns the injector family name

Returns the injector machine name

Gets a value that indicates whether the current executing script is within the final section of this Virtual User's workflow.

Gets a value that indicates whether the current executing script is the first script to be executed.

Gets a value that indicates whether the current executing script is within the initial section of this Virtual User's workflow.

Gets a value that indicates whether the current executing script is within the repeated section of this Virtual User's workflow.

Gets a value that indicates whether more iterations will occur for the current Virtual User.

Gets a value that indicates whether this Virtual User will adjust the delay between iterations to maintain a steady pace of iterations.

Gets the number of the iteration that this Virtual User is currently executing (beginning at 0).

Gets the delay time in milliseconds between iterations of the repeated sequence of scripts.

Gets the time in milliseconds that the iterated sequence of scripts will iterate for.

Delay between keydown and keyup (internally the wait before keydown).

Gets an enumerator that can be used to iterate over the keys in this dictionary.

Gets the most recent error encountered by this Virtual User.

Get a Rectangle marking the location of the last image or piece of text that has been found.

Get the name of the last image to have been found.

Gets the delay time in milliseconds between the previous iteration and the current iteration.

Gets the name of the most recent transaction to have ended.

Gets the maximum number of failures allowed in the script before this Virtual User terminates.

Get/set the time in milliseconds between MouseDown and MouseUp actions

Get/set the time in milliseconds to move the mouse.

Gets or sets the name of this dictionary.

Delay between key presses (internally the wait before keydown).

Gets the number of errors that have been reported for this Virtual User.

Gets the current number of script failures for this Virtual User.

Gets the total number of iterations that the repeated sequence of scripts will execute.

Gets or sets the number of warm-up iterations for this Virtual User.

Gets the number of warnings that have been reported for this Virtual User.

Get the list of Citrix Events that have occurred.

Gets or sets the current percentage pause factor.

Gets the text of the most recent progress point that was set.

Gets a value that indicates whether this dictionary is read-only.

Get/set a value indicating whether we should attempt to record a screenshot of the current state whenever an error occurs

Gets the path to the test run results.

Gets the path to the sandbox location.

Get the height of the screen in pixels

Get the width of the screen in pixels

Gets the name of this Virtual User Script.

Gets or sets a value that indicates whether transactions should be logged for this VU.

Gets a test-wide unique identifier for this Virtual User.

Get/set whether to add more information to the VU event log. Set to false to reduce the log sizes.

Get the underlying CitrixVirtualUser

Gets the name of the group that this Virtual User belongs to.

Gets the WebBrowser belonging to this Virtual User.

Filter for Citrix Events.