WinList Class

Represents a list control to test the user interface (UI) of Windows Forms.

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.TestTools.UITesting.UITestControl
    Microsoft.VisualStudio.TestTools.UITesting.WinControls.WinControl
      Microsoft.VisualStudio.TestTools.UITesting.WinControls.WinList

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

Syntax

'Declaration
Public Class WinList _
    Inherits WinControl

public class WinList : WinControl

public ref class WinList : public WinControl

type WinList =  
    class
        inherit WinControl
    end

public class WinList extends WinControl

The WinList type exposes the following members.

Constructors

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

Top

Properties

	Name	Description
	AccessKey	Gets the access key that is assigned to this control. (Inherited from WinControl.)
	BoundingRectangle	Gets the Bounding rectangle for this control. (Inherited from UITestControl.)
	CheckedIndices	Gets or sets an array of indexes for those items in the list that are selected.
	CheckedItems	Gets or sets an array of list items that are checked.
	ClassName	Gets the class name for this control. (Inherited from UITestControl.)
	Columns	Gets the collection of columns in this list control.
	Container	Gets or sets the container of this UITestControl. (Inherited from UITestControl.)
	ControlId	Gets the ID that is assigned to this control. (Inherited from WinControl.)
	ControlName	Gets the name of this control. (Inherited from WinControl.)
	ControlType	Gets the type of the UI Control. (Inherited from UITestControl.)
	Enabled	Gets a value that indicates whether this control is enabled. (Inherited from UITestControl.)
	Exists	Gets a value that indicates whether this control exists on the user interface. (Inherited from UITestControl.)
	FilterProperties	Gets the property-value pair collection that is used to disambiguate a control. (Inherited from UITestControl.)
	FriendlyName	Gets the name of this control to use in the user interface. (Inherited from UITestControl.)
	HasFocus	Gets a value that indicates whether this control currently has the focus in the user interface. (Inherited from UITestControl.)
	HelpText	Gets the help text that is assigned to this control. (Inherited from WinControl.)
	HorizontalScrollBar	Gets or sets the horizontal scroll bar component of this list control.
	IsCheckedList	Gets a value that indicates whether this list is a checked list.
	IsIconView	Gets a value that indicates whether this list control is an icon-view.
	IsListView	Gets a value that indicates whether this list is in list-view.
	IsMultipleSelection	Gets a value that indicates whether this list is enabled for multiple selection.
	IsReportView	Gets a value that indicates whether this list is in report view.
	IsSmallIconView	Gets a value that indicates whether this list is in small icon-view.
	IsTopParent	Gets a value that indicates whether this control is the top-level element. (Inherited from UITestControl.)
	Items	Gets the collection of all items in this list.
	Name	Gets the name of this control. (Inherited from UITestControl.)
	NativeElement	Gets the native technology element that corresponds to this control. (Inherited from UITestControl.)
	SearchConfigurations	Gets or sets search configurations. (Inherited from UITestControl.)
	SearchProperties	Gets the property-value pair collection that is used to identify a control. (Inherited from UITestControl.)
	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.)
	SelectedIndices	Gets an array of indexes for the selected items in this list.
	SelectedItems	Gets an array of the selected items in this list.
	SelectedItemsAsString	Gets a string that contains a delimited list of all selected items in this list.
	TechnologyName	Gets or sets the technology framework that implements this control. (Inherited from UITestControl.)
	TopParent	Gets the top-level parent of this control. (Inherited from UITestControl.)
	VerticalScrollBar	Gets the vertical scrollbar component of this list.
	WindowHandle	Gets the window handle for this control. (Inherited from UITestControl.)
	WindowTitles	Gets a collection of the window titles of the top-level window. (Inherited from UITestControl.)

Top

Methods

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

WinList.PropertyNames

WinControl