Skip to content
Get Free Trial

Fetch Functions

While working on scripts, we often need to fetch content from the application screen. Examples may be: Fetching and storing a generated userId for later use in script Getting the value of form field for verification Getting the text from a UI element for assertion Getting some particular attribute of a UI element, like href of a link

Since
Sahi Pro 3.5
Desktop Engine 7.0.0
Mobile Engine 7.5.0
SAP Engine 9.0.0

Modes BrowserWindowsJavaAndroidiOSSAP

_getValue($element)

Arguments

NameTypeDescription
$elementHTML DOM elementForm element whose value we need

Returns

stringValue of the element
// Using in an assertion
_assertEqual("Tyto", _getValue(_textbox("company")));
// Fetching and storing value
var $userId = _getValue(_textbox("userId"));

For getting text out of div or span like elements, use _getText

Since
Sahi Pro 3.5
Desktop Engine 7.0.0
Mobile Engine 7.5.0
SAP Engine 9.0.0

Modes BrowserWindowsJavaAndroidiOSSAP

_getText($el)

Arguments

NameTypeDescription
$elHTML DOM elementElement whose text we need

Returns

stringText content of the element

The returned string is normalized for different browsers. Multiple continuous spaces are replaced with single space.
Multiple continuous newlines are replaced with single newline. Newlines are always returned as \n even on
Mac and Linux, so that scripts can work across browsers and OSes.

This function uses the textContent or innerText attributes of elements.

// Using in an assertion
_assertEqual("Tyto", _getText(_div("companyDiv")));
// Fetching and storing value
var $userId = _getText(_div("userIdDiv"));
Since
Sahi Pro 9.2.0

Modes Browser

_datalistFilter($el[, $filter])

Arguments

NameTypeDescription
$elHTML DOM elementInput or datalist element
$filterstringoptionalData to filter (case-insensitive).

Returns

HTML DOM element

Specifies the filter data on input element which filters the list. This function should be used with _getOptions. Eg. _getOptions(_datalistFilter(_datalist("country_list"), "ind")); returns array with all options matching with “ind” in the list.

Since
Sahi Pro 6.0.0
Desktop Engine 7.5.0
SAP Engine 9.0.0

Modes BrowserWindowsJavaSAP

_getOptions($el[, $type])

Arguments

NameTypeDescription
$elHTML DOM elementSelect/ Input or associated datalist to the input element
$typestringoptionalType can be specified as "value" or "text".
If the type is specified as "text" then text contents of all the options are returned.
If the type is specified as "value" then values of all the options are returned.
If the type is not specified then text contents of all the options are returned.

Returns

array of stringsArray containing the values or texts of all options of the select or datalist element

If we want the values of all the options of the selectbox:

var $list = _getOptions(_select("select_id"), "value");
_assertEqual("Value of First Option", $list[0]);
_assertEqual("Value of Second Option", $list[1]);
_assertEqual(2, $list.length);

For getting visible text of all options:

var $list = _getOptions(_select("select_id"));
_assertEqual("Visible Text of First Option", $list[0]);
_assertEqual("Visible Text of Second Option", $list[1]);
_assertEqual(2, $list.length);

For getting text or values for datalist(datalist support is only available from Sahi Pro v9.2.0):

var $list = _getOptions(_datalist("country_list"));
_assertEqual(["Afghanistan", "Aland Islands", "Albania", "Algeria", "American Samoa"], $list);
$list = _getOptions(_textbox("country"), "text");
_assertEqual(["Afghanistan", "Aland Islands", "Albania", "Algeria", "American Samoa"], $list);

For getting filtered text or values for datalist using _datalistFilter:

var $list = _getOptions(_datalistFilter(_datalist("country_list"), "AL"));
_assertEqual(["Aland Islands", "Albania", "Algeria"], $list);
$list = _getOptions(_datalistFilter(_textbox("country"), "AL"), "text");
_assertEqual(["Aland Islands", "Albania", "Algeria"], $list);
Since
Sahi Pro 3.5

Modes Browser

_getCellText($el)

Arguments

NameTypeDescription
$elHTML DOM elementCell (TD) element whose text we need

Returns

stringText content of the cell element

Returns the text content as a string

