Web

Methods

Methods for automating web applications.

Methods

Click(Query[] query)

Perform a click on an element.

Parameters

query (WebQuery) - Query object that identifies an element uniquely.

Example

// This will perform a web click action on the provided element
this.ActiveDevice.Web.Click(Elements.MyScreen.TestField);

Me.ActiveDevice.Web.DoubleClick(Elements.MyScreen.TestField)

DoubleClick(Query[] query)

Perform a double click on an element.

Parameters

query (WebQuery) - Query object that identifies an element uniquely.

Example

// This will perform a web double click on the provided element
this.ActiveDevice.Web.DoubleClick(Elements.MyScreen.TestField);

Me.ActiveDevice.Web.DoubleClick(Elements.MyScreen.TestField)

Drag(Query[] query, int offsetX, int offsetY)

Drag an element to specific point.

Parameters

query (WebQuery) - Query object that identifies an element uniquely.

offsetX (int) - Destination point horizontal offset from element center.

offsetY (int) - Destination point vertical offset from element center.

Example

// This will drag a draggable web element to 100x,300y point realtive to the center of the provided element
this.ActiveDevice.Web.Drag(Elements.MyScreen.DragElement, 100,300);

Me.ActiveDevice.Web.Drag(Elements.MyScreen.DragElement, 100, 300)

DragToDisplacement(Query[] query, TapPoint fromPoint, TapPoint displacement, int steps)

Performs drag gesture from a point to a displacement within the element specified by the query.

Parameters

query (WebQuery) - Query object that identifies an element uniquely.

fromPoint (TapPiont) - Starting point of drag gesture. If null, defaults to center point in view.

displacement (TapPiont) - Displacement, represented as point object. If null, defaults to center point of element.

steps (int) - The amount of touches to generate to complete the drag gesture. Valid values are in the range: 3 - 1000.

Example

// This will drag an item in web view from 0x,0y point (relative to the element) to 100x,300y point relative to the first TapPoint(0,0) in 150 simulated touches
this.ActiveDevice.Web.DragToDisplacement(Elements.MyScreen.DragElement, new TapPoint(0,0), new TapPoint(100,300), 150);

Me.ActiveDevice.Web.DragToDisplacement(Elements.MyScreen.DragElement, New TapPoint(0, 0), New TapPoint(100, 300), 150)

DragToElement(Query[] dragElementQuery, Query[] toElementQuery)

Drag an element over another element.

Parameters

dragElementQuery (WebQuery) - Query object that identifies element to be dragged. The element to be dragged must be draggable.

toElementQuery (WebQuery) - Query object that identifies element the dragged element will be dragged over.

Example

// Drag element dragElement on top of element TestField
this.ActiveDevice.Web.DragToElement(Elements.MyScreen.DragElement, Elements.MyScreen.TestField);

Me.ActiveDevice.Web.DragToElement(Elements.MyScreen.DragElement, Elements.MyScreen.TestField)

DragToPoint(Query[] query, TapPoint fromPoint, TapPoint toPoint, int steps )

Drag an element over another element.

Parameters

query (WebQuery) - Query object that identifies an element uniquely.

fromPoint (TapPiont) - Starting point of drag gesture. If null, defaults to center point of element.

displacement (TapPiont) - Finishing point of drag gesture. If null, defaults to center point of element.

steps (int) - The amount of touches to generate to complete the drag gesture. Valid values are in the range: 3 - 1000.

Example

// This will drag an item in web view from 0x,0y point inside the specified element to 100x,300y point relative to the element in 150 simulated touches
this.ActiveDevice.Web.DragToPoint(Elements.MyScreen.DragElement, new TapPoint(0,0), new TapPoint(100,300), 150);

Me.ActiveDevice.Web.DragToPoint(Elements.MyScreen.DragElement, New TapPoint(0, 0), New TapPoint(100, 300), 150)

ExecuteScript(string script, Query[] query)

Execute a script into web browser.

Parameters

