BrowserApplication Class

Description

Represents the top-level window of a browser application.

Note: BrowserApplication is derived from BaseGuiTestObject and inherits the two scrollbar methods GetHorizontalBar and GetVerticalBar. However, these two methods do not work on a BrowserApplication.

Inheritance Hierarchy

Syntax

C#
public class BrowserApplication : Window, 
VB
'Declaration
Public Class BrowserApplication _
Inherits Window

Properties

Name Description
Application The name of the Application that this Window belongs to. (Inherited from Window)
Background The background color of the GUI object. (Inherited from GuiTestObject)
Enabled Whether the GUI object is enabled. (Inherited from GuiTestObject)
Font The font type of the GUI object. (Inherited from GuiTestObject)
Foreground The foreground color of the GUI object. (Inherited from GuiTestObject)
NativeHandle The native window handle for the object. (Inherited from INativeWindow)
Text The text of the control. (Inherited from TestObject)
Value The value of the control, e.g.: text in a text control. (Inherited from TestObject)
Visible Whether the object is visible. You can only locate visible objects, so by default the value is always true. However, you might need this property when an already located object in the application under test gets invisible during replay. (Inherited from GuiTestObject)
WindowState The state of a window. Values include: 1=minimized, 2=maximized, 3=restored (Inherited from IMoveable)

Methods

