UITestInterpreter Class

Article
04/26/2013

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.

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.CodeGeneration (in Microsoft.VisualStudio.TestTools.UITest.CodeGeneration.dll)

Syntax

'Declaration
Public Class UITestInterpreter _
    Inherits UITestInterpreterCore

public class UITestInterpreter : UITestInterpreterCore

public ref class UITestInterpreter : public UITestInterpreterCore

type UITestInterpreter =  
    class 
        inherit UITestInterpreterCore 
    end

public class UITestInterpreter extends UITestInterpreterCore

The UITestInterpreter type exposes the following members.

Constructors

	Name	Description
	UITestInterpreter	Initializes a new instance of the UITestInterpreter class.

Top

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.)

Top

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	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	ExecuteAction	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(UITest)	Executes the given test.
	ExecuteTest(Int64, Int64)	Executes (that is, interprets) the current UITest object for the actions in the specified range. (Inherited from UITestInterpreterCore.)
	ExecuteTest(UITest, Int64, Int64)	Executes the given test for the specified range of actions.
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	HighlightElement	Highlights the UI element that is associated with the current action.
	IsExpectedExceptionFromActionExecution	Returns true if the given exception is expected from the execution of an action. (Overrides UITestInterpreterCore.IsExpectedExceptionFromActionExecution(Exception).)
	LogActionExecutionException	Logs SQM Data for Playback Exception. (Overrides UITestInterpreterCore.LogActionExecutionException(Exception).)
	MemberwiseClone	Creates a shallow copy of the current Object. (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	Moves the current action pointer to the given action index in the currently selected ActionList. (Inherited from UITestInterpreterCore.)
	OnErrorHandledByUser	Called after user handles the action execution error. This can be used to trace log something. (Overrides UITestInterpreterCore.OnErrorHandledByUser(UITestErrorEventArgs).)
	RaisePlaybackProgressEvent	Raise playback progress event. (Inherited from UITestInterpreterCore.)
	RaiseWaitForThinkTimeEvent	Raises the InterpreterProgress event.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Unhighlight	Removes highlighting from the UI element that is associated with the current action.

Top

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.)

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.

Share via