script (string) - String that is transferred to application under test and evaled into current web page.

query (WebQuery) - Query for target element. Element defined by this parameter can be accessed using targetElement variable inside the script parameter string.

Example

// Executes the script inside the string parameter on the web app under test. Deprecated: Use getScriptResult instead.
this.ActiveDevice.Web.ExecuteScript("document.getElementsByTagName(\"div\")");

Me.ActiveDevice.Web.ExecuteScript("document.getElementsByTagName(""div"")")

GetAttribute(Query[] query, string attrName)

Get attribute value of specific element.

Parameters

query (WebQuery) - Query object that identifies an element uniquely.

attrName (string) - Name of the attribute.

Example

// Get attribute will return the id attribute of DragElement as string
string idAttribute = this.ActiveDevice.Web.GetAttribute(Elements.MyScreen.DragElement, "id");

Dim idAttribute As String = Me.ActiveDevice.Web.GetAttribute(Elements.MyScreen.DragElement, "id")

GetChecked(Query[] query)

Gets checked state of specific checkbox element.

Parameters

query (WebQuery) - Query object that identifies an element uniquely.

Example

// Returns the checked state of the checkBox as boolean
bool state = this.ActiveDevice.Web.GetChecked(Elements.MyScreen.CheckBox);

Dim state As Boolean = Me.ActiveDevice.Web.GetChecked(Elements.MyScreen.CheckBox)

Return Value

The checked state of specific checkbox element.

GetColumnCount(Query[] query, uint rowIndex)

Gets checked state of specific checkbox element.

Parameters

query (WebQuery) - Query object that identifies an element uniquely.

rowIndex (unit) - Index of row which column count is needed.

Example

// Returns the number of columns in the desired table row
uint count = this.ActiveDevice.Web.GetColumnCount(Elements.MyScreen.TableView, 1);

Dim count As UInteger = Me.ActiveDevice.Web.GetColumnCount(Elements.MyScreen.TableView, 1)

Return Value

The number of columns in a particular row in table element.

GetHtml(Query[] query)

Get inner html of specific element.

Parameters

query (WebQuery) - Query object that identifies an element uniquely.

Example

// Gets the inner HTML of CheckBox
string html = this.ActiveDevice.Web.GetHtml(Elements.MyScreen.CheckBox);

Dim html As String = Me.ActiveDevice.Web.GetHtml(Elements.MyScreen.CheckBox)

Return Value

The inner html of specific element as string.

GetInError(Query[] query)

Gets error state of audio/video element. This function returns inconsistent results for mobile browsers. Use only with desktop browsers.

Parameters

query (WebQuery) - Query object that identifies an element uniquely.

Example

bool statePlayer = this.ActiveDevice.Web.GetInError(Elements.MyScreen.Player);

Dim statePlayer As Boolean = Me.ActiveDevice.Web.GetInError(Elements.MyScreen.Player)

Return Value

True if control is in error state, otherwise false.

GetPaused(Query[] query)

Get paused state of audio/video element.

Parameters

query (WebQuery) - Query object that identifies an element uniquely.

Example

bool statePaused = this.ActiveDevice.Web.GetPaused(Elements.MyScreen.Player);

Dim statePaused As Boolean = Me.ActiveDevice.Web.GetPaused(Elements.MyScreen.Player)

Return Value

True if audio/video element is paused, otherwise false.

GetRowCount(Query[] query)

Get number of rows of a table element.

Parameters

query (WebQuery) - Query object that identifies an element uniquely.

Example

// Returns the number of rows in the TableView
uint rowCount = this.ActiveDevice.Web.GetRowCount(Elements.MyScreen.TableView);

Dim rowCount As UInteger = Me.ActiveDevice.Web.GetRowCount(Elements.MyScreen.TableView)

Return Value

The number of rows of a table element.

GetScriptResult(string script, Query[] query)

Get number of rows of a table element.

Note: In order you se this method you should add reference assembly to Microsoft.CSharp.dll and System.Core.dll from the project settings.

