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

  NameDescription
Public methodAdd
Merges the specified IDataDictionary into this IDataDictionary.
(Inherited from VirtualUser.)
Protected methodAddInitialVirtualUserScript
Internal use only.
(Inherited from VirtualUser.)
Public methodAtEndOfIteration
This method is called at the end of every iteration.
(Inherited from VirtualUser.)
Public methodAtStartOfIteration
This method is called at the start of every iteration.
(Overrides VirtualUser AtStartOfIteration .)
Public methodAttachLogMessageSender
For internal use only.
(Overrides VirtualUser AttachLogMessageSender(IMessageSender).)
Public methodClearProgressPoint
Clears the current progress point set for this Virtual User.
(Inherited from VirtualUser.)
Public methodCreateBackgroundScript
Creates a new background script and starts it if requested.
(Inherited from VirtualUser.)
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 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 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.
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 methodLogCurrentDataValues
Write all of the current data values to the VU event log
(Inherited from VirtualUser.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
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
This method is called whenever an error is written to the VU event log using the Error(String), Error(String, Exception) or Error(String, String) methods.
(Inherited from VirtualUser.)
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.
(Overrides VirtualUser OnStartFinalSection .)
Public methodOnStartInitialSection
This method is called whenever the Virtual User is about to start executing the initial sequence of scripts in its workflow.
(Overrides VirtualUser OnStartInitialSection .)
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.)
Protected methodPost
This method is called after all scripts have finished executing.
(Inherited from VirtualUser.)
Protected methodPre
This method is called before any scripts are executed.
(Inherited from VirtualUser.)
Public methodPrepareRequest
This method is called immediately before a Request object is sent to the web server.
Public methodProcessResponse
This method is called immediately after a Response is returned from the web server.
Public methodRaiseAlert
Writes an alert of the specified severity to the Alerts table in Test Controller.
(Inherited from VirtualUser.)
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 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 methodRun
Internal use only.
(Inherited from VirtualUser.)
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 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 methodStartBackgroundScript
Starts previously created and not started background script
(Inherited from VirtualUser.)
Protected methodStartCustomVUWatcher
For internal use only.
(Inherited from VirtualUser.)
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
For internal use only.
(Inherited from VirtualUser.)
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 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 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 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 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 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
See Also