Share via

BrowserWindow Class

Represents a Web browser window in the test framework of vstsEssTest.

Inheritance Hierarchy

Object
  Microsoft.VisualStudio.TestTools.UITesting.UITestControl
    Microsoft.VisualStudio.TestTools.UITesting.ApplicationUnderTest
      Microsoft.VisualStudio.TestTools.UITesting.BrowserWindow

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

Syntax

'Declaration
<CLSCompliantAttribute(True)> _
Public Class BrowserWindow _
    Inherits ApplicationUnderTest

[CLSCompliantAttribute(true)]
public class BrowserWindow : ApplicationUnderTest

[CLSCompliantAttribute(true)]
public ref class BrowserWindow : public ApplicationUnderTest

[<CLSCompliantAttribute(true)>]
type BrowserWindow =  
    class 
        inherit ApplicationUnderTest 
    end

public class BrowserWindow extends ApplicationUnderTest

The BrowserWindow type exposes the following members.

Constructors

  Name Description
Public method BrowserWindow Initializes a new instance of the BrowserWindow class.

Top

Properties

  Name Description
Public propertyStatic member AllowPopups Gets or sets a value that determines whether the Web browser window allows popup windows.
Public property AlwaysOnTop Gets a value that indicates whether the application window always appears on top. (Inherited from ApplicationUnderTest.)
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 CloseOnPlaybackCleanup Gets or Sets whether to close the ApplicationUnderTest automatically at playback cleanup. (Inherited from ApplicationUnderTest.)
Public property Container Gets or sets the container of this UITestControl. (Inherited from UITestControl.)
Public property ControlType Gets the type of the UI Control. (Inherited from UITestControl.)
Public propertyStatic member CurrentBrowser Gets or sets the current browser from the list of registered browsers.
Public property CurrentDocumentWindow Gets the currently active Document Window that is associated with the browser.
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 HasTitleBar Gets a value that indicates whether the application window has a title bar. (Inherited from ApplicationUnderTest.)
Public property Height Gets height of the control. (Inherited from UITestControl.)
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 Maximized Gets or sets a value that indicates whether the application window is maximized. (Inherited from ApplicationUnderTest.)
Public property Minimized Gets or sets a value that indicates whether the application window is minimized. (Inherited from ApplicationUnderTest.)
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 Popup Gets a value that indicates whether the application window is a pop-up window. (Inherited from ApplicationUnderTest.)
Public property Process Gets or sets the underlying Process object. (Inherited from ApplicationUnderTest.)
Public property Resizable Gets a value that indicates whether the application window is resizable. (Inherited from ApplicationUnderTest.)
Public property Restored Gets or sets a value that indicates whether the application window is restored. (Inherited from ApplicationUnderTest.)
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 ShowInTaskbar Gets a value that indicates whether the program icon appears in the taskbar. (Inherited from ApplicationUnderTest.)
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 Title Gets or sets the title of the application that is under test. (Inherited from ApplicationUnderTest.)
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 Transparent Gets a value that indicates whether the application window is transparent. (Inherited from ApplicationUnderTest.)
Public property Uri Gets the URI of the loaded page.
Public property Version Gets the version of the Web browser.
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 Back Makes the Web browser go back to the previous Web page.
Public method CaptureImage Captures the image of the UITestControl. The UITestControl must be present on the screen. (Inherited from UITestControl.)
Public methodStatic member ClearCache Clears the cache of the Web browser.
Public methodStatic member ClearCookies Clears the cookies of the Web browser.
Public method Close (Overrides ApplicationUnderTest.Close().)
Public method CopyFrom Creates a user interface (UI) control object that references the same element on the user interface as the original control. (Overrides UITestControl.CopyFrom(UITestControl).)
Public method Dispose() Releases all resources that are used by the ApplicationUnderTest. (Inherited from ApplicationUnderTest.)
Protected method Dispose(Boolean) Releases the unmanaged resources that are used by the BrowserWindow and optionally releases the managed resources. (Overrides ApplicationUnderTest.Dispose(Boolean).)
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.)
Public method ExecuteScript
Protected method Finalize Finalizer for ApplicationUnderTest. (Inherited from ApplicationUnderTest.)
Public method Find Finds this application window in the user interface. (Inherited from ApplicationUnderTest.)
Public method FindMatchingControls Returns a collection of all UITestControls that match the specified SearchProperties and FilterProperties. (Inherited from UITestControl.)
Public method Forward Makes the Web browser go forward to the next page in the history list.
Public methodStatic member FromProcess Creates a reference to a Web browser window that is running in an existing process.
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 Returns an array of UITestControl objects that will be used for searching. (Inherited from UITestControl.)
Public methodStatic member Launch() Launches a Web browser window and returns the Web browser window object.
Public methodStatic member Launch(array<String[]) Launches a Web browser window by using the given array of command-line arguments and returns the browser window object.
Public methodStatic member Launch(Uri) Launches a Web browser window by using the given URI and returns the Web browser window object.
Public methodStatic member Locate Finds a Web browser window by using the window title and returns a corresponding browser window object.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method NavigateToHomepage Opens the home page in the Web browser window.
Public method NavigateToUrl Opens the specified Web page in the Web browser.
Public method PerformDialogAction(BrowserDialogAction) Searches for a scripted Web dialog and performs the specified action.
Public method PerformDialogAction(BrowserDialogAction, Object) Searches for a scripted Web dialog and performs the specified action by using the provided parameter value.
Public method Refresh Refreshes the Web browser window.
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.)
Protected method Shutdown Forces the application to shut down. (Inherited from ApplicationUnderTest.)
Public method StopPageLoad Stops loading the page in the Web browser window.
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 Namespace