UITestControl Class

This class provides the ability to locate controls on a User Interface. It provides properties and methods that are generic to controls across technologies.

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.TestTools.UITesting.UITestControl
    Microsoft.VisualStudio.TestTools.UITesting.ApplicationUnderTest
    Microsoft.VisualStudio.TestTools.UITesting.HtmlControls.HtmlControl
    Microsoft.VisualStudio.TestTools.UITesting.WinControls.WinControl
    Microsoft.VisualStudio.TestTools.UITesting.WpfControls.WpfControl

Namespace:  Microsoft.VisualStudio.TestTools.UITesting
Assembly:  Microsoft.VisualStudio.TestTools.UITesting (in Microsoft.VisualStudio.TestTools.UITesting.dll)

Syntax

'Declaration
Public Class UITestControl
public class UITestControl
public ref class UITestControl
type UITestControl =  class end
public class UITestControl

The UITestControl type exposes the following members.

Constructors

  Name Description
Public method UITestControl() Initializes a new instance of the UITestControl class.
Public method UITestControl(UITestControl) Initializes a new instance of the UITestControl class and specifies the container for locating controls.

Top

Properties

  Name Description
Public property BoundingRectangle Gets the Bounding rectangle for this control.
Public property ClassName Gets the class name for this control.
Public property Container Gets or sets the container of this UITestControl.
Public property ControlType Gets the type of the UI Control.
Public propertyStatic member Desktop Gets the UI Control for the desktop.
Public property Enabled Gets a value that indicates whether this control is enabled.
Public property Exists Gets a value that indicates whether this control exists on the user interface.
Public property FilterProperties Gets the property-value pair collection that is used to disambiguate a control.
Public property FriendlyName Gets the name of this control to use in the user interface.
Public property HasFocus Gets a value that indicates whether this control currently has the focus in the user interface.
Public property IsTopParent Gets a value that indicates whether this control is the top-level element.
Public property Name Gets the name of this control.
Public property NativeElement Gets the native technology element that corresponds to this control.
Public property SearchConfigurations Gets or sets search configurations.
Public property SearchProperties Gets the property-value pair collection that is used to identify a control.
Protected property SearchPropertiesSetExplicitly Gets a value that indicates whether the search properties for this control were set by the user in the user interface.
Public property TechnologyName Gets or sets the technology framework that implements this control.
Public property TopParent Gets the top-level parent of this control.
Public property WindowHandle Gets the window handle for this control.
Public property WindowTitles Gets a collection of the window titles of the top-level window.

Top

Methods

  Name Description
Public method CaptureImage Captures the image of the UITestControl. The UITestControl must be present on the screen.
Public method CopyFrom Creates a UITestControl object that references the same element on the user interface as the original UITestControl.
Public method DrawHighlight Highlights the control.
Public method EnsureClickable() Scrolls the user interface to make sure that the control is clickable.
Public method EnsureClickable(Point) Scrolls the user interface to a specific point to make sure that the control is clickable.
Public method Equals Determines whether the specified UITestControl is equal to the current UITestControl. (Overrides Object.Equals(Object).)
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 Find Finds the UITestControl.
Public method FindMatchingControls Returns a collection of all UITestControls that match the specified SearchProperties and FilterProperties.
Public method GetChildren Returns a collection of all first-level children of the current UITestControl.
Public method GetClickablePoint Returns a clickable point on the control.
Public method GetHashCode Returns a unique value that represents the current UITestControl instance. (Overrides Object.GetHashCode().)
Public method GetParent Returns the parent of the current UITestControl.
Public method GetProperty Gets the value of the specified property.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method GetUITestControlsForSearch Returns an array of UITestControl objects that will be used for searching.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method SetFocus Sets the keyboard focus to the UITestControl.
Public method SetProperty Sets the value of a given property.
Public method ToString Returns a String that represents the current UITestControl. (Overrides Object.ToString().)
Public method TryGetClickablePoint Returns a clickable point in the UITestControl. If the control is not clickable, this method returns false.
Public methodStatic member WaitForCondition<T>(T, Predicate<T>) Blocks the current thread until the specified condition is met, or until the default time-out expires.
Public methodStatic member WaitForCondition<T>(T, Predicate<T>, Int32) Blocks the current thread until the specified condition is met, or until the specified time-out expires.
Public method WaitForControlCondition(Predicate<UITestControl>) Blocks the current thread until this control meets the specified condition, or until the default time-out expires.
Public method WaitForControlCondition(Predicate<UITestControl>, Int32) Blocks the current thread until this control meets the specified condition, or until the specified time-out expires.
Public method WaitForControlEnabled() Blocks the current thread until this control is enabled, or until the default time-out expires.
Public method WaitForControlEnabled(Int32) Blocks the current thread until this control is enabled, or until the specified time-out expires.
Public method WaitForControlExist() Blocks the current thread until this control occurs in the user interface, or until the default time-out expires.
Public method WaitForControlExist(Int32) Blocks the current thread until this control occurs in the user interface, or until the specified time-out expires.
Public method WaitForControlNotExist() Blocks the current thread until this control no longer exists in the user interface, or until the default time-out expires.
Public method WaitForControlNotExist(Int32) Blocks the current thread until this control no longer occurs in the user interface, or until the specified time-out expires.
Public method WaitForControlPropertyEqual(String, Object) Blocks the current thread until the specified property of this control is equal to the specified value, or until the default time-out expires.
Public method WaitForControlPropertyEqual(String, Object, Int32) Blocks the current thread until the specified property of this control is equal to the specified value, or until the specified time-out expires.
Public method WaitForControlPropertyNotEqual(String, Object) Blocks the current thread until the specified property of this control is not equal to the specified value, or until the default time-out expires.
Public method WaitForControlPropertyNotEqual(String, Object, Int32) Blocks the current thread until the specified property of this control is not equal to the specified value, or until the specified time-out expires.
Public method WaitForControlReady() Blocks the current thread until this control is ready to receive mouse or keyboard input, or until the default time-out expires.
Public method WaitForControlReady(Int32) Blocks the current thread until this control is ready to receive mouse or keyboard input, or until the specified time-out expires.

Top

Operators

  Name Description
Public operatorStatic member Equality Indicates whether two UITestControl instances are equal.
Public operatorStatic member Inequality Indicates whether two UITestControl instances are not equal.

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.UITesting Namespace