Since
Sahi Pro 3.5
Desktop Engine 7.0.0
SAP Engine 9.0.0

Modes BrowserWindowsJavaSAP

_getSelectedText($el)

Arguments

NameTypeDescription
$elHTML DOM elementSelect dropdown element whose selected text we need

Returns

stringText content of the selected option of a select dropdown

Returns the text of the selected option in a select dropdown box.

// Using in an assertion
_assertEqual("18", _getSelectedText(_select("legalAge")));
// Fetching and storing value
var $legalAge = _getSelectedText(_select("legalAge"));
Since
Sahi Pro 3.5
Desktop Engine 7.5.0
Mobile Engine 7.5.0
SAP Engine 9.0.0

Modes BrowserWindowsJava (8.0.0)AndroidiOSSAP

_getAttribute($el, $attributeName)

Arguments

NameTypeDescription
$elHTML DOM elementElement whose attribute we need
$attributeNamestringThe attribute to be fetched

Returns

stringThe attribute value

Returns the specified attribute’s value for the element.

// Using in an assertion
_assertEqual("http://sahi.co.in/", _getAttribute(_link("Home"), "href"));
// Fetching and storing value
var $href="_getAttribute(_link(""Home"), "href");
Since
Sahi Pro 3.5
Desktop Engine 7.0.0
Mobile Engine 7.5.0
SAP Engine 9.0.0

Modes BrowserWindowsJavaAndroidiOSSAP

_exists($el)

Arguments

NameTypeDescription
$elHTML DOM elementElement to check

Returns

booleantrue if element exists on the page, else false

It checks for existence of the element in the application. However, note that elements may exist but not be visible on the user interface.

// Using in an assertion
_assertTrue(_exists(_link("Home")));
// same as
_assertExists(_link("Home")));
// Fetching and storing value
var $exists = _exists(_link("Home"));
Since
Sahi Pro 6.0.0
Desktop Engine 7.5.0
SAP Engine 9.0.0

Modes BrowserWindowsJavaSAP

_areEqual($expected, $actual)

Arguments

NameTypeDescription
$expectedanyExpected value.
This value can be any normal javascript data type or an array
Regular expressions can also be used. (eg. "/del/")
$actualanyActual value.
This value can be any normal javascript data type or an array.
It is mostly some attribute of a HTML DOM element.

Returns

booleantrue if the expected and actual values match, else false

Compares two Javascript data type or arrays.

// Compare string with regular expression.
var $compare1 = _areEqual("/^a.*c$/", "abc"); // $compare1 is true.
// Compare text of an element with regular expression.
var $compare2 = _areEqual("/created/", _getText(_div("result")));
// Compare arrays.
$exp = [/[a-z]+$/, "b"];
$act = ["ab", "b"];
var $compareArr = _areEqual($exp, $act); // $compareArr is true.
Since
Sahi Pro 3.5
Desktop Engine 7.0.0
Mobile Engine 7.5.0
SAP Engine 9.0.0
Visual Assist Engine 10.0.0

Modes BrowserWindowsJavaAndroidiOSSAP

_isVisible($el[, $checkZIndex[, $doScroll]])

Arguments

NameTypeDescription
$elHTML DOM elementElement to check
$checkZIndexbooleanoptionalIf true, checks whether the element is on top or not(Checks whether some other element with a higher Z index is not hiding it). If false, omits this check.
Default is false.
$doScrollbooleanoptionalIf true, checks whether element is the top element by scrolling to the element. If false, checks only for the current viewport.
Default is false. Used only when checkZIndex is true.

Returns

booleantrue if element is visible, else false
// Using in an assertion
_assertTrue(_isVisible(_link("Home"))); // doesn't check z-index
_assertTrue(_isVisible(_link("Home"), true)); //checks z-index
_assertTrue(_isVisible(_link("Home"), true, true)); //checks z-index after scrolling
// Fetching and storing value
var $visible = _isVisible(_link("Home"));
Since
Sahi Pro 7.0.0
Desktop Engine 7.0.0
Mobile Engine 7.5.0
SAP Engine 9.0.0

Modes BrowserWindowsJavaAndroidiOS (8.0.0)SAP

_isChecked($el)

Arguments

NameTypeDescription
$elHTML DOM elementElement to check

Returns

