Windows Accessor APIs

Sahi - Windows Accessor APIs

Windows Elements

_generic

Since Sahi Pro: NA
Since Sahi OS: NA

API	_generic(identifier [, relation1 [, relation2 ...]])
Identifiers	name, automationId, helptext, index Valid Accessors and alternatives: (Assume this is the 6th generic in the UI) `//name _generic("generic_name") //index _generic(5)`
Relations	Relational APIs _in, _near, _leftOf, _rightOf, _under, _above can be used. `// with _in _generic("generic_name", _in(_group("Container"))) // index with 2 relational APIs, _rightOf and _under _generic(0, _rightOf(_image("Name")), _under(_combobox("Action"))) // with regular expression and relations _generic("/elname/", _rightOf(_image("Name")), _under(_combobox("Action")))`
Value	text (this is the default attribute used in assertions etc.)
Actions	Default event recorded is _click Example usage: `_click(_generic("generic_name")); _click(_generic("/Name/[1]", _rightOf(_image("Name"))));`
Assertions	Example assertions: `// Check if element exists _assertExists(_generic("generic_id")); // Check if element is visible _assert(_isVisible(_generic("generic_id")));`

_calendar

Since Sahi Pro: NA
Since Sahi OS: NA

API	_calendar(identifier [, relation1 [, relation2 ...]])
Identifiers	name, automationId, helptext, index Valid Accessors and alternatives: (Assume this is the 6th calendar in the UI) `//name _calendar("calendar_name") //index _calendar(5)`
Relations	Relational APIs _in, _near, _leftOf, _rightOf, _under, _above can be used. `// with _in _calendar("calendar_name", _in(_group("Container"))) // index with 2 relational APIs, _rightOf and _under _calendar(0, _rightOf(_image("Name")), _under(_combobox("Action"))) // with regular expression and relations _calendar("/elname/", _rightOf(_image("Name")), _under(_combobox("Action")))`
Value	grid,value,selection (this is the default attribute used in assertions etc.)
Actions	Default event recorded is _setValue Example usage: `_setValue(_calendar("calendar_name"), null); _setValue(_calendar("/Name/[1]", _rightOf(_image("Name"))), null);`
Assertions	Example assertions: `// Check if element exists _assertExists(_calendar("calendar_id")); // Check if element is visible _assert(_isVisible(_calendar("calendar_id")));`

_combobox

Since Sahi Pro: NA
Since Sahi OS: NA

API	_combobox(identifier [, relation1 [, relation2 ...]])
Identifiers	automationId, name, helptext, index Valid Accessors and alternatives: (Assume this is the 6th combobox in the UI) `//name _combobox("combobox_name") //index _combobox(5)`
Relations	Relational APIs _in, _near, _leftOf, _rightOf, _under, _above can be used. `// with _in _combobox(, _in(_group("Container"))) // index with 2 relational APIs, _rightOf and _under _combobox(0, _rightOf(_image("Name")), _under(_combobox("Action"))) // with regular expression and relations _combobox("/elname/", _rightOf(_image("Name")), _under(_combobox("Action")))`
Value	selection,value,text,expandCollapse (this is the default attribute used in assertions etc.)
Actions	Default event recorded is _setValue Example usage: `_setValue(_combobox(), null); _setValue(_combobox("/Name/[1]", _rightOf(_image("Name"))), null);`
Assertions	Example assertions: `// Check if element exists _assertExists(_combobox("combobox_id")); // Check if element is visible _assert(_isVisible(_combobox("combobox_id")));`

_custom

Since Sahi Pro: NA
Since Sahi OS: NA

API	_custom(identifier [, relation1 [, relation2 ...]])
Identifiers	name, automationId, helptext, index Valid Accessors and alternatives: (Assume this is the 6th custom in the UI) `//name _custom("custom_name") //index _custom(5)`
Relations	Relational APIs _in, _near, _leftOf, _rightOf, _under, _above can be used. `// with _in _custom("custom_name", _in(_group("Container"))) // index with 2 relational APIs, _rightOf and _under _custom(0, _rightOf(_image("Name")), _under(_combobox("Action"))) // with regular expression and relations _custom("/elname/", _rightOf(_image("Name")), _under(_combobox("Action")))`
Value	(this is the default attribute used in assertions etc.)
Actions	Default event recorded is _setValue Example usage: `_setValue(_custom("custom_name"), null); _setValue(_custom("/Name/[1]", _rightOf(_image("Name"))), null);`
Assertions	Example assertions: `// Check if element exists _assertExists(_custom("custom_id")); // Check if element is visible _assert(_isVisible(_custom("custom_id")));`

_datagrid

Since Sahi Pro: NA
Since Sahi OS: NA

API	_datagrid(identifier [, relation1 [, relation2 ...]])
Identifiers	name, automationId, helptext, index Valid Accessors and alternatives: (Assume this is the 6th datagrid in the UI) `//name _datagrid("datagrid_name") //index _datagrid(5)`
Relations	Relational APIs _in, _near, _leftOf, _rightOf, _under, _above can be used. `// with _in _datagrid("datagrid_name", _in(_group("Container"))) // index with 2 relational APIs, _rightOf and _under _datagrid(0, _rightOf(_image("Name")), _under(_combobox("Action"))) // with regular expression and relations _datagrid("/elname/", _rightOf(_image("Name")), _under(_combobox("Action")))`
Value	grid,selection,table (this is the default attribute used in assertions etc.)
Actions	Default event recorded is _setValue Example usage: `_setValue(_datagrid("datagrid_name"), null); _setValue(_datagrid("/Name/[1]", _rightOf(_image("Name"))), null);`
Assertions	Example assertions: `// Check if element exists _assertExists(_datagrid("datagrid_id")); // Check if element is visible _assert(_isVisible(_datagrid("datagrid_id")));`