Parameters

script (string) - String that is transferred to application under test and evaled into current web page.

query (WebQuery) - Query for target element. Element defined by this parameter can be accessed using targetElement variable inside the script parameter string.

Example

// This will execute the script in the string and save the result as object
object result = this.ActiveDevice.Web.GetScriptResult("document.getElementsByTagName(\"div\")");

Dim result As Object = Me.ActiveDevice.Web.GetScriptResult("document.getElementsByTagName(""div"")")

Return Value

Result of script execution.

GetSelectedIndex(Query[] query)

Get selected index of select element.

Parameters

query (WebQuery) - Query object that identifies an element uniquely.

Example

// Get the selected index of the Select element (select type element), more than one items can be selected
uint[] index = this.ActiveDevice.Web.GetSelectedIndex(Elements.MyScreen.Select);

Dim index As UInteger() = Me.ActiveDevice.Web.GetSelectedIndex(Elements.MyScreen.Select)

Return Value

Array of selected indexes.

GetSelectedText(Query[] query)

Get selected text values of select element.

Parameters

query (WebQuery) - Query object that identifies an element uniquely.

Example

// Gets the selected text/s from selected items in the select element
string[] selectedText = this.ActiveDevice.Web.GetSelectedText(Elements.MyScreen.Select);

Dim selectedText() As String = Me.ActiveDevice.Web.GetSelectedText(Elements.MyScreen.Select)

Return Value

Array of selected text values.

GetSelectedValue(Query[] query)

Get selected value strings of select element.

Parameters

query (WebQuery) - Query object that identifies an element uniquely.

Example

// Gets the selected value/s from selected items in the select element
string[] selectedValue = this.ActiveDevice.Web.GetSelectedValue(Elements.MyScreen.Select);

Dim selectedValue As String() = Me.ActiveDevice.Web.GetSelectedValue(Elements.MyScreen.Select)

Return Value

Array of selected value strings.

GetStyle(Query[] query, string styleProp)

Get specific style property value.

Parameters

query (WebQuery) - Query object that identifies an element uniquely.

styleProp (string) - Name of the style attribute.

Example

// Get style will return the width style in the example
string style = this.ActiveDevice.Web.GetStyle(Elements.MyScreen.TestField, "width");

Dim style As String = Me.ActiveDevice.Web.GetStyle(Elements.MyScreen.TestField, "width")

Return Value

The value of requested style attribute.

GetTextContent(Query[] query)

Get text content of specific element.

Parameters

query (WebQuery) - Query object that identifies an element uniquely.

Example

// This will return the text content of the test element
string textContent = this.ActiveDevice.Web.GetTextContent(Elements.MyScreen.TestField);

Dim textContent As String = Me.ActiveDevice.Web.GetTextContent(Elements.MyScreen.TestField)

Return Value

Text content of specified element.

GetValue(Query[] query)

Get value of specific element.

Parameters

query (WebQuery) - Query object that identifies an element uniquely.

Example

// This will return the value of the test element
string valueOfElement = this.ActiveDevice.Web.GetValue(Elements.MyScreen.TestField);

Dim valueOfElement As String = Me.ActiveDevice.Web.GetValue(Elements.MyScreen.TestField)

Return Value

Value of specified element.

HoverOver(Query[] query)

Perform a mouse hover over an element.

Parameters

query (WebQuery) - Query object that identifies an element uniquely.

Example

// Perform a mouse hover action
this.ActiveDevice.Web.HoverOver(Elements.MyScreen.TestField);

Me.ActiveDevice.Web.HoverOver(Elements.MyScreen.TestField)

NavigateToUrl(string url)

Make the browser under test navigate to specific URL.

Parameters

url (string) - The URL to navigate to.

Example

// Make the browser under test navigate to http://telerik.com
this.ActiveDevice.Web.NavigateToUrl("http://telerik.com");

Me.ActiveDevice.Web.NavigateToUrl("http://telerik.com")

