UITestInterpreterCore Class

  • Article

The class to iterate the actions in an UITest object and interpret those.

The result of interpretation depends on the UITestActionInvoker value.

Inheritance Hierarchy

Object
  Microsoft.VisualStudio.TestTools.UITest.CodeGeneration.UITestInterpreterCore
    Microsoft.VisualStudio.TestTools.UITest.CodeGeneration.UITestInterpreter

Namespace:  Microsoft.VisualStudio.TestTools.UITest.CodeGeneration
Assembly:  Microsoft.VisualStudio.TestTools.UITest.Common (in Microsoft.VisualStudio.TestTools.UITest.Common.dll)

Syntax

'Declaration
Public Class UITestInterpreterCore _
    Implements IDisposable

public class UITestInterpreterCore : IDisposable

public ref class UITestInterpreterCore : IDisposable

type UITestInterpreterCore =  
    class 
        interface IDisposable 
    end

public class UITestInterpreterCore implements IDisposable

The UITestInterpreterCore type exposes the following members.

Constructors

  Name Description
Public method UITestInterpreterCore Creates an instance of UITestInterpreter for a given UITest

Top

Properties

  Name Description
Public property ActionInvoker Gets or sets the UITestActionInvoker to use to execute actions in the UITest.
Protected property CurrentAction Current action being executed.
Protected property PlaybackInProgress True if playback is in progress.
Public property PlaybackUITest Gets the UITest that is being executed.

Top

Methods

  Name Description
Public method Cancel Cancels the execution (that is, interpretation) of the current step or test. This call blocks until the UITest execution is canceled and playback returns. This must be called from a different thread from the thread that is executing the UITest.
Public method Dispose() Disposes the object.
Protected method Dispose(Boolean) Actual dispose implementation.
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method ExecuteAction Executes the given action.
Public method ExecuteStep Executes (that is, interprets) the current step in the currently selected ActionList.
Public method ExecuteTest() Executes (that is, interprets) the current UITest object.
Public methodStatic member ExecuteTest(UITest) Executes (that is, interprets) the given UITest object.
Public method ExecuteTest(Int64, Int64) Executes (that is, interprets) the current UITest object for the actions in the specified range.
Public methodStatic member ExecuteTest(UITest, Int64, Int64) Executes (that is, interprets) the given UITest object for the actions in the specified range.
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method IsExpectedExceptionFromActionExecution Returns true if the given exception is expected from the execution of an action.
Protected method LogActionExecutionException Logs data for action execution exception.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method MoveToFirstStep Moves the current action pointer to the first action of the currently selected ActionList.
Public method MoveToLastStep Moves the current action pointer to the last action of the currently selected ActionList.
Public method MoveToNextStep Moves the action pointer to the next action of the currently selected ActionList.
Public method MoveToPreviousStep Moves the action pointer to the previous action of the currently selected ActionList.
Public method MoveToStepNumber Moves the current action pointer to the given action index in the currently selected ActionList.
Protected method OnErrorHandledByUser Called after the user handles the action execution error. This can be used to trace log something.
Protected method RaisePlaybackProgressEvent Raise playback progress event.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Events

  Name Description
Public event ActionCompleted Event raised after an UITestAction is executed.
Public event ActionListCompleted Event raised after execution of each ActionList is completed.
Public event ActionListStarted Event raised before execution of each ActionList is started.
Public event ActionStarted Event raised before an UITestAction is executed.
Public event InterpreterError Event raised when an error occurs when interpreting the UITest.
Public event InterpreterProgress Event raised to update progress when interpreting the UITest.
Public event InterpreterWarning Event raised when a warning occurs when interpreting the UITest.
Public event UITestCompleted Event raised after execution of UITest is completed.
Public event UITestStarted Event raised before execution of UITest starts.

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.VisualStudio.TestTools.UITest.CodeGeneration Namespace