_dataitem

Since Sahi Pro: NA
Since Sahi OS: NA

API	_dataitem(identifier [, relation1 [, relation2 ...]])
Identifiers	name, index Valid Accessors and alternatives: (Assume this is the 6th dataitem in the UI) `//name _dataitem("dataitem_name") //index _dataitem(5)`
Relations	Relational APIs _in, _near, _leftOf, _rightOf, _under, _above can be used. `// with _in _dataitem("dataitem_name", _in(_group("Container"))) // index with 2 relational APIs, _rightOf and _under _dataitem(0, _rightOf(_image("Name")), _under(_combobox("Action"))) // with regular expression and relations _dataitem("/elname/", _rightOf(_image("Name")), _under(_combobox("Action")))`
Value	value (this is the default attribute used in assertions etc.)
Actions	Default event recorded is _setValue Example usage: `_setValue(_dataitem("dataitem_name"), "apple"); _setValue(_dataitem("/Name/[1]", _rightOf(_image("Name"))), "apple");`
Assertions	Example assertions: `// Check if element exists _assertExists(_dataitem("dataitem_id")); // Check if element is visible _assert(_isVisible(_dataitem("dataitem_id"))); _assertEqual("apple", _getValue(_dataitem("dataitem_id")));`

_document

Since Sahi Pro: NA
Since Sahi OS: NA

API	_document(identifier [, relation1 [, relation2 ...]])
Identifiers	name, automationId, label, helptext, index Valid Accessors and alternatives: (Assume this is the 6th document in the UI) `//name _document("document_name") //index _document(5)`
Relations	Relational APIs _in, _near, _leftOf, _rightOf, _under, _above can be used. `// with _in _document("document_name", _in(_group("Container"))) // index with 2 relational APIs, _rightOf and _under _document(0, _rightOf(_image("Name")), _under(_combobox("Action"))) // with regular expression and relations _document("/elname/", _rightOf(_image("Name")), _under(_combobox("Action")))`
Value	scroll,text (this is the default attribute used in assertions etc.)
Actions	Default event recorded is _setValue Example usage: `_setValue(_document("document_name"), null); _setValue(_document("/Name/[1]", _rightOf(_image("Name"))), null);`
Assertions	Example assertions: `// Check if element exists _assertExists(_document("document_id")); // Check if element is visible _assert(_isVisible(_document("document_id")));`

_edit

Since Sahi Pro: NA
Since Sahi OS: NA

API	_edit(identifier [, relation1 [, relation2 ...]])
Identifiers	name, automationId, label, helptext, index Valid Accessors and alternatives: (Assume this is the 6th edit in the UI) `//name _edit("edit_name") //index _edit(5)`
Relations	Relational APIs _in, _near, _leftOf, _rightOf, _under, _above can be used. `// with _in _edit("edit_name", _in(_group("Container"))) // index with 2 relational APIs, _rightOf and _under _edit(0, _rightOf(_image("Name")), _under(_combobox("Action"))) // with regular expression and relations _edit("/elname/", _rightOf(_image("Name")), _under(_combobox("Action")))`
Value	value (this is the default attribute used in assertions etc.)
Actions	Default event recorded is _setValue Example usage: `_setValue(_edit("edit_name"), "apple"); _setValue(_edit("/Name/[1]", _rightOf(_image("Name"))), "apple");`
Assertions	Example assertions: `// Check if element exists _assertExists(_edit("edit_id")); // Check if element is visible _assert(_isVisible(_edit("edit_id"))); _assertEqual("apple", _getValue(_edit("edit_id")));`

_group

Since Sahi Pro: NA
Since Sahi OS: NA

API	_group(identifier [, relation1 [, relation2 ...]])
Identifiers	name, automationId, helptext, index Valid Accessors and alternatives: (Assume this is the 6th group in the UI) `//name _group("group_name") //index _group(5)`
Relations	Relational APIs _in, _near, _leftOf, _rightOf, _under, _above can be used. `// with _in _group("group_name", _in(_group("Container"))) // index with 2 relational APIs, _rightOf and _under _group(0, _rightOf(_image("Name")), _under(_combobox("Action"))) // with regular expression and relations _group("/elname/", _rightOf(_image("Name")), _under(_combobox("Action")))`
Value	(this is the default attribute used in assertions etc.)
Actions	Default event recorded is _setValue Example usage: `_setValue(_group("group_name"), null); _setValue(_group("/Name/[1]", _rightOf(_image("Name"))), null);`
Assertions	Example assertions: `// Check if element exists _assertExists(_group("group_id")); // Check if element is visible _assert(_isVisible(_group("group_id")));`

_headeritem

Since Sahi Pro: NA
Since Sahi OS: NA

