UITest Class

 

Represents a coded UI test in Visual Studio.

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

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.TestTools.UITest.Common.UITest

Syntax

public class UITest
public ref class UITest 
type UITest = class end
Public Class UITest

Constructors

Name Description
System_CAPS_pubmethod UITest()

Initializes a new instance of the UITest class.

System_CAPS_pubmethod UITest(IEnumerable<UITestAction>)

Initializes a new instance of the UITest class by using the provided test actions.

System_CAPS_pubmethod UITest(IEnumerable<UITestAction>, UIMap)

Initializes a new instance of the UITest class.

Properties

Name Description
System_CAPS_pubproperty AssemblyVersion

Gets or sets the version for the assembly.

System_CAPS_pubproperty CleanupActions

Gets or sets the actions for the cleanup process.

System_CAPS_pubproperty Configuration

Gets or sets the XML environment configuration file for this coded UI test.

System_CAPS_pubproperty CurrentActionList

Gets or sets the list of current coded UI test actions.

System_CAPS_pubproperty ExecuteActions

Gets or sets the test actions to be executed as part of the coded UI test.

System_CAPS_pubproperty Id

Gets or sets the unique identifier for this coded UI test.

System_CAPS_pubproperty InitializeActions

Gets or sets a list of actions to execute as part of the coded UI test initialization process.

System_CAPS_pubproperty Maps

Gets a collection of UIMap objects for this coded UI test.

System_CAPS_pubproperty Name

Gets or sets the name of this coded UI test.

System_CAPS_pubproperty OnErrorActions

Gets or sets a list of test actions to execute if the test execution encounters an error.

System_CAPS_pubproperty ValueMap

Gets or sets the value map for this UI test object.

System_CAPS_pubproperty Version

Gets or sets the version for this UI test.

Methods

Name Description
System_CAPS_pubmethod Append(IEnumerable<UITestAction>)

Appends the provided list of test actions to this UI test.

System_CAPS_pubmethod Append(IEnumerable<UITestAction>, UIMap)

Appends the test actions and objects from the provided UI map to this UI test.

System_CAPS_pubmethod Append(UITest, Int64, Int64)

Appends the test actions from the provided UI test into this UI test at the provided range.

System_CAPS_pubmethod BindWithCurrentValues()

Binds the parameters that are used in this UI test that have currently loaded values.

System_CAPS_pubmethodSystem_CAPS_static CompareEnvironments(UITestEnvironment, UITestEnvironment)

Compares the two given UITestEnvironment objects and returns a collection of mismatches.

System_CAPS_pubmethod CompareStoredEnvironmentWithCurrentEnvironment()

Compares the recorder configuration, if it exists, with the system environment that was captured at startup, and returns a collection of mismatches.

System_CAPS_pubmethodSystem_CAPS_static Create(Stream)

Creates a UI test by using the provided stream.

System_CAPS_pubmethodSystem_CAPS_static Create(String)

Creates a UI test by using the specified file.

System_CAPS_pubmethod CreateAndAddParameter(UIObject, String, String)

Parameterizes an action and creates the parameter by using the provided UI test object, property name, and parameter name.

System_CAPS_pubmethod CreateAndAddParameter(UITestAction, String)

Parameterizes an action and creates the parameter by using the provided test action and parameter name.

System_CAPS_pubmethod Equals(Object)

(Overrides Object.Equals(Object).)

System_CAPS_pubmethod Equals(UITest)

Determines whether the provided UI test object is equal to this UI test object.

System_CAPS_protmethod Finalize()

(Inherited from Object.)

System_CAPS_pubmethod GetActionList(UITestActionListSection)

Gets the UI test action list that corresponds to a given UI test action section.

System_CAPS_pubmethod GetHashCode()

(Overrides Object.GetHashCode().)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_protmethod MemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethod Save(Stream)

Saves this UI test to a stream.

System_CAPS_pubmethod Save(String)

Saves this UI test to a file.

System_CAPS_pubmethod SetAndBindParameterValues(DataRow)

Binds the parameters that are used in this UI test to the values in a data row.

System_CAPS_pubmethod ToString()

(Inherited from Object.)

Events

Name Description
System_CAPS_pubeventSystem_CAPS_static Executing

Occurs when the framework starts to execute this UI test.

System_CAPS_pubeventSystem_CAPS_static Saving

Occurs when the framework starts to save this UI test.

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

Microsoft.VisualStudio.TestTools.UITest.Common Namespace
How to: Create a Coded UI Test

Return to top