The CitrixVirtualUser type exposes the following members.
Back to Top
Back to Top
Back to Top
Back to Top
Constructors
Name | Description | |
---|---|---|
CitrixVirtualUser |
Creates a Citrix Virtual User
|
Methods
Name | Description | |
---|---|---|
Add |
Merges the specified IDataDictionary into this IDataDictionary.
(Inherited from VirtualUser.) | |
AddInitialVirtualUserScript |
Internal use only.
(Inherited from VirtualUser.) | |
AtEndOfIteration |
Called at the end of each iteration. the user should not call this method directly.
(Overrides VirtualUser AtEndOfIteration .) | |
AtStartOfIteration |
This method is called at the start of every iteration.
(Inherited from WebBrowserVirtualUser.) | |
AttachLogMessageSender |
For internal use only.
(Inherited from WebBrowserVirtualUser.) | |
CheckForBitmap | Obsolete.
Checks if a bitmap has appeared in an expected position
| |
CheckForImage(String) |
Checks if an image has appeared anywhere on the screen.
| |
CheckForImage(String, Int32, Int32, Int32, Int32, UInt32) |
Checks if an image has appeared in an expected position
| |
CheckForImage(String, Int32, Int32, Int32, Int32, Int32, Int32) |
Checks if an image has appeared in an expected position
| |
CheckForImage(String, Int32, Int32, Int32, Int32, Int32, Int32, UInt32) |
Checks if an image has appeared in an expected position
| |
CheckForWindowTitle |
Checks to see if a window has been created.
| |
ClearEvents |
Clear the OccurredEvents list
| |
ClearProgressPoint |
Clears the current progress point set for this Virtual User.
(Inherited from VirtualUser.) | |
Click(String) |
Click the hot spot of the image.
| |
Click(Int32, Int32) |
Click the left mouse button.
| |
Click(String, Int32, Int32, Int32, Int32, Int32, Int32) |
Wait for an image to appear in an area of the screen and then click on it
| |
ClickFoundLocation |
Click the hot spot of the last found image location
| |
CloseCitrixClient |
Close the form that hosts the Citrix client
| |
Connect |
Connect to the Citrix server
| |
CreateBackgroundScript |
Creates a new background script and starts it if requested.
(Inherited from VirtualUser.) | |
DeleteIcaFile |
Delete the ICA file at IcaFilePath | |
Disconnect |
Disconnect from the Citrix server
| |
DoubleClick(String) |
Double click the hot spot of the image.
| |
DoubleClick(Int32, Int32) |
Double click the left mouse button
| |
DoubleClick(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
| |
DoubleClickFoundLocation |
Double click the hot spot of the last found image location
| |
EndRequest |
For internal use only.
(Inherited from VirtualUser.) | |
EndTiming(String) |
Writes an end timing event to the VU event log.
(Inherited from VirtualUser.) | |
EndTiming(String, Boolean, VirtualUserScript) |
Writes an end timing event to the VU event log, specifying whether the timing passed.
(Inherited from VirtualUser.) | |
EndTransaction |
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.) | |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
Error(Exception) |
Writes an error message to the VU event log, which will consist of the details of the specified Exception.
(Inherited from VirtualUser.) | |
Error(String) |
Writes an error message to the VU event log.
(Inherited from VirtualUser.) | |
Error(String, Exception) |
Writes an error message to the VU event log, which will include the stack trace of the specified Exception.
(Inherited from VirtualUser.) | |
Error(String, String) |
Writes an error message to the VU event log, specifying an identifier which appears in the ID column.
(Inherited from VirtualUser.) | |
Error(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.) | |
ExecuteCommand |
For internal use only.
(Inherited from VirtualUser.) | |
ExitVU |
Stops execution of this Virtual User.
(Inherited from VirtualUser.) | |
ExitVU(Boolean) |
Stops execution of this Virtual User, specifying whether the script completed successfully.
(Inherited from VirtualUser.) | |
ExitVU(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.) | |
Fail |
Writes a fail event to the VU event log.
(Inherited from VirtualUser.) | |
FailAction |
Takes the specified action, using the specified error msg.
(Inherited from VirtualUser.) | |
FailTiming |
Writes a fail timing event to the VU event log.
(Inherited from VirtualUser.) | |
FailTransaction(String) |
Writes a fail transaction event to the VU event log.
(Inherited from VirtualUser.) | |
FailTransaction(String, String) |
Writes a fail transaction event to the VU event log, specifying a tag which appears in the Info column.
(Inherited from VirtualUser.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
FinalSequence |
Stops execution of the current script and then executes the scripts in the final section of the current workflow.
(Inherited from VirtualUser.) | |
FindText(String, Int32, Int32, Int32, Int32, OCROptions) |
Use OCR to find some text in an area of the screen.
| |
FindText(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.
| |
FinishIterating |
Prevents further iterations of the iterated sequence of scripts for this Virtual User.
(Inherited from VirtualUser.) | |
FlushEventLog |
Flushes the event log to disk.
(Inherited from VirtualUser.) | |
Get(String) |
Returns a reference to an object held in the dictionary.
(Inherited from VirtualUser.) | |
Get(String, Object) |
Returns an object value held in the dictionary, or the defaultValue if the key cannot be found.
(Inherited from VirtualUser.) | |
Get T (String, T) |
Returns a reference to an object held in the dictionary.
(Inherited from VirtualUser.) | |
GetBackgroundScriptStatus |
Returns a status of the given background script
(Inherited from VirtualUser.) | |
GetBoolean(String) |
Returns a boolean value held in the dictionary.
(Inherited from VirtualUser.) | |
GetBoolean(String, Boolean) |
Returns a boolean value held in the dictionary, or the defaultValue if the key cannot be found.
(Inherited from VirtualUser.) | |
GetDataDictionary |
Gets the Data Dictionary named with the specified key and assigned to the Virtual User in eggPlant Performance Studio.
(Inherited from VirtualUser.) | |
GetDataTable |
Gets the specified Data Table.
(Inherited from VirtualUser.) | |
GetDouble(String) |
Returns a double value held in the dictionary.
(Inherited from VirtualUser.) | |
GetDouble(String, Double) |
Returns a double value held in the dictionary, or the defaultValue if the key cannot be found.
(Inherited from VirtualUser.) | |
GetEnumerator |
Gets an enumerator for iterating over the key/value pairs in this dictionary.
(Inherited from VirtualUser.) | |
GetFloat(String) |
Returns a float value held in the dictionary.
(Inherited from VirtualUser.) | |
GetFloat(String, Single) |
Returns a float value held in the dictionary, or the defaultValue if the key cannot be found.
(Inherited from VirtualUser.) | |
GetGroupSize |
Gets the number of Virtual Users in the specified Virtual User group.
(Inherited from VirtualUser.) | |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetImageInfo |
Get the ImageInfo for an image file
| |
GetInt(String) |
Returns an int value held in the dictionary.
(Inherited from VirtualUser.) | |
GetInt(String, Int32) |
Returns an int value held in the dictionary, or the defaultValue if the key cannot be found.
(Inherited from VirtualUser.) | |
GetList(String) |
Returns an ArrayList value held in the dictionary.
(Inherited from VirtualUser.) | |
GetList(String, ArrayList) |
Returns an ArrayList value held in the dictionary, or the defaultList if the key cannot be found.
(Inherited from VirtualUser.) | |
GetLong(String) |
Returns a long value held in the dictionary.
(Inherited from VirtualUser.) | |
GetLong(String, Int64) |
Returns a long value held in the dictionary, or the defaultValue if the key cannot be found.
(Inherited from VirtualUser.) | |
GetMap |
Gets a Dictionary containing all the keys/values in this Virtual User.
(Inherited from VirtualUser.) | |
GetProtocol |
Gets a Protocol by looking up a string in this Virtual User's data dictionary.
(Inherited from WebBrowserVirtualUser.) | |
GetService T |
Get a Service object of the given type.
(Inherited from VirtualUser.) | |
GetString(String) |
Returns a string value held in the dictionary.
(Inherited from VirtualUser.) | |
GetString(String, String) |
Returns a string value held in the dictionary, or the defaultValue if the key cannot be found.
(Inherited from VirtualUser.) | |
GetTimingElapsedTime |
Gets the elapsed time of the current active timing.
(Inherited from VirtualUser.) | |
GetTransactionData |
Get data about the specified transaction.
(Inherited from VirtualUser.) | |
GetTransactionElapsedTime |
Gets the current elapsed time of the transaction with the specified id and tag.
(Inherited from VirtualUser.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
GetUniqueID |
Gets a test-wide unique identifier for a specified Virtual User within a Virtual User group.
(Inherited from VirtualUser.) | |
HasKey |
Determines whether the specified key is contained within the dictionary.
(Inherited from VirtualUser.) | |
KeyDown |
Depress a key on the keyboard.
| |
KeyUp |
Release a key on the keyboard.
| |
LoadIcaFile |
Load a Citrix ICA file from disk.
| |
LoadIcaFile(String) |
Load a Citrix ICA file from disk.
| |
LogCurrentDataValues |
Write all of the current data values to the VU event log
(Inherited from VirtualUser.) | |
Logoff |
Logs off from the Citrix server
| |
LogScreenshot(String, String) |
Take a screenshot of the entire screen, and add a message and link to the screenshot into the event log.
| |
LogScreenshot(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.
| |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
MouseClick(Int32, Int32, Int32, Int32) |
Click a mouse button.
| |
MouseClick(MouseButton, KeyModifier, Int32, Int32) |
Click a mouse button.
| |
MouseDoubleClick(Int32, Int32, Int32, Int32) |
Double click a mouse button.
| |
MouseDoubleClick(MouseButton, KeyModifier, Int32, Int32) |
Double click a mouse button.
| |
MouseDown(Int32, Int32, Int32, Int32) |
Press down a mouse button.
| |
MouseDown(MouseButton, KeyModifier, Int32, Int32) |
Press down a mouse button.
| |
MouseDrag(Int32, Int32, Int32, Int32, Int32, Int32) |
Drag the mouse to a point on the screen.
| |
MouseDrag(Int32, Int32, Int32, Int32, Int32, Int32, Int32) |
Drag the mouse to a point on the screen.
| |
MouseDrag(MouseButton, KeyModifier, Int32, Int32, Int32, Int32, Int32) |
Drag the mouse to a point on the screen.
| |
MouseMove(String) |
Wait for an image to appear anywhere on the screen and then move the mouse over it
| |
MouseMove(MouseButton, KeyModifier, String) |
Wait for an image to appear anywhere on the screen and then move the mouse over it
| |
MouseMove(Int32, Int32, Int32, Int32) |
Move the mouse cursor directly to a point on the screen.
| |
MouseMove(MouseButton, KeyModifier, Int32, Int32) |
Move the mouse cursor.
| |
MouseMove(Int32, Int32, Int32, Int32, Int32, Int32) |
Move the mouse cursor.
| |
MouseMove(MouseButton, KeyModifier, Int32, Int32, Int32, Int32) |
Move the mouse cursor.
| |
MouseMove(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
| |
MouseMove(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
| |
MouseUp |
Releases a mouse button.
| |
NextIteration |
Stops execution of the current script, and starts execution of the next iteration.
(Inherited from VirtualUser.) | |
NextScript |
Stops execution of the current script, and starts execution of the next script in the sequence.
(Inherited from VirtualUser.) | |
NextSequence |
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.) | |
OnEndTiming |
This method is called whenever a timing is ended using the EndTiming(String, Boolean, VirtualUserScript) method.
(Inherited from VirtualUser.) | |
OnEndTransaction |
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.) | |
OnError |
Called whenever an error occurrs. The user should not call this method directly.
(Overrides VirtualUser OnError(String, String).) | |
OnException |
This method is called whenever an unhandled exception is thrown by a script.
(Inherited from VirtualUser.) | |
OnExitVU |
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.) | |
OnRaiseAlert |
This method is called whenever an alert is raised
using the RaiseAlert(AlertSeverity, String) method.
(Inherited from VirtualUser.) | |
OnResumeTransaction |
This method is called whenever a transaction is resumed
using the ResumeTransaction(String, String, VirtualUserScript) method.
(Inherited from VirtualUser.) | |
OnSetProgressPoint |
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.) | |
OnStartFinalSection |
This method is called whenever the Virtual User is about to start executing the final sequence of scripts in its workflow.
(Inherited from WebBrowserVirtualUser.) | |
OnStartInitialSection |
This method is called whenever the Virtual User is about to start executing the initial sequence of scripts in its workflow.
(Inherited from WebBrowserVirtualUser.) | |
OnStartTiming |
This method is called whenever a timing is started using the StartTiming(String, VirtualUserScript) method.
(Inherited from VirtualUser.) | |
OnStartTransaction |
This method is called whenever a transaction is started using the StartTransaction(String, String, VirtualUserScript) method.
(Inherited from VirtualUser.) | |
OnSuspendTransaction |
This method is called whenever a transaction is suspended
using the SuspendTransaction(String, String, VirtualUserScript) method.
(Inherited from VirtualUser.) | |
OnWarn |
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.) | |
OnWriteMessage |
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.) | |
Pause(VirtualUserScript) |
Pauses the execution of the script.
(Inherited from VirtualUser.) | |
Pause(Int32, VirtualUserScript) |
Pauses the execution of the script for a specified interval (modified by PauseFactor).
(Inherited from VirtualUser.) | |
Ping |
Ping the citrix server
| |
Post |
Called at the end of the test run. The user should not call this directly.
(Overrides VirtualUser Post .) | |
Pre |
Called at the beginning of the test run. The user should not call this directly.
(Overrides VirtualUser Pre .) | |
PrepareRequest |
This method is called immediately before a Request object is sent to the web server.
(Inherited from WebBrowserVirtualUser.) | |
ProcessResponse |
This method is called immediately after a Response is returned from the web server.
(Inherited from WebBrowserVirtualUser.) | |
RaiseAlert |
Writes an alert of the specified severity to the Alerts table in Test Controller.
(Inherited from VirtualUser.) | |
ReadText(Int32, Int32, Int32, Int32, OCROptions) |
Use OCR to read some text from an area of the screen.
| |
ReadText(Int32, Int32, Int32, Int32, String, IList String , IList String , String, String, Rotation) |
Use OCR to read some text from an area of the screen.
| |
RecordMetric |
Records a user metric.
(Inherited from VirtualUser.) | |
RecordMetrics |
Records multiple user metrics simultaneously.
(Inherited from VirtualUser.) | |
RecordTransaction(String, DateTime, TimeSpan, Boolean, VirtualUserScript) |
Records a transaction in the VU event log, specifying whether the transaction passed.
(Inherited from VirtualUser.) | |
RecordTransaction(String, Int32, Int32, Boolean, VirtualUserScript) |
Records a transaction in the VU event log, specifying whether the transaction passed.
(Inherited from VirtualUser.) | |
RequestToStopBackgroundScript |
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.) | |
ResetDefaults |
Reset the default values to the standard default settings.
| |
ResumeBackgroundScript |
Resumes currently suspended background script.
(Inherited from VirtualUser.) | |
ResumeTransaction |
Resumes the timing of the specified transaction,
identified by tag as well as id.
(Inherited from VirtualUser.) | |
RightClick(String) |
Right click the hot spot of the image.
| |
RightClick(Int32, Int32) |
Click the right mouse button.
| |
RightClick(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
| |
RightClickFoundLocation |
Right click the hot spot of the last found image location
| |
Run |
Internal use only.
(Inherited from VirtualUser.) | |
SaveIcaFile |
Save the contents of an HTTP response as an ICA file.
| |
SaveScreenshotToFile(String) |
Saves a screenshot to file
| |
SaveScreenshotToFile(Int32, Int32, Int32, Int32, String) |
Save a screen portion to file
| |
SelectRandomEntryFromList T |
Selects a random entry from a list stored in this Virtual User's data dictionary.
(Inherited from VirtualUser.) | |
Set(String, Object) |
Sets an object value in the dictionary.
(Inherited from VirtualUser.) | |
Set T (String, T) |
Sets an object value in the dictionary.
(Inherited from VirtualUser.) | |
SetBoolean |
Sets a boolean value in the dictionary.
(Inherited from VirtualUser.) | |
SetDouble |
Sets a double value in the dictionary.
(Inherited from VirtualUser.) | |
SetFloat |
Sets a float value in the dictionary.
(Inherited from VirtualUser.) | |
SetIcaProperty |
Set an ICA property before connecting to the Citrix server.
| |
SetInt |
Sets an int value in the dictionary.
(Inherited from VirtualUser.) | |
SetList |
Sets an ArrayList value in the dictionary.
(Inherited from VirtualUser.) | |
SetLong |
Sets a long value in the dictionary.
(Inherited from VirtualUser.) | |
SetProgressPoint(String) |
Sets a progress point in the VU event log.
(Inherited from VirtualUser.) | |
SetProgressPoint(String, Boolean) |
Sets a progress point in the VU event log, specifying whether the progress point passed.
(Inherited from VirtualUser.) | |
SetProgressPoint(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.) | |
SetString |
Sets a string value in the dictionary.
(Inherited from VirtualUser.) | |
SetSynchronizationPoint |
Set a named synchronization point.
(Inherited from VirtualUser.) | |
Setup |
For internal use only.
(Inherited from VirtualUser.) | |
Sleep |
Sleep for a number of milliseconds
| |
StartBackgroundScript |
Starts previously created and not started background script
(Inherited from VirtualUser.) | |
StartCitrixClient |
Create a form that hosts a citrix client
| |
StartCustomVUWatcher |
Internal use only.
(Overrides VirtualUser StartCustomVUWatcher .) | |
StartRequest |
For internal use only.
(Inherited from VirtualUser.) | |
StartTiming |
Writes a start timing event to the VU event log.
(Inherited from VirtualUser.) | |
StartTransaction |
Writes a start transaction event to the VU event log,
specifying a tag which appears in the Info column.
(Inherited from VirtualUser.) | |
StopBackgroundScriptImmediately |
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.) | |
StopCustomVUWatcher |
Internal use only.
(Overrides VirtualUser StopCustomVUWatcher .) | |
StopOCREngine |
Stop the OCR engine for this Virtual User.
| |
SuspendBackgroundScript |
Suspends currently executing background script.
(Inherited from VirtualUser.) | |
SuspendTransaction |
Suspends the timing of the specified transaction,
identified by tag as well as id.
(Inherited from VirtualUser.) | |
TimeToPause |
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.) | |
ToString |
Returns a string representation of the IDataDictionary
belonging to this Virtual User
(Inherited from VirtualUser.) | |
TypeText |
Enter a string of characters.
| |
UnsetSynchronizationPoint |
Unset a named synchronization point.
(Inherited from VirtualUser.) | |
Verify |
Verifies that a boolean expression is true.
(Inherited from VirtualUser.) | |
VerifyEQ(Int32, Int32, Boolean) |
Verifies that two integers are equal.
(Inherited from VirtualUser.) | |
VerifyEQ(Int64, Int64, Boolean) |
Verifies that two longs are equal.
(Inherited from VirtualUser.) | |
VerifyEQ(Double, Double, Double, Boolean) |
Verifies that two doubles are equal.
(Inherited from VirtualUser.) | |
VerifyEQ(String, String, Boolean, Boolean) |
Verifies that two strings are equal.
(Inherited from VirtualUser.) | |
VerifyLE(Int32, Int32, Boolean) |
Verifies that one integer is less than or equal to another.
(Inherited from VirtualUser.) | |
VerifyLE(Int64, Int64, Boolean) |
Verifies that one long is less than or equal to another.
(Inherited from VirtualUser.) | |
VerifyLE(Double, Double, Double, Boolean) |
Verifies that one double is less than or equal to another.
(Inherited from VirtualUser.) | |
VerifyLE(String, String, Boolean, Boolean) |
Verifies that one string is less than or equal to another.
(Inherited from VirtualUser.) | |
VerifyLT(Int32, Int32, Boolean) |
Verifies that one integer is less than another.
(Inherited from VirtualUser.) | |
VerifyLT(Int64, Int64, Boolean) |
Verifies that one long is less than another.
(Inherited from VirtualUser.) | |
VerifyLT(Double, Double, Double, Boolean) |
Verifies that one double is less than another.
(Inherited from VirtualUser.) | |
VerifyLT(String, String, Boolean, Boolean) |
Verifies that one string is less than another.
(Inherited from VirtualUser.) | |
WaitFor 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.) | |
WaitForBackgroundScriptToFinish |
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.) | |
WaitForBoolean |
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.) | |
WaitForDouble |
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.) | |
WaitForEvent(CitrixEvent) |
Wait for a particular CitrixEvent to occur, timing out after the DefaultTimeout period
| |
WaitForEvent(CitrixEventType) |
Wait for a particular CitrixEvent to occur, timing out after the DefaultTimeout period
| |
WaitForEvent(CitrixEventType, String) |
Wait for a particular CitrixEvent to occur, timing out after the DefaultTimeout period.
| |
WaitForEvent(CitrixEvent, Int32, WindowCaptionMatchType) |
Wait for the given event to occur
| |
WaitForEvent(CitrixEventType, String, WindowCaptionMatchType) |
Wait for a particular CitrixEvent to occur, timing out after the DefaultTimeout period
| |
WaitForEvent(CitrixEventType, String, WindowCaptionMatchType, Int32) |
Wait for a particular CitrixEvent to occur
| |
WaitForFloat |
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.) | |
WaitForImage(String) |
Wait for an image to appear anywhere on the screen
| |
WaitForImage(String, Int32, Int32, Int32, Int32, Int32) |
Wait for an image to appear in an area of the screen
| |
WaitForImage(String, Int32, Int32, Int32, Int32, Int32, Int32) |
Wait for an image to appear in an area of the screen
| |
WaitForImage(String, Int32, Int32, Int32, Int32, Int32, Int32, UInt32) |
Wait for an image to appear in an area of the screen
| |
WaitForInt |
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.) | |
WaitForList |
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.) | |
WaitForLong |
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.) | |
WaitForScreenChange(Int32, Int32, Int32, Int32, String, UInt32) |
Wait for a portion of the screen to change.
| |
WaitForScreenChange(Int32, Int32, Int32, Int32, String, Int32, Int32, UInt32, UInt32) |
Wait for a portion of the screen to change.
| |
WaitForScreenMatch(Int32, Int32, Int32, Int32, String, Int32, Int32, Int32, UInt32) | Obsolete.
Wait for an image to appear in a specified portion of the screen.
| |
WaitForScreenMatch(Int32, Int32, Int32, Int32, String, Int32, Int32, Int32, UInt32, UInt32) | Obsolete.
Wait for an image to appear in a specified portion of the screen.
| |
WaitForString |
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.) | |
WaitForSynchronizationPoint(String, Int64) |
Wait for a named synchronization point to be set.
(Inherited from VirtualUser.) | |
WaitForSynchronizationPoint(String, TimeSpan) |
Wait for a named synchronization point to be set.
(Inherited from VirtualUser.) | |
WaitForText(String, Int32, Int32, Int32, Int32, Int32, Int32, OCROptions) |
Use OCR to wait for some text to appear in an area of the screen.
| |
WaitForText(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.
| |
WaitForText(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.
| |
Warn(Exception) |
Writes a warning message to the VU event log, consisting of the specified exception
(Inherited from VirtualUser.) | |
Warn(String) |
Writes a warning message to the VU event log.
(Inherited from VirtualUser.) | |
Warn(String, String) |
Writes a warning message to the VU event log, specifying an identifier which appears in the ID column.
(Inherited from VirtualUser.) | |
Warn(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.) | |
WriteMessage(Exception) |
Write an information message to the VU event log, consisting of the exception specified.
(Inherited from VirtualUser.) | |
WriteMessage(String) |
Writes an information message to the VU event log.
(Inherited from VirtualUser.) | |
WriteMessage(String, String) |
Writes an information message to the VU event log, specifying an identifier which appears in the ID column.
(Inherited from VirtualUser.) | |
WriteMessage(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.) | |
WriteSystemLog(String) |
Writes an alert of Error severity to the Alerts table in Test Controller.
(Inherited from VirtualUser.) | |
WriteSystemLog(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.) |
Fields
Name | Description | |
---|---|---|
backgroundScripts |
Internal use only.
(Inherited from VirtualUser.) |
Properties
Name | Description | |
---|---|---|
ActiveWindows |
Get the list of active windows
| |
Address |
Get/set the Address of the Citrix server.
| |
Application |
The name of the Citrix application.
| |
AxICAClient |
Get the underlying Citrix ActiveX control.
| |
BackgroundScriptIDs |
Returns a list of currently registered with the VU background script IDs
(Inherited from VirtualUser.) | |
Connected |
Indicates if the Citrix session is connected to the server.
| |
ContextState |
For internal use only.
(Inherited from VirtualUser.) | |
CurrentIteration |
Gets the number of the iteration that this Virtual User is currently executing (beginning at 1).
(Inherited from VirtualUser.) | |
CurrentScript |
Gets the currently-executing script.
(Inherited from VirtualUser.) | |
CurrentTransaction |
Gets the name of the transaction that is currently in progress.
(Inherited from VirtualUser.) | |
DataDictionary |
Gets the Data Dictionary belonging to this Virtual User.
(Inherited from VirtualUser.) | |
DataPath |
Gets the path to the data folder.
(Inherited from VirtualUser.) | |
DefaultImageMatchTolerance |
Get/set the default tolerance for matching each pixel in an image
| |
DefaultLanguage |
Get/set the default language to use for OCR
| |
DefaultMaxDiscrepancy |
Get/set the default maximum discrepancy for image matches.
| |
DefaultPollFrequency |
The default poll frequency for screen matches/changes, in milliseconds.
| |
DefaultSearchRadius |
The default search radius to use when searching for bitmaps.
| |
DefaultTimeout |
Get/set the default timeout period for checks, in milliseconds.
| |
DefaultWorkInterval |
The default time delay before a mouse or keyboard action is performed.
| |
DoubleClickDelay |
Get/set the time in milliseconds between the first MouseUp and second MouseDown in a DoubleClick.
| |
ElapsedTime |
Gets the elapsed time since the beginning of the test, in milliseconds.
(Inherited from VirtualUser.) | |
FilesDataPath |
Gets the path of the data\Files folder.
(Inherited from VirtualUser.) | |
FinishIteratingRequested |
Gets a value that indicates whether this Virtual User has been requested to finish iterating.
(Inherited from VirtualUser.) | |
Flags |
For internal use only.
(Inherited from VirtualUser.) | |
Group |
For internal use only.
(Inherited from VirtualUser.) | |
GroupSize |
Gets the number of Virtual Users in the group that this Virtual User belongs to.
(Inherited from VirtualUser.) | |
GroupSizes |
Gets the number of Virtual Users in each Virtual User group.
(Inherited from VirtualUser.) | |
IcaClientCallTimeout |
Get/set the default ICA client call timeout.
| |
IcaFilePath |
Get the path of the ICA file for this VU.
| |
Index |
Gets the index number of this Virtual User within the Virtual User group that it belongs to.
(Inherited from VirtualUser.) | |
InitialDelay |
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.) | |
InjectorFamilyName |
Returns the injector family name
(Inherited from VirtualUser.) | |
InjectorName |
Returns the injector machine name
(Inherited from VirtualUser.) | |
IsFinalScript |
Gets a value that indicates whether the current executing script is within the final section of this Virtual User's workflow.
(Inherited from VirtualUser.) | |
IsFirstScript |
Gets a value that indicates whether the current executing script is the first script to be executed.
(Inherited from VirtualUser.) | |
IsInitialScript |
Gets a value that indicates whether the current executing script is within the initial section of this Virtual User's workflow.
(Inherited from VirtualUser.) | |
IsIteratedScript |
Gets a value that indicates whether the current executing script is within the repeated section of this Virtual User's workflow.
(Inherited from VirtualUser.) | |
IsLastIteration |
Gets a value that indicates whether more iterations will occur for the current Virtual User.
(Inherited from VirtualUser.) | |
IsPacing |
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.) | |
Iteration |
Gets the number of the iteration that this Virtual User is currently executing (beginning at 0).
(Inherited from VirtualUser.) | |
IterationDelay |
Gets the delay time in milliseconds between iterations of the repeated sequence of scripts.
(Inherited from VirtualUser.) | |
IterationForTime |
Gets the time in milliseconds that the iterated sequence of scripts will iterate for.
(Inherited from VirtualUser.) | |
KeyDownDelay |
Delay between keydown and keyup (internally the wait before keydown).
| |
Keys |
Gets an enumerator that can be used to iterate over the keys in this dictionary.
(Inherited from VirtualUser.) | |
LastError |
Gets the most recent error encountered by this Virtual User.
(Inherited from VirtualUser.) | |
LastFoundLocation |
Get a Rectangle marking the location of the last image or piece of text that has been found.
| |
LastImageMatched |
Get the name of the last image to have been found.
| |
LastIterationDelay |
Gets the delay time in milliseconds between the previous iteration and the current iteration.
(Inherited from VirtualUser.) | |
LastTransaction |
Gets the name of the most recent transaction to have ended.
(Inherited from VirtualUser.) | |
MaxFailures |
Gets the maximum number of failures allowed in the script before this Virtual User terminates.
(Inherited from VirtualUser.) | |
MouseClickDelay |
Get/set the time in milliseconds between MouseDown and MouseUp actions
| |
MouseMoveTime |
Get/set the time in milliseconds to move the mouse.
| |
Name |
Gets or sets the name of this dictionary.
(Inherited from VirtualUser.) | |
NextKeyDelay |
Delay between key presses (internally the wait before keydown).
| |
NowSeconds |
For internal use only.
(Inherited from VirtualUser.) | |
NumberOfErrors |
Gets the number of errors that have been reported for this Virtual User.
(Inherited from VirtualUser.) | |
NumberOfFailures |
Gets the current number of script failures for this Virtual User.
(Inherited from VirtualUser.) | |
NumberOfIterations |
Gets the total number of iterations that the repeated sequence of scripts will execute.
(Inherited from VirtualUser.) | |
NumberOfWarmupIterations |
Gets or sets the number of warm-up iterations for this Virtual User.
(Inherited from VirtualUser.) | |
NumberOfWarnings |
Gets the number of warnings that have been reported for this Virtual User.
(Inherited from VirtualUser.) | |
OccurredEvents |
Get the list of Citrix Events that have occurred.
| |
PauseFactor |
Gets or sets the current percentage pause factor.
(Inherited from VirtualUser.) | |
ProgressPoint |
Gets the text of the most recent progress point that was set.
(Inherited from VirtualUser.) | |
ReadOnly |
Gets a value that indicates whether this dictionary is read-only.
(Inherited from VirtualUser.) | |
RecordScreenshotOnError |
Get/set a value indicating whether we should attempt to record a screenshot of the current state
whenever an error occurs
| |
RunPath |
Gets the path to the test run results.
(Inherited from VirtualUser.) | |
SandboxPath |
Gets the path to the sandbox location.
(Inherited from VirtualUser.) | |
ScreenHeight |
Get the height of the screen in pixels
| |
ScreenWidth |
Get the width of the screen in pixels
| |
StartTimeSeconds |
For internal use only.
(Inherited from VirtualUser.) | |
TransactionLoggingOn |
Gets or sets a value that indicates whether transactions should be logged for this VU.
(Inherited from VirtualUser.) | |
UniqueID |
Gets a test-wide unique identifier for this Virtual User.
(Inherited from VirtualUser.) | |
VerboseLogging |
Get/set whether to add more information to the VU event log. Set to false to reduce the log sizes.
| |
VUName |
Gets the name of the group that this Virtual User belongs to.
(Inherited from VirtualUser.) | |
WebBrowser |
Gets the WebBrowser belonging to this Virtual User.
(Inherited from WebBrowserVirtualUser.) | |
WindowsEvents |
Filter for Citrix Events.
|
See Also