PinchIn(Query[] query, TapPoint point, int distance, int steps)

Perform pinch in gesture at the specified location within the view specified by the query.

Parameters

query (WebQuery) - Query object that identifies an element uniquely.

point (TapPoint) - Coordintes of pinch center point. If null, defaults to center point of element.

distance (int) - Distance away from the center to start. Minimum value is 20.

steps (int) - The amount of touches to generate to complete the pinch. Valid values are in the range: 3 - 1000.

Example

// Perform a pinch in over the test element where the pinch will start at 100x,100y point within the element and will pinchIn 20px in 50 simulated touches
this.ActiveDevice.Web.PinchIn(Elements.MyScreen.TestField, new TapPoint(100,100), 20, 50);

Me.ActiveDevice.Web.PinchIn(Elements.MyScreen.TestField, New TapPoint(100, 100), 20, 50)

PinchOut(Query query, TapPoint point, int distance, int steps)

Perform pinch out gesture at the specified location within the view specified by the query.

Parameters

query (WebQuery) - Query object that identifies an element uniquely.

point (TapPoint) - Coordintes of pinch center point. If null, defaults to center point of element.

distance (int) - Distance away from the center to start. Minimum value is 20.

steps (int) - The amount of touches to generate to complete the pinch. Valid values are in the range: 3 - 1000.

Example

// Perform a pinch in over the test element where the pinch out will start at 100x,100y point within the element and will pinchOut 20px in 50 simulated touches
this.ActiveDevice.Web.PinchOut(Elements.MyScreen.TestField, new TapPoint(100,100), 20, 50);

Me.ActiveDevice.Web.PinchOut(Elements.MyScreen.TestField, New TapPoint(100, 100), 20, 50)

PressKey(Query[] query, int keyCode, bool alt, bool ctrl, bool shift)

Invoke press key event on specific element.

Parameters

query (WebQuery) - Query object that identifies an element uniquely.

keyCode (int) - Code of the key.

alt (boolean) - Boolean value indicating whether ALT is pressed. The default is false.

ctrl (boolean) - Boolean value indicating whether CTRL is pressed. The default is false.

shift (boolean) - Boolean value indicating whether SHIFT is pressed. The default is false.

Example

// This will invoke the press CAPS LOCK key event (with code 20) over the test element 
this.ActiveDevice.Web.PressKey(Elements.MyScreen.TestField, 20);

Me.ActiveDevice.Web.PressKey(Elements.MyScreen.TestField, 20)

// Perform a right click on the test element
this.ActiveDevice.Web.RightClick(Elements.MyScreen.TestField);

Me.ActiveDevice.Web.RightClick(Elements.MyScreen.TestField)

Scroll(Query[] query, int x = 0, int y = 0)

Scroll the web page to any element.

Parameters

query (WebQuery) - Query object that identifies an element uniquely.

x (int) - The X confidantes of the specific element.

y (int) - The Y confidantes of the specific element.

Example

// Scroll to a 300x, 300y point relative to the element
this.ActiveDevice.Web.Scroll(Elements.MyScreen.TestField, 300, 300);

Me.ActiveDevice.Web.Scroll(Elements.MyScreen.TestField, 300, 300)

// Scroll to the test element to make it visible on the screen
this.ActiveDevice.Web.ScrollToElement(Elements.MyScreen.TestField);

Me.ActiveDevice.Web.ScrollToElement(Elements.MyScreen.TestField)

SetAttribute(Query[] query, string attrName, string attrValue)

Set attribute of specific element to a specific value.

Parameters

query (WebQuery) - Query object that identifies an element uniquely.

attrName (string) - Name of the attribute.

attrValue (string) - Value to be set.

Example

// Set the id attribute of the test element to test
this.ActiveDevice.Web.SetAttribute(Elements.MyScreen.TestField, "id", "test");

Me.ActiveDevice.Web.SetAttribute(Elements.MyScreen.TestField, "id", "test")

// Set the state of the checklbox to false
this.ActiveDevice.Web.SetChecked(Elements.MyScreen.CheckBox, false);