API	_headeritem(identifier [, relation1 [, relation2 ...]])
Identifiers	name, automationId, helptext, index Valid Accessors and alternatives: (Assume this is the 6th headeritem in the UI) `//name _headeritem("headeritem_name") //index _headeritem(5)`
Relations	Relational APIs _in, _near, _leftOf, _rightOf, _under, _above can be used. `// with _in _headeritem("headeritem_name", _in(_group("Container"))) // index with 2 relational APIs, _rightOf and _under _headeritem(0, _rightOf(_image("Name")), _under(_combobox("Action"))) // with regular expression and relations _headeritem("/elname/", _rightOf(_image("Name")), _under(_combobox("Action")))`
Value	(this is the default attribute used in assertions etc.)
Actions	Default event recorded is _setValue Example usage: `_setValue(_headeritem("headeritem_name"), null); _setValue(_headeritem("/Name/[1]", _rightOf(_image("Name"))), null);`
Assertions	Example assertions: `// Check if element exists _assertExists(_headeritem("headeritem_id")); // Check if element is visible _assert(_isVisible(_headeritem("headeritem_id")));`

_hyperlink

Since Sahi Pro: NA
Since Sahi OS: NA

API	_hyperlink(identifier [, relation1 [, relation2 ...]])
Identifiers	name, automationId, helptext, index Valid Accessors and alternatives: (Assume this is the 6th hyperlink in the UI) `//name _hyperlink("hyperlink_name") //index _hyperlink(5)`
Relations	Relational APIs _in, _near, _leftOf, _rightOf, _under, _above can be used. `// with _in _hyperlink("hyperlink_name", _in(_group("Container"))) // index with 2 relational APIs, _rightOf and _under _hyperlink(0, _rightOf(_image("Name")), _under(_combobox("Action"))) // with regular expression and relations _hyperlink("/elname/", _rightOf(_image("Name")), _under(_combobox("Action")))`
Value	(this is the default attribute used in assertions etc.)
Actions	Default event recorded is _setValue Example usage: `_setValue(_hyperlink("hyperlink_name"), null); _setValue(_hyperlink("/Name/[1]", _rightOf(_image("Name"))), null);`
Assertions	Example assertions: `// Check if element exists _assertExists(_hyperlink("hyperlink_id")); // Check if element is visible _assert(_isVisible(_hyperlink("hyperlink_id")));`

_listview

Since Sahi Pro: NA
Since Sahi OS: NA

API	_listview(identifier [, relation1 [, relation2 ...]])
Identifiers	name, automationId, helptext, index Valid Accessors and alternatives: (Assume this is the 6th listview in the UI) `//name _listview("listview_name") //index _listview(5)`
Relations	Relational APIs _in, _near, _leftOf, _rightOf, _under, _above can be used. `// with _in _listview("listview_name", _in(_group("Container"))) // index with 2 relational APIs, _rightOf and _under _listview(0, _rightOf(_image("Name")), _under(_combobox("Action"))) // with regular expression and relations _listview("/elname/", _rightOf(_image("Name")), _under(_combobox("Action")))`
Value	selection,table,grid,multipleView (this is the default attribute used in assertions etc.)
Actions	Default event recorded is _setValue Example usage: `_setValue(_listview("listview_name"), null); _setValue(_listview("/Name/[1]", _rightOf(_image("Name"))), null);`
Assertions	Example assertions: `// Check if element exists _assertExists(_listview("listview_id")); // Check if element is visible _assert(_isVisible(_listview("listview_id")));`

_listitem

Since Sahi Pro: NA
Since Sahi OS: NA

API	_listitem(identifier [, relation1 [, relation2 ...]])
Identifiers	name, automationId, helptext, index Valid Accessors and alternatives: (Assume this is the 6th listitem in the UI) `//name _listitem("listitem_name") //index _listitem(5)`
Relations	Relational APIs _in, _near, _leftOf, _rightOf, _under, _above can be used. `// with _in _listitem("listitem_name", _in(_group("Container"))) // index with 2 relational APIs, _rightOf and _under _listitem(0, _rightOf(_image("Name")), _under(_combobox("Action"))) // with regular expression and relations _listitem("/elname/", _rightOf(_image("Name")), _under(_combobox("Action")))`
Value	(this is the default attribute used in assertions etc.)
Actions	Default event recorded is _click Example usage: `_click(_listitem("listitem_name")); _click(_listitem("/Name/[1]", _rightOf(_image("Name"))));`
Assertions	Example assertions: `// Check if element exists _assertExists(_listitem("listitem_id")); // Check if element is visible _assert(_isVisible(_listitem("listitem_id")));`

_menu

Since Sahi Pro: NA
Since Sahi OS: NA

API	_menu(identifier [, relation1 [, relation2 ...]])
Identifiers	name, automationId, helptext, index Valid Accessors and alternatives: (Assume this is the 6th menu in the UI) `//name _menu("menu_name") //index _menu(5)`
Relations	Relational APIs _in, _near, _leftOf, _rightOf, _under, _above can be used. `// with _in _menu("menu_name", _in(_group("Container"))) // index with 2 relational APIs, _rightOf and _under _menu(0, _rightOf(_image("Name")), _under(_combobox("Action"))) // with regular expression and relations _menu("/elname/", _rightOf(_image("Name")), _under(_combobox("Action")))`
Value	(this is the default attribute used in assertions etc.)
Actions	Default event recorded is _setValue Example usage: `_setValue(_menu("menu_name"), null); _setValue(_menu("/Name/[1]", _rightOf(_image("Name"))), null);`
Assertions	Example assertions: `// Check if element exists _assertExists(_menu("menu_id")); // Check if element is visible _assert(_isVisible(_menu("menu_id")));`