Name Description
CaptureBitmap Saves a bitmap image of this object to a file. If you do not specify an absolute file name, the bitmap is saved to the default bitmap location on the machine that runs the Agent, which is %LOCALAPPDATA%/Silk/SilkTest/capturedBitmaps. The captured bitmap's pixels are stored in 32bit RGB order; when parsing the image the 4th byte (alpha channel) of every pixel must be ignored as it is used only for padding. In .NET, the constant System.Drawing.Imaging.PixelFormat.Format32bppRgb can be used for this purpose. (Inherited from TestObject)
ClearCache Clears the browser's cache.
Click Clicks on the object. (Inherited from IClickable)
Close Closes the window. (Inherited from IMoveable)
CloseOtherTabs Closes all tabs except the active one. When several tabs are open, Internet Explorer only displays some of the tabs and scroll buttons. This method closes all other tabs except for the selected one, including the tabs that are not currently visible. This method is not supported for mobile web applications.
CloseSynchron Closes the window and waits until the window is closed. (Inherited from IMoveable)
CloseTab Closes the specified tab. If no tab is specified, the active tab is closed. When several tabs are open, Internet Explorer only displays some of the tabs and scroll buttons. As a result, only the currently visible tabs work with this method, which affects index semantics. For example, only the currently visible tabs can be closed. Index 0 identifies the first visible tab. This method is not supported for mobile Web applications.
DoubleClick Double-clicks a mouse button on the object. (Inherited from IClickable)
Exists Checks if any child object matching the locator exists for an object in the application under test. If the timeout parameter is passed the agent retries finding until the given timeout expires. If no timeout is specified and no object is found initially false is returned immediately. (Inherited from TestObject)
Exists Checks if an object exists in the application under test. (Inherited from TestObject)
ExistsTab Returns true if the tab exists and false otherwise. This method is not supported for mobile web applications.
Find Finds an object specified by an XPath locator. (Inherited from TestObject)
FindAll Finds all objects specified by an XPath locator. (Inherited from TestObject)
GenerateLocator Returns a locator for this object. (Inherited from TestObject)
GetActiveTab Returns the active tab. This method is not supported for mobile Web applications.
GetChildren Returns the child objects of this object. (Inherited from TestObject)
GetCloseWindows Returns the windows that need to be closed in order so that only the main window of the application is open. (Inherited from IMoveable)
GetDynamicMethodList Returns a list of methods (including their signature) that can be dynamically invoked on this TestObject. (Inherited from TestObject)
GetFocus Returns the object with the input focus. (Inherited from IMoveable)
GetHorizontalBar Returns the horizontal scroll bar for this control. (Inherited from IScrollable)
GetNextCloseWindow Returns the next window that need to be closed in order to close all windows of the application except the main window. (Inherited from IMoveable)
GetParent Looks up the parent of this object in the test application. (Inherited from TestObject)
GetProperty Returns the value of the specified property. (Inherited from TestObject)
GetPropertyList Returns a list of property names that can be retrieved for the given object. (Inherited from TestObject)
GetRect Returns the size and position of this object. Per default the returned coordinates are relative to the parent window that contains this object. (Inherited from TestObject)
GetSelectedTab Returns the currently selected tab. This method is not supported for mobile Web applications.
GetSelectedTabIndex Returns the index of the active tab. When several tabs are open, Internet Explorer only displays some of the tabs and scroll buttons. As a result, this method only returns the index relative to the currently visible tabs. Index 0 identifies the first visible tab. This method is not supported for mobile web applications.
GetSelectedTabName Returns the name of the active tab. This method is not supported for mobile web applications.
GetTabCount Returns the number of open tabs. When several tabs are open, Internet Explorer only displays some of the tabs and scroll buttons. As a result, this method only returns the number of currently visible tabs. This method is not supported for mobile web applications.
GetVerticalBar Returns the vertical scroll bar for this control. (Inherited from IScrollable)
HighlightObject Highlights this object. (Inherited from TestObject)
ImageClick Clicks on the specified image asset. (Inherited from TestObject)
ImageClickFile Clicks on the specified image. (Inherited from TestObject)
ImageExists Returns whether the specified image asset exists. (Inherited from TestObject)
ImageExistsFile Returns whether the specified image exists. (Inherited from TestObject)
ImageRectangle Returns the object-relative rectangle of the specified image asset. (Inherited from TestObject)
ImageRectangleFile Returns the object-relative rectangle of the specified image. (Inherited from TestObject)
Invoke Dynamically invokes a method on the test object. (Inherited from TestObject)
InvokeMethods Dynamically invokes a sequence of methods starting at this TestObject. (Inherited from TestObject)
IsActive Returns whether the window is set to active. (Inherited from IMoveable)
IsFocused Return whether the control has focus. (Inherited from IFocusable)
Maximize Maximizes the window. (Inherited from IMoveable)
Minimize Reduces the window to an icon. (Inherited from IMoveable)
MouseMove Moves the pointer to the specified location in the object. This method is not supported for mobile Web applications. (Inherited from IClickable)
Move Moves the window. (Inherited from IMoveable)
Navigate Navigate to the specified URL in the currently active tab/window
OpenContextMenu Opens a context menu at the specified position. (Inherited from BaseGuiTestObject)
OpenTab Opens a new tab and navigates to the given URL. If no URL is given, the tab navigates to about:blank. This method is not supported for mobile Web applications.
PressKeys Presses (but does not release) a set of keys or mouse buttons. (Inherited from IKeyable)
PressMouse Presses (but does not release) a mouse button in the object. This method is not supported for mobile Web applications. (Inherited from IClickable)
ReleaseKeys Releases a set of keys or mouse buttons. (Inherited from IKeyable)
ReleaseMouse Releases a mouse button. This method is not supported for mobile Web applications. (Inherited from IClickable)
Restore Restores the window to its previous size. (Inherited from IMoveable)
SelectTab Selects the specified tab. When several tabs are open, Internet Explorer only displays some of the tabs and scroll buttons. As a result, only the currently visible tabs work with this method, which affects index semantics. For example, only the currently visible tabs can be selected. Index 0 selects the first visible tab. This method is not supported for mobile Web applications.
SetActive Makes the window active. (Inherited from IMoveable)
SetFocus Gives focus to the control. (Inherited from IFocusable)
SetProperty Sets the value of the specified property. (Inherited from TestObject)
Size Resizes the window. (Inherited from IMoveable)
StartScreenRecording Starts screen recording (Inherited from TestObject)
StopScreenRecording Stops screen recording (Inherited from TestObject)
TextCapture Returns the text in this object's visible area. (Inherited from TestObject)
TextClick Clicks in the center of the specified text. (Inherited from TestObject)
TextExists Returns whether the specified text exists. (Inherited from TestObject)
TextRectangle Returns the object-relative rectangle of the specified text. (Inherited from TestObject)
TypeKeys Sends a set of keystrokes to the object. (Inherited from IKeyable)
TypePasswordKeys Types an encrypted password into an object, for example a text field. (Inherited from IKeyable)
Verify Executes a verification on the given asset in the context of this UI object. (Inherited from TestObject)
WaitForChildDisappearance Waits until the specified child object does not exist or until the timeout is reached. If you don't explicitly pass a timeout using the optional timeout parameter, the timeout specified by the option OPT_WAIT_RESOLVE_OBJDEF will be used. An exception is thrown if the timeout is reached. (Inherited from TestObject)
WaitForDisappearance Waits until the object does not exist or until the timeout is reached. If you don't explicitly pass a timeout using the optional timeout parameter, the timeout specified by the option OPT_WAIT_RESOLVE_OBJDEF will be used. An exception is thrown if the timeout is reached. (Inherited from TestObject)
WaitForObject Waits for an object that matches the specified locator. If no object matches within an timeout an ObjectNotFoundException is thrown. The default timeout is 5 seconds and you can change the timeout by setting the value of the option OPT_WAIT_RESOLVE_OBJDEF. Use WaitForObject if the AUT takes a long time to display a specific object, for example when a transaction is processed before showing any results. By default, an action in the UI does not require a WaitForObject, because of the built-in synchronization. If you receive random timeout errors during normal script execution, consider increasing the default timeout instead of adding WaitForObject statements to your scripts. (Inherited from TestObject)
WaitForProperty Waits until the specified property has the specified value or until the timeout is reached.If you don't explicitly pass a timeout using the optional timeout parameter, the timeout specified by the option OPT_WAIT_RESOLVE_OBJDEF will be used. An exception is thrown if the timeout is reached. (Inherited from TestObject)
WaitForPropertyNotEquals Waits until the specified property has a value that is different to the specified value or until the timeout is reached.If you don't explicitly pass a timeout using the optional timeout parameter, the timeout specified by the option OPT_WAIT_RESOLVE_OBJDEF will be used. An exception is thrown if the timeout is reached. (Inherited from TestObject)
WaitForScreenshotStable Waits until the control is visually stable and does not change its position, by comparing screenshots taken with the specified interval. If you don't explicitly pass a timeout using the optional timeout parameter, the timeout specified by the option OPT_WAIT_SCREENSHOT_STABLE will be used. The default interval is 200 milliseconds. An exception is thrown if the timeout is reached. (Inherited from TestObject)