booleantrue if element is checked, else false

Returns true if the element is checked. This is applicable for radio buttons and checkboxes.

// Using in an assertion
_assertTrue(_isChecked(_radio("Male")));
Since
Sahi Pro 7.5.0
Desktop Engine 7.5.0
Mobile Engine 7.5.0
SAP Engine 9.0.0

Modes BrowserWindowsJavaAndroidiOSSAP

_isEnabled($element)

Arguments

NameTypeDescription
$elementelementelement to be check

Returns

booleantrue if element is enabled, else false

Some elements in your application could be disabled. This function returns true if the specified element is enabled.

// Using in an assertion
_assertTrue(_isEnabled(_button("Download")));
Since
Sahi Pro 3.5
Desktop Engine 7.5.0
Mobile Engine 7.5.0
SAP Engine 9.0.0

Modes BrowserWindowsJava (8.0.0)iOSSAP

_containsText($element, $text)

Arguments

NameTypeDescription
$elementelElement where we need to check if text is present
$textstringText to check for. Can also be a regular expression

Returns

booleantrue if element contains the text, else false

Returns true if the element contains the specified text.

<div id="d1" style="background-color:yellow"><i>Formatted</i> Text</div>
_containsText(_div("d1"), "Formatted") //=true
_containsText(_div("d1"), "Text") //=true
_containsText(_div("d1"), "Formatted Text") //=true
_containsText(_div("d1"), "/Format.*Text/") //=true
_containsText(_div("d1"), "/mat.*Te/") //=true
_containsText(_div("d1"), "Non existent") //=false
Since
Sahi Pro 3.5

Modes Browser

_containsHTML($element, $html)

Arguments

NameTypeDescription
$elementelElement where we need to check if text is present
$htmlstringHTML to check for. Can also be a regular expression

Returns

booleantrue if element contains the HTML, else false

Returns true if the element contains the specified HTML content.

<div id="d1" style="background-color:yellow"><i>Formatted</i> Text</div>
_containsHTML(_div("d1"), "<i>Formatted</i>") //=true
_containsHTML(_div("d1"), "Text") //=true
_containsHTML(_div("d1"), "<i>Formatted</i> Text") //=true
_containsText(_div("d1"), "/<i>.*</i> Text/") //=true
_containsHTML(_div("d1"), "Formatted Text") //=false
_containsHTML(_div("d1"), "Non existent") //=false
Since
Sahi Pro 3.5
Desktop Engine 7.5.0

Modes BrowserWindowsJava (8.0.0)

_contains($parent, $child)

Arguments

NameTypeDescription
$parentHTML DOM elementParent element
$childHTML DOM elementChild element

Returns

booleantrue if the specified child element is a child of the specified parent element, else false
<div id="d1">
<span>inside</span>
</div>
_contains(_div("d1"), _span("inside")) //=true
Since
Sahi Pro 3.5

Modes Browser

_title()

Arguments

NameTypeDescription
None

Returns

stringTitle of the top most page (the title visible on the browser)
var $title = _title(); // returns "Sahi Pro - Fetch APIs" for this page.
Since
Sahi Pro 6.0.0
Desktop Engine 8.0.0

Modes BrowserJava

_getTableContents($tableEl[, $columns[, $rows[, $count]]])

Arguments

NameTypeDescription
$tableElHTML DOM elementTable element
$columnsarray of objectsoptionalArray of column identifiers. The identifiers can be index, text or regular expression of text
$rowsstring|integer|array of integersoptionalCan be a regular expression, an array of indexes or the starting index
$countintegeroptionalIf rows is the starting index, count is the ending index, If rows is a regular expression, count is the total count. If rows is an array of indexes, count is ignored.

Returns