_menubar

Since Sahi Pro: NA
Since Sahi OS: NA

API	_menubar(identifier [, relation1 [, relation2 ...]])
Identifiers	name, automationId, helptext, index Valid Accessors and alternatives: (Assume this is the 6th menubar in the UI) `//name _menubar("menubar_name") //index _menubar(5)`
Relations	Relational APIs _in, _near, _leftOf, _rightOf, _under, _above can be used. `// with _in _menubar("menubar_name", _in(_group("Container"))) // index with 2 relational APIs, _rightOf and _under _menubar(0, _rightOf(_image("Name")), _under(_combobox("Action"))) // with regular expression and relations _menubar("/elname/", _rightOf(_image("Name")), _under(_combobox("Action")))`
Value	(this is the default attribute used in assertions etc.)
Actions	Default event recorded is _setValue Example usage: `_setValue(_menubar("menubar_name"), null); _setValue(_menubar("/Name/[1]", _rightOf(_image("Name"))), null);`
Assertions	Example assertions: `// Check if element exists _assertExists(_menubar("menubar_id")); // Check if element is visible _assert(_isVisible(_menubar("menubar_id")));`

_menuitem

Since Sahi Pro: NA
Since Sahi OS: NA

API	_menuitem(identifier [, relation1 [, relation2 ...]])
Identifiers	name, automationId, helptext, index Valid Accessors and alternatives: (Assume this is the 6th menuitem in the UI) `//name _menuitem("menuitem_name") //index _menuitem(5)`
Relations	Relational APIs _in, _near, _leftOf, _rightOf, _under, _above can be used. `// with _in _menuitem("menuitem_name", _in(_group("Container"))) // index with 2 relational APIs, _rightOf and _under _menuitem(0, _rightOf(_image("Name")), _under(_combobox("Action"))) // with regular expression and relations _menuitem("/elname/", _rightOf(_image("Name")), _under(_combobox("Action")))`
Value	expandCollapse,toggle (this is the default attribute used in assertions etc.)
Actions	Default event recorded is _setValue Example usage: `_setValue(_menuitem("menuitem_name"), null); _setValue(_menuitem("/Name/[1]", _rightOf(_image("Name"))), null);`
Assertions	Example assertions: `// Check if element exists _assertExists(_menuitem("menuitem_id")); // Check if element is visible _assert(_isVisible(_menuitem("menuitem_id")));`

_pane

Since Sahi Pro: NA
Since Sahi OS: NA

API	_pane(identifier [, relation1 [, relation2 ...]])
Identifiers	name, automationId, helptext, index Valid Accessors and alternatives: (Assume this is the 6th pane in the UI) `//name _pane("pane_name") //index _pane(5)`
Relations	Relational APIs _in, _near, _leftOf, _rightOf, _under, _above can be used. `// with _in _pane("pane_name", _in(_group("Container"))) // index with 2 relational APIs, _rightOf and _under _pane(0, _rightOf(_image("Name")), _under(_combobox("Action"))) // with regular expression and relations _pane("/elname/", _rightOf(_image("Name")), _under(_combobox("Action")))`
Value	transform (this is the default attribute used in assertions etc.)
Actions	Default event recorded is _setValue Example usage: `_setValue(_pane("pane_name"), null); _setValue(_pane("/Name/[1]", _rightOf(_image("Name"))), null);`
Assertions	Example assertions: `// Check if element exists _assertExists(_pane("pane_id")); // Check if element is visible _assert(_isVisible(_pane("pane_id")));`

_progressbar

Since Sahi Pro: NA
Since Sahi OS: NA

API	_progressbar(identifier [, relation1 [, relation2 ...]])
Identifiers	name, automationId, helptext, index Valid Accessors and alternatives: (Assume this is the 6th progressbar in the UI) `//name _progressbar("progressbar_name") //index _progressbar(5)`
Relations	Relational APIs _in, _near, _leftOf, _rightOf, _under, _above can be used. `// with _in _progressbar("progressbar_name", _in(_group("Container"))) // index with 2 relational APIs, _rightOf and _under _progressbar(0, _rightOf(_image("Name")), _under(_combobox("Action"))) // with regular expression and relations _progressbar("/elname/", _rightOf(_image("Name")), _under(_combobox("Action")))`
Value	rangeValue (this is the default attribute used in assertions etc.)
Actions	Default event recorded is _click Example usage: `_click(_progressbar("progressbar_name")); _click(_progressbar("/Name/[1]", _rightOf(_image("Name"))));`
Assertions	Example assertions: `// Check if element exists _assertExists(_progressbar("progressbar_id")); // Check if element is visible _assert(_isVisible(_progressbar("progressbar_id")));`

_radiobutton

Since Sahi Pro: NA
Since Sahi OS: NA

API	_radiobutton(identifier [, relation1 [, relation2 ...]])
Identifiers	name, automationId, helptext, index Valid Accessors and alternatives: (Assume this is the 6th radiobutton in the UI) `//name _radiobutton("radiobutton_name") //index _radiobutton(5)`
Relations	Relational APIs _in, _near, _leftOf, _rightOf, _under, _above can be used. `// with _in _radiobutton("radiobutton_name", _in(_group("Container"))) // index with 2 relational APIs, _rightOf and _under _radiobutton(0, _rightOf(_image("Name")), _under(_combobox("Action"))) // with regular expression and relations _radiobutton("/elname/", _rightOf(_image("Name")), _under(_combobox("Action")))`
Value	selectionItem (this is the default attribute used in assertions etc.)
Actions	Default event recorded is _setValue Example usage: `_setValue(_radiobutton("radiobutton_name"), null); _setValue(_radiobutton("/Name/[1]", _rightOf(_image("Name"))), null);`
Assertions	Example assertions: `// Check if element exists _assertExists(_radiobutton("radiobutton_id")); // Check if element is visible _assert(_isVisible(_radiobutton("radiobutton_id")));`

