Generic Accessor APIs

_activeElement

Since: Sahi ProSahi OSSahi Pro StarterDesktop Add-OnMobile Add-OnSAP Add-On
4.04.37.0.1NANANA

Available for modes: Browser

_activeElement()

Arguments
None

Returns
HTML DOM elementElement in focus

Details

Used to verify if the specific element is the one in focus. Eg
_assertEqual(_texbox("user"), _activeElement());


_byId

Since: Sahi ProSahi OSSahi Pro StarterDesktop Add-OnMobile Add-OnSAP Add-On
3.527.0.1NANANA

Available for modes: Browser

_byId($id)

Arguments
$idstring id of element

Returns
HTML DOM elementElement matching with the specified id

Details

Used to find elements solely by id without using its tagName information.
<div id="errormsg">Error</div>
_byId("errormsg") // points to the above tag. Note that the tagName "div" is not used here.


_byText

Since: Sahi ProSahi OSSahi Pro StarterDesktop Add-OnMobile Add-OnSAP Add-On
3.527.0.1NANANA

Available for modes: Browser

_byText($text, $tagName)

Arguments
$textstring text of element
$tagNamestring tagName of element which has this text. eg. "DIV"

Returns
HTML DOM elementElement matching with the specified text and tagName

Details

Used to find element by text and tagName
<div id="errormsg">some text</div>
_byText("some text", "DIV") // points to the above tag.
danger DEPRECATED: Use _div("some text") or more specifically _div({sahiText:"some text"}) instead


_byClassName

Since: Sahi ProSahi OSSahi Pro StarterDesktop Add-OnMobile Add-OnSAP Add-On
3.537.0.1NANANA

Available for modes: Browser

_byClassName($className, $tagName[, $relations])

Arguments
$classNamestring className of element
$tagNamestring tagName of element which has this text. eg. "DIV"
$relationsrelation optional DOM or Positional Relations

Returns
HTML DOM elementElement matching with the specified className and tagName

Details

Finds element by className with given tagName and constrained by given relations
<div class="bigfont">Some text</div>
_byClassName("bigfont", "DIV")


danger DEPRECATED: Use _div("bigfont") or more specifically _div({className:"bigfont"}) instead


_byXPath

Since: Sahi ProSahi OSSahi Pro StarterDesktop Add-OnMobile Add-OnSAP Add-On
3.537.0.1NANANA

Available for modes: Browser

_byXPath($xpath)

Arguments
$xpathstring XPath of element

Returns
HTML DOM elementElement matching with the specified xpath

Details

Eg.
_byXPath("//table[3]//tr[1]/td[2]")
_byXPath("//tr[1]/td[2]")
This is a convenience method for people moving from Selenium or other tools to Sahi.
info XPaths are natively enabled on Firefox. For browsers like Internet Explorer which do not have support for XPath use Javascript-XPath.

For browsers without XPath support, use Javascript-XPath Download the file from this link and save the file as sahi/htdocs/spr/ext/javascript-xpath/javascript-xpath.js

This file is under its own MIT license and is not part of Sahi's code base

_accessor

Since: Sahi ProSahi OSSahi Pro StarterDesktop Add-OnMobile Add-OnSAP Add-On
3.527.0.1NANANA

Available for modes: Browser

_accessor($string)

Arguments
$stringstring String to eval

Returns
HTML DOM elementElement

Details

This API just evaluates the string and returns a dom object. Eg. _accessor("document.formName.elementName"). This API is not very useful.


_bySeleniumLocator

Since: Sahi ProSahi OSSahi Pro StarterDesktop Add-OnMobile Add-OnSAP Add-On
3.537.0.1NANANA

Available for modes: Browser

_bySeleniumLocator($locator)

Arguments
$locatorstring selenium locator

Returns
null

Details

Allows identification of elements using some Selenium locators. Use only while migrating from Selenium to Sahi.