two dimensional array of stringsThe data from the table
// All table data
var $data = _getTableContents(_table("tableId"));
// All rows, but only specific columns from the table
var $data = _getTableContents(_table("tableId"), [1,3,7] );
// Returns all rows with columns 2, 4 and 8 since index is 0 based.
// All rows, but only specific columns from the table
var $data = _getTableContents(_table("tableId"), [1,"Price", "/Stock/"] );
// Returns all rows with column 2 (index is 0 based), column with header "Price" and column header matching regular expression /Stock/
// Rows containing specified keyword, but only specific columns from the table
var $data = _getTableContents(_table("tableId"), ["Price", "/Stock/"], "/pen/" );
// Returns all rows containing words matching regular expression /pen/, with columns having column header Price and column header matching
// regular expression /Stock/. Note that /pen/ is matched with all the columns of the row.
// First n rows containing specified keyword, but only specific columns from the table
var $data = _getTableContents(_table("tableId"), ["Price", "/Stock/"], "/pen/", 8);
// Returns first 8 rows contain words matching regular expression /pen/ having column header Price and column header matching
// regular expression /Stock/
// Rows having indexes specified in array, with specific columns from the table
var $data = _getTableContents(_table("tableId"), ["Price", "/Stock/"], [3,4,7]);
// Returns rows 4, 5 and 8 (index is 0 based) having all columns with header "Price" and column header matching regular expression /Stock/
// Rows from m to n, but only specific columns from the table
var $data = _getTableContents(_table("tableId"), ["Price", "/Stock/"], 3, 7 );
// Returns rows from 3 to 7 having all columns with header "Price" and column header matching regular expression /Stock/
Since
Sahi Pro 3.5

Modes Browser

_style($el, $styleAttribute[, $pseudoEl])

Arguments

NameTypeDescription
$elHTML DOM elementelement whose style attribute we need
$styleAttributestringstyle attribute to be fetched
$pseudoElstringoptionalUse this argument to fetch style attribute from pseudo-elements like ::before, ::after, etc.

Returns

stringThe style attribute value
// Using in assertion
_assertEqual("24px", _style(_heading1(0), "font-size"));
// Fetching and storing value
var $fontSize = _style(_heading1(0), "font-size");
// Fetch style of a pseudo element
var $backgroundColor = _style(_listItem("entry1"), "background-color", ":before")
Since
Sahi Pro 3.5
Desktop Engine 7.5.0
Mobile Engine 7.5.0
SAP Engine 9.0.0

Modes BrowserWindowsJavaAndroidiOSSAP

_position($el[, $relative])

Arguments

NameTypeDescription
$elHTML DOM elementelement whose position we need
$relativebooleanoptionalIf true, returns position relative to current viewport.
Default is false.

Returns

array of integersAn array [x,y] of the elements position in pixels relative to its window/frame/iframe

This may be used to verify layouts by comparing positions of specific elements.

// Using in assertion
_assertEqual([10,20], _position(_image("logo")));
// Fetching and storing value
var $position = _position(_image("logo"));
_log($position[0]); //logs x coordinate (eg. 10)
_log($position[1]); //logs y coordinate (eg. 20)
Since
Sahi Pro 6.1.0
Desktop Engine 7.5.0
Visual Assist Engine 10.0.0

Modes BrowserJava

_positionNative($el)

Arguments

NameTypeDescription
$elHTML DOM elementelement whose position we need

Returns

array of integersAn array [x,y] of the elements absolute position in pixels

This may be used inside native events to find the absolute positions of elements.

// Using in assertion
var $xy = _positionNative(_link("Link Test"));
_assertEqual(222, $xy[1]);
// Fetching and storing value
var $xy = _positionNative(_link("Link Test"));
_log("x coordinate "+ $xy[0] ); //logs x coordinate of the element
_log("y coordinate "+ $xy[1] ); //logs y coordinate of the element
Since
Sahi Pro 11.5.0
Desktop Engine 11.5.0
Mobile Engine 11.5.0
SAP Engine 11.5.0

Modes BrowserWindowsJavaAndroidiOSSAP

_dimensions($el)

Arguments

NameTypeDescription
$elElementelement whose dimensions we need

Returns

array of integersAn array [w,h] of the element's dimensions in pixels

This function gets the width and height as an array for the specified element.

// Using in assertion
_assertEqual([100,40], _dimensions(_image("logo")));
// Fetching and storing value
var $dimensions = _dimensions(_image("logo"));
_log($dimensions[0]); //logs width (eg. 100)
_log($dimensions[1]); //logs height (eg. 40)
Since
Sahi Pro 5.1.0
Desktop Engine 7.0.0
SAP Engine 9.0.0

Modes BrowserWindowsJavaSAP

_getSelectionText([$el])

Arguments