Me.ActiveDevice.Web.SetChecked(Elements.MyScreen.CheckBox, False)

// this will set the '<label>text<label>' html to the test element
this.ActiveDevice.Web.SetHtml(Elements.MyScreen.TestField, "<label>text<label>");

Me.ActiveDevice.Web.SetHtml(Elements.MyScreen.TestField, "<label>text<label>")

// This method will pause the video player
this.ActiveDevice.Web.SetPaused(Elements.MyScreen.Player, true);

Me.ActiveDevice.Web.SetPaused(Elements.MyScreen.Player, True)

// Selects element with index 3 from the select element
this.ActiveDevice.Web.SetSelectedIndex(Elements.MyScreen.Select, 3);

Me.ActiveDevice.Web.SetSelectedIndex(Elements.MyScreen.Select, 3)

// Selects a specific item by its text in select element
this.ActiveDevice.Web.SetSelectedText(Elements.MyScreen.Select, "text");

Me.ActiveDevice.Web.SetSelectedText(Elements.MyScreen.Select, "text")

// Set selected value of select element
this.ActiveDevice.Web.SetSelectedValue(Elements.MyScreen.Select, "value");

Me.ActiveDevice.Web.SetSelectedValue(Elements.MyScreen.Select, "value")

SetStyle(Query[] query, string styleProp, string styleValue)

Set specific style property value.

Parameters

query (WebQuery) - Query object that identifies an element uniquely.

styleProp (string) - Name of the style attribute.

styleValue (string) - Value to be set.

Example

// This will set the width of the testElement to 5-px
this.ActiveDevice.Web.SetStyle(Elements.MyScreen.TestField, "width", "50px");

Me.ActiveDevice.Web.SetStyle(Elements.MyScreen.TestField, "width", "50px")

// This will set the text content of the test element
this.ActiveDevice.Web.SetTextContent(Elements.MyScreen.TestField, "textToSet");

Me.ActiveDevice.Web.SetTextContent(Elements.MyScreen.TestField, "textToSet")

// Set "test" value to the test element
this.ActiveDevice.Web.SetValue(Elements.MyScreen.TestField, "test");

Me.ActiveDevice.Web.SetValue(Elements.MyScreen.TestField, "test")

swipeDistance (int) - Swipe distance, default is '200'.

Example

// Swipe right on the test element
this.ActiveDevice.Web.Swipe(Elements.MyScreen.TestField, SwipeDirection.Right);

Me.ActiveDevice.Web.Swipe(Elements.MyScreen.TestField, SwipeDirection.Right)

Tap(Query[] query, int tapCount, int tapDownDelay, int tapUpDelay)

Tap an element.

Parameters

query (WebQuery) - Query object that identifies an element uniquely.

tapCount (int) - Numbers of taps to be performed. Min value 1.

tapDownDelay (int) - Tap down delay in miliseconds. Min value 50.

tapUpDelay (int) - Tap up delay in miliseconds. Min value 50.

Example

// Tap action on the test element
this.ActiveDevice.Web.Tap(Elements.MyScreen.TestField);

Me.ActiveDevice.Web.Tap(Elements.MyScreen.TestField)

// Tap and hold action on the test element
this.ActiveDevice.Web.TapAndHold(Elements.MyScreen.TestField);

Me.ActiveDevice.Web.TapAndHold(Elements.MyScreen.TestField)

TapAtLocation(Query[] query, int X, int Y, int tapCount)

Tap an element on particular location.

Parameters

query (WebQuery) - Query object that identifies an element uniquely.

X (int) - X coordinate of point to be tapped.

Y (int) - Y coordinate of point to be tapped.

tapCount (int) - Numbers of taps to be performed. Min value 1.

Example

// Tap at 50x,50y point within the test element
this.ActiveDevice.Web.TapAtLocation(Elements.MyScreen.TestField, 50, 50, 1);