_scrollbar

Since Sahi Pro: NA
Since Sahi OS: NA

API	_scrollbar(identifier [, relation1 [, relation2 ...]])
Identifiers	name, automationId, helptext, index Valid Accessors and alternatives: (Assume this is the 6th scrollbar in the UI) `//name _scrollbar("scrollbar_name") //index _scrollbar(5)`
Relations	Relational APIs _in, _near, _leftOf, _rightOf, _under, _above can be used. `// with _in _scrollbar("scrollbar_name", _in(_group("Container"))) // index with 2 relational APIs, _rightOf and _under _scrollbar(0, _rightOf(_image("Name")), _under(_combobox("Action"))) // with regular expression and relations _scrollbar("/elname/", _rightOf(_image("Name")), _under(_combobox("Action")))`
Value	(this is the default attribute used in assertions etc.)
Actions	Default event recorded is _setValue Example usage: `_setValue(_scrollbar("scrollbar_name"), null); _setValue(_scrollbar("/Name/[1]", _rightOf(_image("Name"))), null);`
Assertions	Example assertions: `// Check if element exists _assertExists(_scrollbar("scrollbar_id")); // Check if element is visible _assert(_isVisible(_scrollbar("scrollbar_id")));`

_seperator

Since Sahi Pro: NA
Since Sahi OS: NA

API	_seperator(identifier [, relation1 [, relation2 ...]])
Identifiers	name, automationId, helptext, index Valid Accessors and alternatives: (Assume this is the 6th seperator in the UI) `//name _seperator("seperator_name") //index _seperator(5)`
Relations	Relational APIs _in, _near, _leftOf, _rightOf, _under, _above can be used. `// with _in _seperator("seperator_name", _in(_group("Container"))) // index with 2 relational APIs, _rightOf and _under _seperator(0, _rightOf(_image("Name")), _under(_combobox("Action"))) // with regular expression and relations _seperator("/elname/", _rightOf(_image("Name")), _under(_combobox("Action")))`
Value	(this is the default attribute used in assertions etc.)
Actions	Default event recorded is _setValue Example usage: `_setValue(_seperator("seperator_name"), null); _setValue(_seperator("/Name/[1]", _rightOf(_image("Name"))), null);`
Assertions	Example assertions: `// Check if element exists _assertExists(_seperator("seperator_id")); // Check if element is visible _assert(_isVisible(_seperator("seperator_id")));`

_slider

Since Sahi Pro: NA
Since Sahi OS: NA

API	_slider(identifier [, relation1 [, relation2 ...]])
Identifiers	name, automationId, helptext, index Valid Accessors and alternatives: (Assume this is the 6th slider in the UI) `//name _slider("slider_name") //index _slider(5)`
Relations	Relational APIs _in, _near, _leftOf, _rightOf, _under, _above can be used. `// with _in _slider("slider_name", _in(_group("Container"))) // index with 2 relational APIs, _rightOf and _under _slider(0, _rightOf(_image("Name")), _under(_combobox("Action"))) // with regular expression and relations _slider("/elname/", _rightOf(_image("Name")), _under(_combobox("Action")))`
Value	rangeValue,value (this is the default attribute used in assertions etc.)
Actions	Default event recorded is _setValue Example usage: `_setValue(_slider("slider_name"), null); _setValue(_slider("/Name/[1]", _rightOf(_image("Name"))), null);`
Assertions	Example assertions: `// Check if element exists _assertExists(_slider("slider_id")); // Check if element is visible _assert(_isVisible(_slider("slider_id")));`

_spinner

Since Sahi Pro: NA
Since Sahi OS: NA

API	_spinner(identifier [, relation1 [, relation2 ...]])
Identifiers	name, automationId, helptext, index Valid Accessors and alternatives: (Assume this is the 6th spinner in the UI) `//name _spinner("spinner_name") //index _spinner(5)`
Relations	Relational APIs _in, _near, _leftOf, _rightOf, _under, _above can be used. `// with _in _spinner("spinner_name", _in(_group("Container"))) // index with 2 relational APIs, _rightOf and _under _spinner(0, _rightOf(_image("Name")), _under(_combobox("Action"))) // with regular expression and relations _spinner("/elname/", _rightOf(_image("Name")), _under(_combobox("Action")))`
Value	rangeValue,selection (this is the default attribute used in assertions etc.)
Actions	Default event recorded is _setValue Example usage: `_setValue(_spinner("spinner_name"), null); _setValue(_spinner("/Name/[1]", _rightOf(_image("Name"))), null);`
Assertions	Example assertions: `// Check if element exists _assertExists(_spinner("spinner_id")); // Check if element is visible _assert(_isVisible(_spinner("spinner_id")));`

_splitbutton

Since Sahi Pro: NA
Since Sahi OS: NA