NameTypeDescription
$elHTML DOM elementoptionalElement in which to look for selection. This is optional only for Browser Automation, as Sahi will automatically look in all frames and elements.

Returns

stringText selected by the user (using mouse drag, like we select before copy paste)
// Using in an assertion
_assertEqual("Search", _getSelectionText());
// Fetching and storing value
var $currentSelectedText = _getSelectionText();
Since
Sahi Pro 10.0.0

Modes Browser

_getCopiedText()

Arguments

NameTypeDescription
None

Returns

stringCopied text

Returns the text copied to the system clipboard by a web application.

_lockWindow();
_focusWindow();
_clickNative(_button("Copy Text to Clipboard"));
_unlockWindow();
var $copiedText = _getCopiedText();
_assertEqual("Copied text", $copiedText);
Since
Sahi Pro 6.0.0

Modes Browser

_userAgent()

Arguments

NameTypeDescription
None

Returns

stringThe userAgent string of the current browser
Since
Sahi Pro 6.0.0

Modes Browser

_getScreenSize()

Arguments

NameTypeDescription
None

Returns

array of integersScreen size as an array [x,y]. The first value is the inner width of the browser window and the second value is the inner height
// Using in an assertion
var $screensize=_getScreenSize();
_assertTrue(($screensize[0]>=783)&&($screensize[0]<=800));
_assertTrue(($screensize[1]>=280)&&($screensize[1]<=400));
Since
Sahi Pro 3.5

Modes Browser

_isIE()

Arguments

NameTypeDescription
None

Returns

booleantrue if the current browser is Internet Explorer, else false
Since
Sahi Pro 3.5.2

Modes Browser

_isIE9()

Arguments

NameTypeDescription
None

Returns

booleantrue if the current browser is Internet Explorer 9, else false
Since
Sahi Pro 4.5.2

Modes Browser

_isIE10()

Arguments

NameTypeDescription
None

Returns

booleantrue if the current browser is Internet Explorer 10, else false
Since
Sahi Pro 6.2.0

Modes Browser

_isEdge()

Arguments

NameTypeDescription
None

Returns

booleantrue if the current browser is Edge, else false
Since
Sahi Pro 9.0.0

Modes Browser

_isEdgeNew()

Arguments

NameTypeDescription
None

Returns

booleantrue if the current browser is new Microsoft Edge, else false
Since
Sahi Pro 3.5

Modes Browser

_isFF()

Arguments

NameTypeDescription
None

Returns

booleantrue if the current browser is Firefox, else false
Since
Sahi Pro 3.5

Modes Browser

_isFF3()

Arguments

NameTypeDescription
None

Returns

booleantrue if the current browser is Firefox 3, else false
Since
Sahi Pro 3.5.2

Modes Browser

_isFF4()

Arguments

NameTypeDescription
None

Returns

booleantrue if the current browser is Firefox 4, else false
Since
Sahi Pro 3.5

Modes Browser

_isChrome()

Arguments

NameTypeDescription
None

Returns

booleantrue if the current browser is Chrome, else false
Since
Sahi Pro 3.5

Modes Browser

_isSafari()

Arguments

NameTypeDescription
None

Returns

booleantrue if the current browser is Safari, else false
Since
Sahi Pro 3.5

Modes Browser

_isOpera()

Arguments

NameTypeDescription
None

Returns

booleantrue if the current browser is Opera, else false
Since
Sahi Pro 6.0.0

Modes Browser

_isPhantomJS()

Arguments

NameTypeDescription
None

Returns

booleantrue if the current browser is PhantomJS, else false
Since
Sahi Pro 9.2.1

Modes Browser

_isBrave()

Arguments

NameTypeDescription
None

Returns

booleantrue if the current browser is Brave, else false
Since
Sahi Pro 3.5

Modes Browser

_isHTMLUnit()

Arguments

NameTypeDescription
None

Returns

booleantrue if the current browser is HTMLUnit, else false

Rich Text Editors (Content Editable elements)

Section titled “Rich Text Editors (Content Editable elements)”

Most common attributes needed during automation are exposed via Sahi’s fetch functions.
However there are lots of DOM attributes which are not exposed.
For example the href attribute of a link is not exposed by any in-built Sahi function.
To work with such attributes, the functions _fetch, _set and _condition are used.