Me.ActiveDevice.Web.TapAtLocation(Elements.MyScreen.TestField, 50, 50, 1)

TapAtPoint(Query[] query, TapPoint point, int tapCount, int tapDownDelay, int tapUpDelay)

Tap an element on particular point.

Parameters

query (WebQuery) - Query object that identifies an element uniquely.

point (TapPoint) - Point inside element to be tapped.

tapCount (int) - Numbers of taps to be performed. Min value 1.

tapDownDelay (int) - Tap down delay in miliseconds. Min value 50.

tapUpDelay (int) - Tap up delay in miliseconds. Min value 50.

Example

// Tap at 50x,50y point within the test element
this.ActiveDevice.Web.TapAtPoint(Elements.MyScreen.TestField, new TapPoint(50,50));

Me.ActiveDevice.Web.TapAtPoint(Elements.MyScreen.TestField, New TapPoint(50, 50))

// Tap an element on center left point.
this.ActiveDevice.Web.TapCenterLeft(Elements.MyScreen.TestField);

Me.ActiveDevice.Web.TapCenterLeft(Elements.MyScreen.TestField)

// Tap an element on center right point.
this.ActiveDevice.Web.TapCenterRight(Elements.MyScreen.TestField);

Me.ActiveDevice.Web.TapCenterRight(Elements.MyScreen.TestField)

TwoFingerRotate(Query[] query, TapPoint point, int angle)

Perform rotate gesture at the specified location within the view specified by the query.

Parameters

query (WebQuery) - Query object that identifies an element uniquely.

point (TapPoint) - Coordinates of rotation center point.

angle (int) - The angle in degrees to rotate. The default value is 0.

Example

// Rotate the test element starting from 100x,100y within the element and rotating for 45 degrees
this.ActiveDevice.Web.TwoFingerRotate(Elements.MyScreen.TestField, new TapPoint(100,100), 45);

Me.ActiveDevice.Web.TwoFingerRotate(Elements.MyScreen.TestField, New TapPoint(100, 100), 45)

// Wait for 2 seconds
this.ActiveDevice.Web.Wait(2000);

Me.ActiveDevice.Web.Wait(2000)

WaitFor(Func func, int checkInterval, int timeout)

Wait for func to return true or timeout.

Parameters

func (Func) - Function that is called on every interval.

checkInterval (int) - Check interval in milliseconds.

timeout (int) - Timeout interval in milliseconds.

Example

// Execute TestMethod1 for 2 sec every 100ms until it returns true of false
this.ActiveDevice.Web.WaitFor(TestMethod1, 100, 2000);

Me.ActiveDevice.Web.WaitFor(TestMethod1, 100, 2000)

WaitForScriptResult(string script, Query[] query, dynamic result, int checkInterval, int timeout)

Wait for func to return true or timeout.

Parameters

script (string) - Function that is called on every interval.

query (WebQuery) - Query for target element. Element defined by this parameter can be accessed using targetElement variable inside the script parameter string.

result (dynamic) - Script result to be matched.

checkInterval (int) - Delay in milliseconds between checks.

timeout (int) - Number of milliseconds to wait for script result to match.

Example

// Wait for a specific result from script - waith for the readyState to return complete by checking every 10ms for 2 sec timeout
this.ActiveDevice.Web.WaitForScriptResult("document.readyState", null, "complete", 10, 2000);

Me.ActiveDevice.Web.WaitForScriptResult("document.readyState", Nothing, "complete", 10, 2000)

WaitForUrl(string url, int checkInterval, int timeout)

Wait until current url matches specified value or timeout occurs.

Parameters

url (string) - Url to match.

checkInterval (int) - Delay in milliseconds between checks.

timeout (int) - Number of milliseconds to wait for script result to match.

Example

// This will wait for the telerik.com page to load and will check every 10ms for 2 seconds
this.ActiveDevice.Web.WaitForUrl("http://telerik.com", 10, 2000);

Me.ActiveDevice.Web.WaitForUrl("http://telerik.com", 10, 2000)