API	_splitbutton(identifier [, relation1 [, relation2 ...]])
Identifiers	name, automationId, helptext, index Valid Accessors and alternatives: (Assume this is the 6th splitbutton in the UI) `//name _splitbutton("splitbutton_name") //index _splitbutton(5)`
Relations	Relational APIs _in, _near, _leftOf, _rightOf, _under, _above can be used. `// with _in _splitbutton("splitbutton_name", _in(_group("Container"))) // index with 2 relational APIs, _rightOf and _under _splitbutton(0, _rightOf(_image("Name")), _under(_combobox("Action"))) // with regular expression and relations _splitbutton("/elname/", _rightOf(_image("Name")), _under(_combobox("Action")))`
Value	expandCollapse (this is the default attribute used in assertions etc.)
Actions	Default event recorded is _setValue Example usage: `_setValue(_splitbutton("splitbutton_name"), null); _setValue(_splitbutton("/Name/[1]", _rightOf(_image("Name"))), null);`
Assertions	Example assertions: `// Check if element exists _assertExists(_splitbutton("splitbutton_id")); // Check if element is visible _assert(_isVisible(_splitbutton("splitbutton_id")));`

_statusbar

Since Sahi Pro: NA
Since Sahi OS: NA

API	_statusbar(identifier [, relation1 [, relation2 ...]])
Identifiers	name, automationId, helptext, index Valid Accessors and alternatives: (Assume this is the 6th statusbar in the UI) `//name _statusbar("statusbar_name") //index _statusbar(5)`
Relations	Relational APIs _in, _near, _leftOf, _rightOf, _under, _above can be used. `// with _in _statusbar("statusbar_name", _in(_group("Container"))) // index with 2 relational APIs, _rightOf and _under _statusbar(0, _rightOf(_image("Name")), _under(_combobox("Action"))) // with regular expression and relations _statusbar("/elname/", _rightOf(_image("Name")), _under(_combobox("Action")))`
Value	(this is the default attribute used in assertions etc.)
Actions	Default event recorded is _setValue Example usage: `_setValue(_statusbar("statusbar_name"), null); _setValue(_statusbar("/Name/[1]", _rightOf(_image("Name"))), null);`
Assertions	Example assertions: `// Check if element exists _assertExists(_statusbar("statusbar_id")); // Check if element is visible _assert(_isVisible(_statusbar("statusbar_id")));`

_tab

Since Sahi Pro: NA
Since Sahi OS: NA

API	_tab(identifier [, relation1 [, relation2 ...]])
Identifiers	name, automationId, helptext, index Valid Accessors and alternatives: (Assume this is the 6th tab in the UI) `//name _tab("tab_name") //index _tab(5)`
Relations	Relational APIs _in, _near, _leftOf, _rightOf, _under, _above can be used. `// with _in _tab("tab_name", _in(_group("Container"))) // index with 2 relational APIs, _rightOf and _under _tab(0, _rightOf(_image("Name")), _under(_combobox("Action"))) // with regular expression and relations _tab("/elname/", _rightOf(_image("Name")), _under(_combobox("Action")))`
Value	(this is the default attribute used in assertions etc.)
Actions	Default event recorded is _setValue Example usage: `_setValue(_tab("tab_name"), null); _setValue(_tab("/Name/[1]", _rightOf(_image("Name"))), null);`
Assertions	Example assertions: `// Check if element exists _assertExists(_tab("tab_id")); // Check if element is visible _assert(_isVisible(_tab("tab_id")));`

_tabitem

Since Sahi Pro: NA
Since Sahi OS: NA

API	_tabitem(identifier [, relation1 [, relation2 ...]])
Identifiers	name, automationId, helptext, index Valid Accessors and alternatives: (Assume this is the 6th tabitem in the UI) `//name _tabitem("tabitem_name") //index _tabitem(5)`
Relations	Relational APIs _in, _near, _leftOf, _rightOf, _under, _above can be used. `// with _in _tabitem("tabitem_name", _in(_group("Container"))) // index with 2 relational APIs, _rightOf and _under _tabitem(0, _rightOf(_image("Name")), _under(_combobox("Action"))) // with regular expression and relations _tabitem("/elname/", _rightOf(_image("Name")), _under(_combobox("Action")))`
Value	(this is the default attribute used in assertions etc.)
Actions	Default event recorded is _setValue Example usage: `_setValue(_tabitem("tabitem_name"), null); _setValue(_tabitem("/Name/[1]", _rightOf(_image("Name"))), null);`
Assertions	Example assertions: `// Check if element exists _assertExists(_tabitem("tabitem_id")); // Check if element is visible _assert(_isVisible(_tabitem("tabitem_id")));`

_text

Since Sahi Pro: NA
Since Sahi OS: NA

API	_text(identifier [, relation1 [, relation2 ...]])
Identifiers	name, automationId, helptext, index Valid Accessors and alternatives: (Assume this is the 6th text in the UI) `//name _text("text_name") //index _text(5)`
Relations	Relational APIs _in, _near, _leftOf, _rightOf, _under, _above can be used. `// with _in _text("text_name", _in(_group("Container"))) // index with 2 relational APIs, _rightOf and _under _text(0, _rightOf(_image("Name")), _under(_combobox("Action"))) // with regular expression and relations _text("/elname/", _rightOf(_image("Name")), _under(_combobox("Action")))`
Value	(this is the default attribute used in assertions etc.)
Actions	Default event recorded is _setValue Example usage: `_setValue(_text("text_name"), null); _setValue(_text("/Name/[1]", _rightOf(_image("Name"))), null);`
Assertions	Example assertions: `// Check if element exists _assertExists(_text("text_id")); // Check if element is visible _assert(_isVisible(_text("text_id")));`