Since
Sahi Pro 3.5

Modes Browser

_fetch($expression)

Arguments

NameTypeDescription
$expressionstring|DOM expressionExpression which we wish to evaluate and fetch.

Returns

stringValue of the expression
var $rowCount = _fetch(_table("tableId").rows.length);
// You can also use an expression as a string
var $userAgent = _fetch("navigator.userAgent");
// And fetch results of custom utility functions of your web app
var $value = _fetch("jQuery('#id').val()");
// While working with popup windows use _selectWindow first
_selectWindow("popupWin");
// Fetch table row count from popupWin window
var $rowCount = _fetch(_table("tableId").rows.length);
Since
Sahi Pro 3.5

Modes Browser

_set($variable, $expression)

Arguments

NameTypeDescription
$variablevariableVariable into which we wish to get the specific value.
$expressionDOM ExpressionExpression which we wish to evaluate and set.

Returns

null

Sets the value of expression into variable
_set communicates with the browser to evaluate the expression and fetches the result.

// Fetching href attribute
var $href="null;" // initialize variable
_set($href, _link("Home").href); // set it
// Getting row count of table
var $rowCount = 0; // initialize variable
_set($rowCount, _table("tableId").rows.length); // set it
// Getting column count of table (first row)
var $colCount = 0; // initialize variable
_set($colCount, _table("tableId").rows[0].cells.length); // set it
// Working with popup windows using _popup prefix
var $colCount = 0;
_popup("popupWin")._set($colCount, _table("tableId").rows[0].cells.length); // CORRECT
_set($colCount, _popup("popupWin")._table("tableId").rows[0].cells.length); // WRONG
// Better to use with _selectWindow
var $colCount = 0;
_selectWindow("popupWin"); // Select window first
_set($colCount, _table("tableId").rows[0].cells.length);
Since
Sahi Pro 3.5

Modes Browser

_condition($expression)

Arguments

NameTypeDescription
$expressionDOM expressionExpression which we wish to evaluate.

Returns

booleantrue or false based on the expression
if (_condition(_link(0).href="=" "http://sahi.co.in/")){
_click(_link(0));
}
// Note that this is the same as
var $href="_fetch(_link(0).href);"
if ($href="=" "http://sahi.co.in/"){
_click(_link(0));
}
// or
var $href="null;"
_set($href, _link(0).href);
if ($href="=" "http://sahi.co.in/"){
_click(_link(0));
}
// For popup windows use _selectWindow and then use _condition
_selectWindow("popupWin"); // select Window
// Check condition on popup window
if (_condition(_link(0).href="=" "http://sahi.co.in/")){
_click(_link(0));
}
Since
Sahi Pro 3.5
Desktop Engine 7.5.0
Mobile Engine 7.5.0

Modes BrowserWindowsJavaAndroidiOS

_collect($elementType, $identifier[, $relations])

Arguments

NameTypeDescription
$elementTypestringtype of elements to collect. Eg. "_link", "_button", "/text/" etc.
$identifierstringSahi Identifier. Can also be just an index.
$relationsrelationsoptionalRelations like _in, _near etc.

Returns

array of element stubsArray of all elements of the specified type matching the identifier within relations
// Collect all textboxes matching any identifier, in table "listing".
// Note the use of match all regular expression "/.*/"
var $textboxes = _collect("_textbox", "/.*/", _in(_table("listing")));
// Iterate and set values on all textboxes
for (var $i=0; $i<$textboxes.length; $i++) {
_setValue($textboxes[$i], "value");
}
Since
Sahi Pro 3.5
Desktop Engine 7.5.0
Mobile Engine 7.5.0

Modes BrowserWindowsJavaAndroidiOS

_count($elementType, $identifier[, $relations])

Arguments

NameTypeDescription
$elementTypestringtype of elements to collect. Eg. "_link", "_button", "/text/" etc.
$identifierstring|objectSahi Identifier/Attributes JSON. Can also be just an index.
$relationsrelationsoptionalRelations like _in, _near etc.

Returns

