UITestInterpreterCore Class

Article
09/08/2015

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

The result of interpretation depends on the UITestActionInvoker value.

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

Inheritance Hierarchy

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

Syntax

public class UITestInterpreterCore : IDisposable

public ref class UITestInterpreterCore : IDisposable

type UITestInterpreterCore = 
    class
        interface IDisposable
    end

Public Class UITestInterpreterCore
    Implements IDisposable

Constructors

	Name	Description
	UITestInterpreterCore(UITest)	Creates an instance of UITestInterpreter for a given UITest

Properties

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

Methods

	Name	Description
	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.
	Dispose()	Disposes the object.
	Dispose(Boolean)	Actual dispose implementation.
	Equals(Object)	(Inherited from Object.)
	ExecuteAction(UITestAction, UIMap)	Executes the given action.
	ExecuteStep()	Executes (that is, interprets) the current step in the currently selected ActionList.
	ExecuteTest()	Executes (that is, interprets) the current UITest object.
	ExecuteTest(Int64, Int64)	Executes (that is, interprets) the current UITest object for the actions in the specified range.
	ExecuteTest(UITest)	Executes (that is, interprets) the given UITest object.
	ExecuteTest(UITest, Int64, Int64)	Executes (that is, interprets) the given UITest object for the actions in the specified range.
	Finalize()	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	IsExpectedExceptionFromActionExecution(Exception)	Returns true if the given exception is expected from the execution of an action.
	LogActionExecutionException(Exception)	Logs data for action execution exception.
	MemberwiseClone()	(Inherited from Object.)
	MoveToFirstStep()	Moves the current action pointer to the first action of the currently selected ActionList.
	MoveToLastStep()	Moves the current action pointer to the last action of the currently selected ActionList.
	MoveToNextStep()	Moves the action pointer to the next action of the currently selected ActionList.
	MoveToPreviousStep()	Moves the action pointer to the previous action of the currently selected ActionList.
	MoveToStepNumber(Int32)	Moves the current action pointer to the given action index in the currently selected ActionList.
	OnErrorHandledByUser(UITestErrorEventArgs)	Called after the user handles the action execution error. This can be used to trace log something.
	RaisePlaybackProgressEvent(UITestProgressEventArgs)	Raise playback progress event.
	ToString()	(Inherited from Object.)

Events

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

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.