WinEdit Class

  • Article

Represents an edit control to test the user interface (UI) of Windows Forms.

Inheritance Hierarchy

Object
  Microsoft.VisualStudio.TestTools.UITesting.UITestControl
    Microsoft.VisualStudio.TestTools.UITesting.WinControls.WinControl
      Microsoft.VisualStudio.TestTools.UITesting.WinControls.WinEdit

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

Syntax

'Declaration
<CLSCompliantAttribute(True)> _
Public Class WinEdit _
    Inherits WinControl

[CLSCompliantAttribute(true)]
public class WinEdit : WinControl

[CLSCompliantAttribute(true)]
public ref class WinEdit : public WinControl

[<CLSCompliantAttribute(true)>]
type WinEdit =  
    class 
        inherit WinControl 
    end

public class WinEdit extends WinControl

The WinEdit type exposes the following members.

Constructors

  Name Description
Public method WinEdit() Initializes a new instance of the WinEdit class.
Public method WinEdit(UITestControl) Initializes a new instance of the WinEdit class by using the provided parent control.

Top

Properties

  Name Description
Public property AccessibleDescription Gets the description of the underlying IAccessible of this WinControl. (Inherited from WinControl.)
Public property AccessKey Gets the access key that is assigned to this control. (Inherited from WinControl.)
Public property BoundingRectangle Gets the Bounding rectangle for this control. (Inherited from UITestControl.)
Public property ClassName Gets the class name for this control. (Inherited from UITestControl.)
Public property Container Gets or sets the container of this UITestControl. (Inherited from UITestControl.)
Public property ControlId Gets the ID that is assigned to this control. (Inherited from WinControl.)
Public property ControlName Gets the name of this control. (Inherited from WinControl.)
Public property ControlType Gets the type of the UI Control. (Inherited from UITestControl.)
Public property CopyPastedText Gets or sets the text in the text box by using copy-paste.
Public property CurrentLine Gets the line number for the cursor position in a multiline edit control.
Public property Enabled Gets a value that indicates whether this control is enabled. (Inherited from UITestControl.)
Public property Exists Gets a value that indicates whether this control exists on the user interface. (Inherited from UITestControl.)
Public property FilterProperties Gets the property-value pair collection that is used to disambiguate a control. (Inherited from UITestControl.)
Public property FriendlyName Gets the name of this control to use in the user interface. (Inherited from UITestControl.)
Public property HasFocus Gets a value that indicates whether this control currently has the focus in the user interface. (Inherited from UITestControl.)
Public property Height Gets height of the control. (Inherited from UITestControl.)
Public property HelpText Gets the help text that is assigned to this control. (Inherited from WinControl.)
Public property InsertionIndexAbsolute Gets or sets the character position of the caret that is relative to the first character in the control.
Public property InsertionIndexLineRelative Gets the column number of the caret position in the line that contains the caret.
Public property IsPassword Gets a value that indicates whether this edit control contains a password.
Public property IsTopParent Gets a value that indicates whether this control is the top-level element. (Inherited from UITestControl.)
Public property Left Gets the x-coordinate of the left edge of the control. (Inherited from UITestControl.)
Public property LineCount Gets the number of lines in this edit control.
Public property MaxLength Gets the maximum number of characters that can be typed into this edit control.
Public property Name Gets the name of this control. (Inherited from UITestControl.)
Public property NativeElement Gets the native technology element that corresponds to this control. (Inherited from UITestControl.)
Public property Password Sets the encrypted text of this edit control.
Public property ReadOnly Gets a value that indicates whether this edit control is read-only.
Public property SearchConfigurations Gets or sets search configurations. (Inherited from UITestControl.)
Public property SearchProperties Gets the property-value pair collection that is used to identify a control. (Inherited from UITestControl.)
Protected property SearchPropertiesSetExplicitly Gets a value that indicates whether the search properties for this control were set by the user in the user interface. (Inherited from UITestControl.)
Public property SelectionEnd Gets or sets the end point for selected text.
Public property SelectionStart Gets or sets the start point for selected text.
Public property SelectionText Gets or sets the content of the selected text.
Public property State Gets the state of the control. (Inherited from UITestControl.)
Public property TechnologyName Gets or sets the technology framework that implements this control. (Inherited from UITestControl.)
Public property Text Gets or sets the text in this edit control.
Public property ToolTipText (Inherited from WinControl.)
Public property Top Gets the x-coordinate of the top edge of the control. (Inherited from UITestControl.)
Public property TopParent Gets the top-level parent of this control. (Inherited from UITestControl.)
Public property Width Gets width of the control. (Inherited from UITestControl.)
Public property WindowHandle Gets the window handle for this control. (Inherited from UITestControl.)
Public property WindowTitles Gets a collection of the window titles of the top-level window. (Inherited from UITestControl.)

Top

Methods

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

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

WinEdit.PropertyNames

WinControl