integerCount of all elements of the specified type matching the identifier within relations
// Count all textboxes matching any identifier, in table "listing".
// Note the use of match all regular expression "/.*/"
var $textboxCount = _count("_textbox", "/.*/", _in(_table("listing")); // may return 5;
// or more explicitly
var $textboxCount = _count("_textbox", {name:"q"});
Since
Sahi Pro 5.1.0
Desktop Engine 7.5.0
Mobile Engine 7.5.0

Modes BrowserWindowsAndroidiOSJava (8.0.0)

_collectAttributes($elementType, $identifier, $attribute[, $relations])

Arguments

NameTypeDescription
$elementTypestringtype of elements to collect.
Eg. "_link", "_button", "/text/" etc.
$identifierstringSahi Identifier. Can also be just an index.
$attributestring|functionattribute or function.
$relationsrelationsoptionalRelations like _in, _near etc.

Returns

li_sArray of element attributes of all elements of the specified type matching the identifier within relations

Fetching a simple attribute from multiple elements

// Collect the id attribute of all textboxes in table "listing".
// Note the use of match all regular expression "/.*/"
var $textboxIds = _collectAttributes("_textbox", "/.*/", "id", _in(_table("listing")));
// Collect text of divs whose className is menu-item
var $menuTexts = _collectAttributes("_div", "menu-item", "sahiText");
// or more explicitly
var $menuTexts = _collectAttributes("_div", {className:"menu-item"}, "sahiText");

Fetching one of few simple attributes from multiple elements

// Return name or id of textboxes. If name is found return name, else id.
// Note the use of single pipe |.
var $identifiers = _collectAttributes("_textbox", "/.*/", "name|id");

Fetching some synthesized/processed values from multiple elements by executing an inline function for each element

// For each div of className menu-item, function will be called and the current div will be passed as $el.
var $htmls = _collectAttributes("_div", "menu-item", function ($el) {return $el.innerHTML;}, _in(_div("navbar")));

Fetching some synthesized/processed values from multiple elements by executing a defined function for each element

// getInnerHTML will be called for each element whose attribute we are collecting.
function getInnerHTML($el) {
return $el.innerHTML;
}
// For each div of className menu-item, getInnerHTML function will be called and the current div will be passed as $el.
var $htmls = _collectAttributes("_div", "menu-item", getInnerHTML, _in(_div("navbar")));

Fetching some synthesized/processed values from multiple elements by executing nested functions

// Notice the use of browser tag for the second level function called from getHTML.
<browser>
function getInnerHTMLOfParent(el){
return el.parentNode.innerHTML;
}
</browser>
// This is not inside a browser tag.
function getHTML(el) {
// calls another function.
// The called function should be inside a browser tag,
// because of the way Sahi serializes content between proxy and browser.
return getInnerHTMLOfParent(el);
}
var $htmls = _collectAttributes("_div", "menu-item", getHTML, _in(_div("navbar")));
Since
Sahi Pro 6.2.1
Desktop Engine 7.5.0
Mobile Engine 7.5.0

Modes BrowserWindowsJava (8.0.0)

_collectElementsInfo($elementType[, $relations])

Arguments

NameTypeDescription
$elementTypestringType of elements to collect. Can be regular expression.
Eg. "_link", "_button", "/text/" etc.
$relationsrelationsoptionalRelations like _in, _near etc.

Returns

array of objectsArray of Accessor Info object of all elements of the specified type within relations
var $accs1 = _collectElementsInfo("/text/"); // Collect all _textbox and _textarea accessor info.
// Collect all _radio accessor infos in div "modes".
var $accs = _collectElementsInfo("_radio", _in(_div("modes")));
/*
$accs = [
{"api":"_radio", "identifiers":{"id":"sahiradio", "index":0, "name":"mode", "value":"on"}, "tag":"INPUT"},
{"api":"_radio", "identifiers":{"id":"javaradio", "index":1, "name":"mode[1]", "value":"on[1]"}, "tag":"INPUT"},
{"api":"_radio", "identifiers":{"id":"rubyradio", "index":2, "name":"mode[2]", "value":"on[2]"}, "tag":"INPUT"}
]
*/
for (var $i=0; $i<$accs.length; $i++) {
var $obj = $accs[$i];
var $identifiers = $obj["identifiers"];
var $el = $obj["api"] + "(\"" + $identifiers["id"] + "\")";
_log($el);
}