_thumb

Since Sahi Pro: NA
Since Sahi OS: NA

API	_thumb(identifier [, relation1 [, relation2 ...]])
Identifiers	name, automationId, helptext, index Valid Accessors and alternatives: (Assume this is the 6th thumb in the UI) `//name _thumb("thumb_name") //index _thumb(5)`
Relations	Relational APIs _in, _near, _leftOf, _rightOf, _under, _above can be used. `// with _in _thumb("thumb_name", _in(_group("Container"))) // index with 2 relational APIs, _rightOf and _under _thumb(0, _rightOf(_image("Name")), _under(_combobox("Action"))) // with regular expression and relations _thumb("/elname/", _rightOf(_image("Name")), _under(_combobox("Action")))`
Value	(this is the default attribute used in assertions etc.)
Actions	Default event recorded is _setValue Example usage: `_setValue(_thumb("thumb_name"), null); _setValue(_thumb("/Name/[1]", _rightOf(_image("Name"))), null);`
Assertions	Example assertions: `// Check if element exists _assertExists(_thumb("thumb_id")); // Check if element is visible _assert(_isVisible(_thumb("thumb_id")));`

_titlebar

Since Sahi Pro: NA
Since Sahi OS: NA

API	_titlebar(identifier [, relation1 [, relation2 ...]])
Identifiers	name, automationId, helptext, index Valid Accessors and alternatives: (Assume this is the 6th titlebar in the UI) `//name _titlebar("titlebar_name") //index _titlebar(5)`
Relations	Relational APIs _in, _near, _leftOf, _rightOf, _under, _above can be used. `// with _in _titlebar("titlebar_name", _in(_group("Container"))) // index with 2 relational APIs, _rightOf and _under _titlebar(0, _rightOf(_image("Name")), _under(_combobox("Action"))) // with regular expression and relations _titlebar("/elname/", _rightOf(_image("Name")), _under(_combobox("Action")))`
Value	text (this is the default attribute used in assertions etc.)
Actions	Default event recorded is _setValue Example usage: `_setValue(_titlebar("titlebar_name"), null); _setValue(_titlebar("/Name/[1]", _rightOf(_image("Name"))), null);`
Assertions	Example assertions: `// Check if element exists _assertExists(_titlebar("titlebar_id")); // Check if element is visible _assert(_isVisible(_titlebar("titlebar_id")));`

_toolbar

Since Sahi Pro: NA
Since Sahi OS: NA

API	_toolbar(identifier [, relation1 [, relation2 ...]])
Identifiers	name, automationId, helptext, index Valid Accessors and alternatives: (Assume this is the 6th toolbar in the UI) `//name _toolbar("toolbar_name") //index _toolbar(5)`
Relations	Relational APIs _in, _near, _leftOf, _rightOf, _under, _above can be used. `// with _in _toolbar("toolbar_name", _in(_group("Container"))) // index with 2 relational APIs, _rightOf and _under _toolbar(0, _rightOf(_image("Name")), _under(_combobox("Action"))) // with regular expression and relations _toolbar("/elname/", _rightOf(_image("Name")), _under(_combobox("Action")))`
Value	(this is the default attribute used in assertions etc.)
Actions	Default event recorded is _setValue Example usage: `_setValue(_toolbar("toolbar_name"), null); _setValue(_toolbar("/Name/[1]", _rightOf(_image("Name"))), null);`
Assertions	Example assertions: `// Check if element exists _assertExists(_toolbar("toolbar_id")); // Check if element is visible _assert(_isVisible(_toolbar("toolbar_id")));`

_tooltip

Since Sahi Pro: NA
Since Sahi OS: NA

API	_tooltip(identifier [, relation1 [, relation2 ...]])
Identifiers	name, automationId, helptext, index Valid Accessors and alternatives: (Assume this is the 6th tooltip in the UI) `//name _tooltip("tooltip_name") //index _tooltip(5)`
Relations	Relational APIs _in, _near, _leftOf, _rightOf, _under, _above can be used. `// with _in _tooltip("tooltip_name", _in(_group("Container"))) // index with 2 relational APIs, _rightOf and _under _tooltip(0, _rightOf(_image("Name")), _under(_combobox("Action"))) // with regular expression and relations _tooltip("/elname/", _rightOf(_image("Name")), _under(_combobox("Action")))`
Value	(this is the default attribute used in assertions etc.)
Actions	Default event recorded is _setValue Example usage: `_setValue(_tooltip("tooltip_name"), null); _setValue(_tooltip("/Name/[1]", _rightOf(_image("Name"))), null);`
Assertions	Example assertions: `// Check if element exists _assertExists(_tooltip("tooltip_id")); // Check if element is visible _assert(_isVisible(_tooltip("tooltip_id")));`

_tree

Since Sahi Pro: NA
Since Sahi OS: NA

