UITestInterpreter Class

Article
09/09/2015

Executes each test action in a user interface (UI) test and interprets the results of each action by using the value of the ActionInvoker property.

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

Inheritance Hierarchy

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

Syntax

public class UITestInterpreter : UITestInterpreterCore

public ref class UITestInterpreter : UITestInterpreterCore

type UITestInterpreter = 
    class
        inherit UITestInterpreterCore
    end

Public Class UITestInterpreter
    Inherits UITestInterpreterCore

Constructors

	Name	Description
	UITestInterpreter(UITest)	Initializes a new instance of the UITestInterpreter class.

Properties

	Name	Description
	ActionInvoker	Gets or sets the UITestActionInvoker to interpret this test.(Overrides UITestInterpreterCore.ActionInvoker.)
	CurrentAction	Current action being executed.(Inherited from UITestInterpreterCore.)
	PlaybackInProgress	True if playback is in progress.(Inherited from UITestInterpreterCore.)
	PlaybackUITest	Gets the UITest that is being executed.(Inherited from UITestInterpreterCore.)

Methods

	Name	Description
	Cancel()	Cancels the interpretation of the current step or test.(Overrides UITestInterpreterCore.Cancel().)
	Dispose()	Disposes the object.(Inherited from UITestInterpreterCore.)
	Dispose(Boolean)	Optionally releases resources.(Overrides UITestInterpreterCore.Dispose(Boolean).)
	Equals(Object)	(Inherited from Object.)
	ExecuteAction(UITestAction, UIMap)	Executes the given action. The action contains an ID for the UIObject on which it acts. This ID is used to get a queryid for the object and this is passed to the invoke method of the input action object. The Invoke method also requires an object of the UITestActionInvoker interface type. In this case the default is the UITestPlayback type that implements the UITestActionInvoker.(Overrides UITestInterpreterCore.ExecuteAction(UITestAction, UIMap).)
	ExecuteStep()	Executes (that is, interprets) the current step in the currently selected ActionList.(Inherited from UITestInterpreterCore.)
	ExecuteTest()	Executes (that is, interprets) the current UITest object.(Inherited from UITestInterpreterCore.)
	ExecuteTest(Int64, Int64)	Executes (that is, interprets) the current UITest object for the actions in the specified range.(Inherited from UITestInterpreterCore.)
	ExecuteTest(UITest)	Executes the given test.
	ExecuteTest(UITest, Int64, Int64)	Executes the given test for the specified range of actions.
	Finalize()	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	HighlightElement()	Highlights the UI element that is associated with the current action.
	IsExpectedExceptionFromActionExecution(Exception)	Returns true if the given exception is expected from the execution of an action.(Overrides UITestInterpreterCore.IsExpectedExceptionFromActionExecution(Exception).)
	LogActionExecutionException(Exception)	Logs SQM Data for Playback Exception.(Overrides UITestInterpreterCore.LogActionExecutionException(Exception).)
	MemberwiseClone()	(Inherited from Object.)
	MoveToFirstStep()	Moves the current action pointer to the first action of the currently selected ActionList.(Inherited from UITestInterpreterCore.)
	MoveToLastStep()	Moves the current action pointer to the last action of the currently selected ActionList.(Inherited from UITestInterpreterCore.)
	MoveToNextStep()	Moves the action pointer to the next action of the currently selected ActionList.(Inherited from UITestInterpreterCore.)
	MoveToPreviousStep()	Moves the action pointer to the previous action of the currently selected ActionList.(Inherited from UITestInterpreterCore.)
	MoveToStepNumber(Int32)	Moves the current action pointer to the given action index in the currently selected ActionList.(Inherited from UITestInterpreterCore.)
	OnErrorHandledByUser(UITestErrorEventArgs)	Called after user handles the action execution error. This can be used to trace log something.(Overrides UITestInterpreterCore.OnErrorHandledByUser(UITestErrorEventArgs).)
	RaisePlaybackProgressEvent(UITestProgressEventArgs)	Raise playback progress event.(Inherited from UITestInterpreterCore.)
	RaiseWaitForThinkTimeEvent(UITestAction, Int32)	Raises the E:Microsoft.VisualStudio.TestTools.UITest.CodeGeneration.UITestInterpreter.InterpreterProgress event.
	ToString()	(Inherited from Object.)
	Unhighlight()	Removes highlighting from the UI element that is associated with the current action.

Events

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

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.