API	_tree(identifier [, relation1 [, relation2 ...]])
Identifiers	name, automationId, helptext, index Valid Accessors and alternatives: (Assume this is the 6th tree in the UI) `//name _tree("tree_name") //index _tree(5)`
Relations	Relational APIs _in, _near, _leftOf, _rightOf, _under, _above can be used. `// with _in _tree("tree_name", _in(_group("Container"))) // index with 2 relational APIs, _rightOf and _under _tree(0, _rightOf(_image("Name")), _under(_combobox("Action"))) // with regular expression and relations _tree("/elname/", _rightOf(_image("Name")), _under(_combobox("Action")))`
Value	(this is the default attribute used in assertions etc.)
Actions	Default event recorded is _setValue Example usage: `_setValue(_tree("tree_name"), null); _setValue(_tree("/Name/[1]", _rightOf(_image("Name"))), null);`
Assertions	Example assertions: `// Check if element exists _assertExists(_tree("tree_id")); // Check if element is visible _assert(_isVisible(_tree("tree_id")));`

_treeitem

Since Sahi Pro: NA
Since Sahi OS: NA

API	_treeitem(identifier [, relation1 [, relation2 ...]])
Identifiers	name, automationId, helptext, index Valid Accessors and alternatives: (Assume this is the 6th treeitem in the UI) `//name _treeitem("treeitem_name") //index _treeitem(5)`
Relations	Relational APIs _in, _near, _leftOf, _rightOf, _under, _above can be used. `// with _in _treeitem("treeitem_name", _in(_group("Container"))) // index with 2 relational APIs, _rightOf and _under _treeitem(0, _rightOf(_image("Name")), _under(_combobox("Action"))) // with regular expression and relations _treeitem("/elname/", _rightOf(_image("Name")), _under(_combobox("Action")))`
Value	(this is the default attribute used in assertions etc.)
Actions	Default event recorded is _setValue Example usage: `_setValue(_treeitem("treeitem_name"), null); _setValue(_treeitem("/Name/[1]", _rightOf(_image("Name"))), null);`
Assertions	Example assertions: `// Check if element exists _assertExists(_treeitem("treeitem_id")); // Check if element is visible _assert(_isVisible(_treeitem("treeitem_id")));`

_treeviewitem

Since Sahi Pro: NA
Since Sahi OS: NA

API	_treeviewitem(identifier [, relation1 [, relation2 ...]])
Identifiers	name, automationId, helptext, index Valid Accessors and alternatives: (Assume this is the 6th treeviewitem in the UI) `//name _treeviewitem("treeviewitem_name") //index _treeviewitem(5)`
Relations	Relational APIs _in, _near, _leftOf, _rightOf, _under, _above can be used. `// with _in _treeviewitem("treeviewitem_name", _in(_group("Container"))) // index with 2 relational APIs, _rightOf and _under _treeviewitem(0, _rightOf(_image("Name")), _under(_combobox("Action"))) // with regular expression and relations _treeviewitem("/elname/", _rightOf(_image("Name")), _under(_combobox("Action")))`
Value	(this is the default attribute used in assertions etc.)
Actions	Default event recorded is _setValue Example usage: `_setValue(_treeviewitem("treeviewitem_name"), null); _setValue(_treeviewitem("/Name/[1]", _rightOf(_image("Name"))), null);`
Assertions	Example assertions: `// Check if element exists _assertExists(_treeviewitem("treeviewitem_id")); // Check if element is visible _assert(_isVisible(_treeviewitem("treeviewitem_id")));`

_treeview

Since Sahi Pro: NA
Since Sahi OS: NA

API	_treeview(identifier [, relation1 [, relation2 ...]])
Identifiers	name, automationId, helptext, index Valid Accessors and alternatives: (Assume this is the 6th treeview in the UI) `//name _treeview("treeview_name") //index _treeview(5)`
Relations	Relational APIs _in, _near, _leftOf, _rightOf, _under, _above can be used. `// with _in _treeview("treeview_name", _in(_group("Container"))) // index with 2 relational APIs, _rightOf and _under _treeview(0, _rightOf(_image("Name")), _under(_combobox("Action"))) // with regular expression and relations _treeview("/elname/", _rightOf(_image("Name")), _under(_combobox("Action")))`
Value	(this is the default attribute used in assertions etc.)
Actions	Default event recorded is _setValue Example usage: `_setValue(_treeview("treeview_name"), null); _setValue(_treeview("/Name/[1]", _rightOf(_image("Name"))), null);`
Assertions	Example assertions: `// Check if element exists _assertExists(_treeview("treeview_id")); // Check if element is visible _assert(_isVisible(_treeview("treeview_id")));`

_window

Since Sahi Pro: NA
Since Sahi OS: NA

API	_window(identifier [, relation1 [, relation2 ...]])
Identifiers	name, automationId, helptext, index Valid Accessors and alternatives: (Assume this is the 6th window in the UI) `//name _window("window_name") //index _window(5)`
Relations	Relational APIs _in, _near, _leftOf, _rightOf, _under, _above can be used. `// with _in _window("window_name", _in(_group("Container"))) // index with 2 relational APIs, _rightOf and _under _window(0, _rightOf(_image("Name")), _under(_combobox("Action"))) // with regular expression and relations _window("/elname/", _rightOf(_image("Name")), _under(_combobox("Action")))`
Value	window (this is the default attribute used in assertions etc.)
Actions	Default event recorded is _setValue Example usage: `_setValue(_window("window_name"), null); _setValue(_window("/Name/[1]", _rightOf(_image("Name"))), null);`
Assertions	Example assertions: `// Check if element exists _assertExists(_window("window_id")); // Check if element is visible _assert(_isVisible(_window("window_id")));`