1.4.0.8
global
yes
Selenium2Library is a web testing library for the Robot Framework and was
originally written in Python. This is the Java port of the Selenium 2
(WebDriver) Python library for Robot Framework. It uses the Selenium 2
(WebDriver) libraries internally to control a web browser. See <a
href="http://seleniumhq.org/docs/03_webdriver.html">WebDriver</a> for more
information on Selenium 2 and WebDriver. It runs tests in a real browser
instance and should work with most modern browsers and can be used with the
Jython interpreter or any other Java application.<br>
<br>
<span style="font-size: 120%;"><b>Before running tests</b></span><br>
Prior to running test cases using Selenium2Library, the library must be
imported into your Robot Framework test suite (see importing section), and
the `Open Browser` keyword must be used to open a browser to the desired
location.<br>
<br>
<span style="font-size: 120%;"><b>Locating elements</b></span><br>
All keywords in Selenium2Library that need to find an element on the page
take an locator argument.<br>
<br>
<b>Key attributes</b><br>
By default, when a locator value is provided, it is matched against the key
attributes of the particular element type. The attributes <i>id</i> and
<i>name</i> are key attributes to all elements.<br>
<br>
List of key attributes:
<table border="1" cellspacing="0" summary="">
<tr>
<td><b>Element Type</b></td>
<td><b>Key Attributes</b></td>
</tr>
<tr>
<td>A</td>
<td>@id,@name,@href,text</td>
</tr>
<tr>
<td>IMG</td>
<td>@id,@name,@src,@alt</td>
</tr>
<tr>
<td>INPUT</td>
<td>@id,@name,@value,@src</td>
</tr>
<tr>
<td>BUTTON</td>
<td>@id,@name,@value,text</td>
</tr>
<tr>
<td>*</td>
<td>@id,@name</td>
</tr>
</table>
<br>
Example:
<table border="1" cellspacing="0" summary="">
<tr>
<td>Click Element</td>
<td>my_element</td>
</tr>
</table>
<br>
<b>Locator strategies</b><br>
It is also possible to specify the approach Selenium2Library should take to
find an element by specifying a locator strategy with a locator prefix.<br>
<br>
Supported strategies are:
<table border="1" cellspacing="0" summary="">
<tr>
<td><b>Strategy</b></td>
<td><b>Example</b></td>
<td><b>Description</b></td>
</tr>
<tr>
<td>identifier</td>
<td>Click Element | identifier=my_element</td>
<td>Matches by @id or @name attribute</td>
</tr>
<tr>
<td>id</td>
<td>Click Element | id=my_element</td>
<td>Matches by @id attribute</td>
</tr>
<tr>
<td>name</td>
<td>Click Element | name=my_element</td>
<td>Matches by @name attribute</td>
</tr>
<tr>
<td>xpath</td>
<td>Click Element | xpath=//div[@id='my_element']</td>
<td>Matches by arbitrary XPath expression</td>
</tr>
<tr>
<td>dom</td>
<td>Click Element | dom=document.images[56]</td>
<td>Matches by arbitrary DOM expression</td>
</tr>
<tr>
<td>link</td>
<td>Click Element | link=My Link</td>
<td>Matches by the link text</td>
</tr>
<tr>
<td>css</td>
<td>Click Element | css=div.my_class</td>
<td>Matches by CSS selector</td>
</tr>
<tr>
<td>jquery</td>
<td>Click Element | jquery=div.my_class</td>
<td>Matches by jQuery/sizzle selector</td>
</tr>
<tr>
<td>sizzle</td>
<td>Click Element | sizzle=div.my_class</td>
<td>Matches by jQuery/sizzle selector</td>
</tr>
<tr>
<td>tag</td>
<td>Click Element | tag=div</td>
<td>Matches by HTML tag name</td>
</tr>
</table>
<br>
<b>Locating tables</b><br>
Table related keywords, such as `Table Should Contain`, work differently. By
default, when a table locator value is provided, it will search for a table
with the specified id attribute.<br>
<br>
Example:<br>
<table border="1" cellspacing="0" summary="">
<tr>
<td>Table Should Contain</td>
<td>my_table</td>
<td>text</td>
</tr>
</table>
<br>
More complex table locator strategies:
<table border="1" cellspacing="0" summary="">
<tr>
<td><b>Strategy</b></td>
<td><b>Example</b></td>
<td><b>Description</b></td>
</tr>
<tr>
<td>xpath</td>
<td>Table Should Contain | xpath=//table/[@name="my_table"] | text</td>
<td>Matches by arbitrary XPath expression</td>
</tr>
<tr>
<td>css</td>
<td>Table Should Contain | css=table.my_class | text</td>
<td>Matches by CSS selector</td>
</tr>
</table>
<br>
<b>Custom location strategies</b><br>
It is also possible to register custom location strategies. See `Add Location
Strategy` for details about custom location strategies.<br>
<br>
Example:
<table border="1" cellspacing="0" summary="">
<tr>
<td>Add Location Strategy</td>
<td>custom</td>
<td>return window.document.getElementById(arguments[0]);</td>
</tr>
<tr>
<td>Input Text</td>
<td>custom=firstName</td>
<td>Max</td>
</tr>
</table>
<br>
<span style="font-size: 120%;"><b>Timeouts</b></span><br>
There are several Wait ... keywords that take <b>timeout</b> as an argument.
All of these timeout arguments are optional. The timeout used by all of them
can be set globally using the `Set Selenium Timeout keyword`.<br>
<br>
All timeouts can be given as numbers considered seconds (e.g. 0.5 or 42) or
in Robot Framework's time syntax (e.g. '1.5 seconds' or '1 min 30 s'). See <a
href=
"http://robotframework.googlecode.com/svn/trunk/doc/userguide/RobotFrameworkUserGuide.html#time-format"
>Time Format</a> for details about the time syntax.<br>
<br>
<span style="font-size: 120%;"><b>Log Level</b></span><br>
There are several keywords that take <b>timeout</b> as an argument. All of
these timeout arguments are optional. The default is usually INFO.<br>
<br>
List of log levels:
<table border="1" cellspacing="0" summary="">
<tr>
<td><b>Log Level</b></td>
<td><b>Description</b></td>
</tr>
<tr>
<td>DEBUG</td>
<td></td>
</tr>
<tr>
<td>INFO</td>
<td></td>
</tr>
<tr>
<td>HTML</td>
<td>Same as INFO, but message is in HTML format</td>
</tr>
<tr>
<td>TRACE</td>
<td></td>
</tr>
<tr>
<td>WARN</td>
<td></td>
</tr>
</table>
arg1=
arg2=
arg3=
Selenium2Library can be imported with optional arguments.<br>
<br>
<b>timeout</b> is the default timeout used to wait for all waiting
actions. It can be changed later with `Set Selenium Timeout`.<br>
<br>
<b>implicitWait</b> is the implicit timeout that Selenium waits, when
looking for elements. It can be changed later with `Set Selenium Implicit
Wait`. See <a
href="http://docs.seleniumhq.org/docs/04_webdriver_advanced.jsp"
>WebDriver: Advanced Usage</a> of the SeleniumHQ documentation for
details about WebDriver's implicit wait functionality.<br>
<br>
<b>runOnFailure</b> specifies the name of a keyword (from any available
libraries) to execute when a Selenium2Library keyword fails. By default
`Capture Page Screenshot` will be used to take a screenshot of the
current page. Using the value \"Nothing\" will disable this feature
altogether. See `Register Keyword To Run On Failure` keyword for details
about this functionality.<br>
<br>
Examples:
<table border="1" cellspacing="0" summary="">
<tr>
<td>Library</td>
<td>Selenium2Library</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>Library</td>
<td>Selenium2Library</td>
<td>15</td>
<td></td>
<td></td>
<td># Sets timeout to 15 seconds</td>
</tr>
<tr>
<td>Library</td>
<td>Selenium2Library</td>
<td>0</td>
<td>5</td>
<td></td>
<td># Sets timeout to 0 seconds and implicitWait to 5 seconds</td>
</tr>
<tr>
<td>Library</td>
<td>Selenium2Library</td>
<td>0</td>
<td>5</td>
<td>Log Source</td>
<td># Sets timeout to 0 seconds, implicitWait to 5 seconds and runs `Log
Source` on failure</td>
</tr>
<tr>
<td>Library</td>
<td>Selenium2Library</td>
<td>0</td>
<td>5</td>
<td>Nothing</td>
<td># Sets timeout to 0 seconds, implicitWait to 5 seconds and does
nothing on failure</td>
</tr>
</table>
name
value
path=NONE
domain=NONE
secure=NONE
expiry=NONE
Adds a cookie to your current session.<br><br><b>Parameters:</b><br> <b>name</b> The name of the cookie.<br> <b>value</b> The cookie value.<br> <b>path</b> Default=NONE. The path the cookie is visible to.<br> <b>domain</b> Default=NONE. The domain the cookie is visible to.<br> <b>secure</b> Default=NONE. Whether this cookie requires a secure
connection.<br> <b>expiry</b> Default=NONE. The cookie's expiration date<br>
strategyName
functionDefinition
delimiter=NONE
Registers a JavaScript function as locator with the specified strategy
name.<br>
<br>
The registered function has to return a WebElement, a List of WebElements
or null. Optionally a delimiter can be given to split the value of the
locator in multiple arguments when executing the JavaScript function. <br>
<br>
Example:
<table border="1" cellspacing="0" summary="">
<tr>
<td>Add Location Strategy</td>
<td>byId</td>
<td>return window.document.getElementById(arguments[0]);</td>
</tr>
<tr>
<td>Input Text</td>
<td>byId=firstName</td>
<td>Max</td>
</tr>
</table>
<br>
Example with delimiter:
<table border="1" cellspacing="0" summary="">
<tr>
<td>Add Location Strategy</td>
<td>byClassname</td>
<td>return
window.document.getElementsByClassName(arguments[0])[arguments[1]];</td>
<td>,</td>
</tr>
<tr>
<td>Input Text</td>
<td>byClassname=input,3</td>
<td>Max</td>
<td></td>
</tr>
</table><br><b>Parameters:</b><br> <b>strategyName</b> Name of the location strategy.<br> <b>functionDefinition</b> The JavaScript function to register.<br> <b>delimiter</b> Default=NONE. The delimiter to split the given locator value<br>
text=NONE
Verify an alert is present and dismiss it.<br>
<br>
If <b>text</b> is a non-empty string, then it is also verified that the
message of the alert equals to text.<br>
<br>
Will fail if no alert is present. Note that following keywords will fail
unless the alert is confirmed by this keyword or another like `Confirm
Action`.<br><br><b>Parameters:</b><br> <b>text</b> Default=NONE. The alert message to verify.<br>
locator
id
Assigns a temporary identifier to the element identified by
<b>locator</b><br>
<br>
This is mainly useful, when the locator is a complicated and slow XPath
expression. The identifier expires when the page is reloaded.<br>
<br>
Example:
<table border="1" cellspacing="0" summary="">
<tr>
<td>Assign ID to Element</td>
<td>xpath=//div[@id=\"first_div\"]</td>
<td>my id</td>
</tr>
<tr>
<td>Page Should Contain Element</td>
<td>my id</td>
<td></td>
</tr>
</table><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the element.<br> <b>id</b> The id to assign.<br>
filename=NONE
Take a screenshot of the current page and embed it into the log.<br>
<br>
The <b>filename</b> argument specifies the name of the file to write the
screenshot into. If no filename is given, the screenshot is saved into
file selenium-screenshot-<counter>.png under the directory where
the Robot Framework log file is written into. The filename is also
considered relative to the same directory, if it is not given in absolute
format.<br>
<br>
A CSS can be used to modify how the screenshot is taken. By default the
background color is changed to avoid possible problems with background
leaking when the page layout is somehow broken.<br><br><b>Parameters:</b><br> <b>filename</b> Default=NONE. Name of the file to write.<br>
locator
Verify the checkbox identified by <b>locator</b> is selected/checked.<br>
<br>
Key attributes for checkboxes are id and name. See `Introduction` for
details about locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the checkbox.<br>
locator
Verify the checkbox identified by <b>locator</b> is not selected/checked.<br>
<br>
Key attributes for checkboxes are id and name. See `Introduction` for
details about locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the checkbox.<br>
Cancel will as default be selected from now on every time a confirmation
dialog appears.<br>
<br>
Note that every time a confirmation comes up, it must be confirmed by the
keywords 'Alert Should Be Present' or `Confirm Action`. Otherwise all
following operations will fail.<br>
Cancel will be selected the next time a confirmation dialog appears.<br>
<br>
Note that every time a confirmation comes up, it must be confirmed by the
keywords 'Alert Should Be Present' or `Confirm Action`. Otherwise all
following operations will fail.<br>
locator
filePath
Types the given <b>filePath</b> into the input field identified by
<b>locator</b>.<br>
<br>
This keyword is most often used to input files into upload forms. The
file specified with filePath must be available on the same host where the
Selenium Server is running.<br>
<br>
Example:
<table border="1" cellspacing="0" summary="">
<tr>
<td>Choose File</td>
<td>my_upload_field</td>
<td>/home/user/files/trades.csv</td>
</tr>
</table>
Key attributes for input fields are id and name. See `Introduction` for
details about locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the input field.<br> <b>filePath</b> The file path to input<br>
Ok will as default be selected from now on every time a confirmation
dialog appears.<br>
<br>
Note that every time a confirmation comes up, it must be confirmed by the
keywords 'Alert Should Be Present' or `Confirm Action`. Otherwise all
following operations will fail.<br>
Ok will be selected the next time a confirmation dialog appears.<br>
<br>
Note that every time a confirmation comes up, it must be confirmed by the
keywords 'Alert Should Be Present' or `Confirm Action`. Otherwise all
following operations will fail.<br>
locator
Clears the text from element identified by <b>locator</b>.<br>
<br>
This keyword does not execute any checks on whether or not the clear
method has succeeded, so if any subsequent checks are needed, they should
be executed using method `Element Text Should Be`.<br>
<br>
Also, this method will use WebDriver's internal _element.clear()_ method,
i.e. it will not send any keypresses, and it will not have any effect
whatsoever on elements other than input textfields or input textareas.
Clients relying on keypresses should implement their own methods.<br>
<br>
Key attributes for arbitrary elements are id and name. See `Introduction`
for details about locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the element.<br>
locator
Click on the button identified by <b>locator</b>.<br>
<br>
Key attributes for buttons are id, name and value. See `Introduction` for
details about locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the link.<br>
locator
Click on the element identified by <b>locator</b>.<br>
<br>
Key attributes for arbitrary elements are id and name. See `Introduction`
for details about locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the element.<br>
locator
xOffset
yOffset
Click on the element identified by <b>locator</b> at the coordinates
<b>xOffset</b> and <b>yOffset</b>.<br>
<br>
The cursor is moved at the center of the element and the to the given x/y
offset from that point. Both offsets are specified as negative (left/up)
or positive (right/down) number.<br>
<br>
Key attributes for arbitrary elements are id and name. See `Introduction`
for details about locators.<br>
<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the element.<br> <b>xOffset</b> The horizontal offset in pixel. Negative means left, positive
right.<br> <b>yOffset</b> The vertical offset in pixel. Negative means up, positive
down.<br>
locator
Click on the image identified by <b>locator</b>.<br>
<br>
Key attributes for images are id, src and alt. See `Introduction` for
details about locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the element.<br>
locator
Click on the link identified by <b>locator</b>.<br>
<br>
Key attributes for links are id, name, href and link text. See
`Introduction` for details about locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the link.<br>
Closes all open browser instances and resets the browser cache.<br>
<br>
After this keyword new indexes returned from `Open Browser` keyword are
reset to 1. This keyword should be used in test or suite teardown to make
sure all browsers are closed.<br><br><b>See Also:</b><br> `Close Browser`<br> `Open Browser`<br> `Switch Browser`<br>
Closes the current browser instance.<br><br><b>See Also:</b><br> `Close All Browsers`<br> `Open Browser`<br> `Switch Browser`<br>
Closes the currently open pop-up window.
Dismisses currently shown confirmation dialog and returns its message.<br>
<br>
By default, this keyword chooses 'OK' option from the dialog. If 'Cancel'
needs to be chosen, keyword `Choose Cancel On Next Confirmation` must be
called before the action that causes the confirmation dialog to be shown.<br>
<br>
Example:
<table border="1" cellspacing="0" summary="">
<tr>
<td>Click Button</td>
<td>Send</td>
<td></td>
<td># Shows a confirmation dialog</td>
</tr>
<tr>
<td>${message}=</td>
<td>Confirm Action</td>
<td></td>
<td># Chooses Ok</td>
</tr>
<tr>
<td>Should Be Equal</td>
<td>${message}</td>
<td>Are your sure?</td>
<td># Check dialog message</td>
</tr>
<tr>
<td>Choose Cancel On Next Confirmation</td>
<td></td>
<td></td>
<td># Choose cancel on next `Confirm Action`</td>
</tr>
<tr>
<td>Click Button</td>
<td>Send</td>
<td></td>
<td># Shows a confirmation dialog</td>
</tr>
<tr>
<td>Confirm Action</td>
<td></td>
<td></td>
<td># Chooses Cancel</td>
</tr>
</table><br><b>Returns:</b><br> The dialog message.<br>
text
logLevel=INFO
Verify the current frame contains <b>text</b>.<br>
<br>
See `Introduction` for details about log levels.<br><br><b>Parameters:</b><br> <b>text</b> The text to verify.<br> <b>logLevel</b> Default=INFO. Optional log level.<br>
text
logLevel=INFO
Verify the current frame does not contain <b>text</b>.<br>
<br>
See `Introduction` for details about log levels.<br><br><b>Parameters:</b><br> <b>text</b> The text to verify.<br> <b>logLevel</b> Default=INFO. Optional log level.<br>
Deletes all cookies.<br>
name
Deletes cookie matching <b>name</b>.<br>
<br>
If the cookie is not found, nothing happens<br><br><b>Parameters:</b><br> <b>name</b> The name of the cookie to delete.<br>
locator
Double-Click on the element identified by <b>locator</b>.<br>
<br>
Key attributes for arbitrary elements are id and name. See `Introduction`
for details about locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the element.<br>
source
target
Drag the element identified by the locator <b>source</b> and move it on
top of the element identified by the locator <b>target</b>.<br>
<br>
Key attributes for arbitrary elements are id and name. See `Introduction`
for details about locators.<br>
<br>
Example:
<table border="1" cellspacing="0" summary="">
<tr>
<td>Drag And Drop</td>
<td>elem1</td>
<td>elem2</td>
<td># Move elem1 over elem2</td>
</tr>
</table><br><b>Parameters:</b><br> <b>source</b> The locator to locate the element to drag.<br> <b>target</b> The locator to locate the element where to drop the dragged
element.<br>
source
xOffset
yOffset
Drag the element identified by the locator <b>source</b> and move it by
<b>xOffset</b> and <b>yOffset</b>.<br>
<br>
Both offsets are specified as negative (left/up) or positive (right/down)
number.<br>
<br>
Key attributes for arbitrary elements are id and name. See `Introduction`
for details about locators.<br>
<br>
Example:
<table border="1" cellspacing="0" summary="">
<tr>
<td>Drag And Drop By Offset</td>
<td>elem1</td>
<td>50</td>
<td>35</td>
<td># Move elem1 50px right and 35px down.</td>
</tr>
</table><br><b>Parameters:</b><br> <b>source</b> The locator to locate the element to drag.<br> <b>xOffset</b> The horizontal offset in pixel. Negative means left, positive
right.<br> <b>yOffset</b> The vertical offset in pixel. Negative means up, positive
down.<br>
locator
message=NONE
Verify the element identified by <b>locator</b> is clickable.<br>
<br>
Key attributes for arbitrary elements are id and name. See `Introduction`
for details about locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the element.<br> <b>message</b> Default=NONE. Optional custom error message.<br>
locator
Verify the element identified by <b>locator</b> is disabled.<br>
<br>
Key attributes for arbitrary elements are id and name. See `Introduction`
for details about locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the element.<br>
locator
Verify the element identified by <b>locator</b> is enabled.<br>
<br>
Key attributes for arbitrary elements are id and name. See `Introduction`
for details about locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the element.<br>
locator
message=NONE
Verify the element identified by <b>locator</b> is selected.<br>
<br>
Key attributes for arbitrary elements are id and name. See `Introduction`
for details about locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the element.<br> <b>message</b> Default=NONE. Optional custom error message.<br>
locator
message=NONE
Verify the element identified by <b>locator</b> is visible.<br>
<br>
Herein, visible means that the element is logically visible, not
optically visible in the current browser viewport. For example, an
element that carries display:none is not logically visible, so using this
keyword on that element would fail.<br>
<br>
Key attributes for arbitrary elements are id and name. See `Introduction`
for details about locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the element.<br> <b>message</b> Default=NONE. Optional custom error message.<br>
locator
text
message=NONE
Verify the element identified by <b>locator</b> contains <b>text</b>.<br>
<br>
See `Introduction` for details about locators.<br><b>Parameters:</b><br> <b>locator</b> The locator to locate the element.<br> <b>text</b> The text to verify.<br> <b>message</b> Default=NONE. Optional custom error message.<br>
locator
message=NONE
Verify the element identified by <b>locator</b> is not clickable.<br>
<br>
Key attributes for arbitrary elements are id and name. See `Introduction`
for details about locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the element.<br> <b>message</b> Default=NONE. Optional custom error message.<br>
locator
message=NONE
Verify the element identified by <b>locator</b> is not selected.<br>
<br>
Key attributes for arbitrary elements are id and name. See `Introduction`
for details about locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the element.<br> <b>message</b> Default=NONE. Optional custom error message.<br>
locator
message=NONE
Verify the element identified by <b>locator</b> is not visible.<br>
<br>
Herein, visible means that the element is logically visible, not
optically visible in the current browser viewport. For example, an
element that carries display:none is not logically visible, so using this
keyword on that element would fail.<br>
<br>
Key attributes for arbitrary elements are id and name. See `Introduction`
for details about locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the element.<br> <b>message</b> Default=NONE. Optional custom error message.<br>
locator
text
message=NONE
Verify the element identified by <b>locator</b> does not contain
<b>text</b>.<br>
<br>
See `Introduction` for details about locators.<br><b>Parameters:</b><br> <b>locator</b> The locator to locate the element.<br> <b>text</b> The text to verify.<br> <b>message</b> Default=NONE. Optional custom error message.<br>
locator
text
message=NONE
Verify the text of the element identified by <b>locator</b> is exactly
<b>text</b>.<br>
<br>
In contrast to `Element Should Contain`, this keyword does not try a
substring match but an exact match on the element identified by locator.<br>
<br>
Key attributes for arbitrary elements are id and name. See `Introduction`
for details about locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the element.<br> <b>text</b> The text to verify.<br> <b>message</b> Default=NONE. Optional custom error message.<br>
locator
text
message=NONE
Verify the text of the element identified by <b>locator</b> is not
exactly <b>text</b>.<br>
<br>
In contrast to `Element Should Not Contain`, this keyword does not try a
substring match but an exact match on the element identified by locator.<br>
<br>
Key attributes for arbitrary elements are id and name. See `Introduction`
for details about locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the element.<br> <b>text</b> The text to verify.<br> <b>message</b> Default=NONE. Optional custom error message.<br>
*code
Execute the given JavaScript <b>code</b> asynchronously.<br>
<br>
The given code may contain multiple lines of code, but must contain a
return statement (with the value to be returned) at the end.<br>
<br>
The given code may be divided into multiple cells in the test data. In
that case, the parts are concatenated together without adding spaces. If
the given code is an absolute path to an existing file, the JavaScript to
execute will be read from that file. Forward slashes work as a path
separator on all operating systems.<br>
<br>
Note that by default the code will be executed in the context of the
Selenium object itself, so <b>this</b> will refer to the Selenium object.
Use <b>window</b> to refer to the window of your application, e.g.
<i>window.document.getElementById('foo')</i>.<br>
<br>
Example:
<table border="1" cellspacing="0" summary="">
<tr>
<td>Execute Async JavaScript</td>
<td>return window.my_js_function('arg1', 'arg2');</td>
<td># Directly execute the JavaScript</td>
</tr>
<tr>
<td>Execute Async JavaScript</td>
<td>${CURDIR}/js_to_execute.js</td>
<td># Load the JavaScript to execute from file</td>
</tr>
</table><br><b>Parameters:</b><br> <b>code</b> The JavaScript code or a file name.<br><br><b>Returns:</b><br> The return value of the executed code.<br>
*code
Execute the given JavaScript <b>code</b>.<br>
<br>
The given code may contain multiple lines of code, but must contain a
return statement (with the value to be returned) at the end.<br>
<br>
The given code may be divided into multiple cells in the test data. In
that case, the parts are concatenated together without adding spaces. If
the given code is an absolute path to an existing file, the JavaScript to
execute will be read from that file. Forward slashes work as a path
separator on all operating systems.<br>
<br>
Note that by default the code will be executed in the context of the
Selenium object itself, so <b>this</b> will refer to the Selenium object.
Use <b>window</b> to refer to the window of your application, e.g.
<i>window.document.getElementById('foo')</i>.<br>
<br>
Example:
<table border="1" cellspacing="0" summary="">
<tr>
<td>Execute JavaScript</td>
<td>return window.my_js_function('arg1', 'arg2');</td>
<td># Directly execute the JavaScript</td>
</tr>
<tr>
<td>Execute JavaScript</td>
<td>${CURDIR}/js_to_execute.js</td>
<td># Load the JavaScript to execute from file</td>
</tr>
</table><br><b>Parameters:</b><br> <b>code</b> The JavaScript code or a file name.<br><br><b>Returns:</b><br> The return value of the executed code.<br>
locator
Set the focus to the element identified by <b>locator</b>.<br>
<br>
Key attributes for arbitrary elements are id and name. See `Introduction`
for details about locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the element.<br>
locator
text
logLevel=INFO
Verify the frame identified by <b>locator</b> contains <b>text</b>.<br>
<br>
See `Introduction` for details about locators.<br><b>Parameters:</b><br> <b>locator</b> The locator to locate the frame.<br> <b>text</b> The text to verify.<br> <b>logLevel</b> Default=INFO. Optional log level.<br>
locator
text
logLevel=INFO
Verify the frame identified by <b>locator</b> does not contain
<b>text</b>.<br>
<br>
See `Introduction` for details about locators.<br><b>Parameters:</b><br> <b>locator</b> The locator to locate the frame.<br> <b>text</b> The text to verify.<br> <b>logLevel</b> Default=INFO. Optional log level.<br>
Returns the text of current JavaScript alert.<br>
<br>
This keyword will fail if no alert is present. Note that following
keywords will fail unless the alert is confirmed by the keywords 'Alert
Should Be Present' or `Confirm Action`.<br><b>Returns:</b><br> The alert message.<br>
Returns a list containing ids of all links found in current page.<br>
<br>
If a link has no id, an empty string will be in the list instead.<br><br><b>Returns:</b><br> The list of link ids.<br>
name
Returns value of cookie found with <b>name</b>.<br>
<br>
If no cookie is found with name, this keyword fails.<br><br><b>Parameters:</b><br> <b>name</b> The name of the cookie<br><br><b>Returns:</b><br> The value of the found cookie<br>
Returns all cookies of the current page.<br><br><b>Returns:</b><br> All cookies of the current page.<br>
attributeLocator
Returns the value of an element attribute.<br>
<br>
The <b>attribute_locator</b> consists of element locator followed by an @
sign and attribute name. Example: element_id@class<br>
<br>
Key attributes for arbitrary elements are id and name. See `Introduction`
for details about locators.<br><br><b>Parameters:</b><br> <b>attributeLocator</b> The attribute locator.<br><br><b>Returns:</b><br> The attribute value.<br>
locator
Returns horizontal position of element identified by <b>locator</b>.<br>
<br>
The position is returned in pixels off the left side of the page, as an
integer. Fails if the matching element is not found.<br>
<br>
Key attributes for arbitrary elements are id and name. See `Introduction`
for details about locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the element.<br><br><b>Returns:</b><br> The horizontal position<br>
locator
Returns the values in the select list identified by <b>locator</b>.<br>
<br>
Select list keywords work on both lists and combo boxes. Key attributes
for select lists are id and name. See `Introduction` for details about
locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the select list.<br><br><b>Returns:</b><br> The select list values<br>
Returns the current location.<br><b>Returns:</b><br> The current location.<br><br><b>See Also:</b><br> `Log Location`<br>
xpath
Returns the number of elements located the given <b>xpath</b>.<br>
<br>
If you wish to assert the number of located elements, use `Xpath Should
Match X Times`.<br><br><b>Parameters:</b><br> <b>xpath</b> The XPath to match page elements<br><br><b>Returns:</b><br> The number of located elements<br>
Returns the actually supported capabilities of the remote browser
instance.<br>
<br>
Not all server implementations will support every WebDriver feature.
Therefore, the client and server should use JSON objects with the
properties listed below when describing which features a user requests
that a session support. <b>If a session cannot support a capability that
is requested in the desired capabilities, no error is thrown;</b> a
read-only capabilities object is returned that indicates the capabilities
the session actually supports. For more information see: <a href=
"http://code.google.com/p/selenium/wiki/DesiredCapabilities"
>DesiredCapabilities</a><br><br><b>Returns:</b><br> The capabilities of the remote node.<br><br><b>See Also:</b><br> `Log Remote Capabilities`<br>
Returns the session id of the remote browser instance.<br><br><b>Returns:</b><br> The remote session id.<br><br><b>See Also:</b><br> `Log Remote Session Id`<br>
locator
Returns the visible label of the first selected element from the select
list identified by <b>locator</b>.<br>
<br>
Select list keywords work on both lists and combo boxes. Key attributes
for select lists are id and name. See `Introduction` for details about
locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the select list.<br><br><b>Returns:</b><br> The first visible select list label<br>
locator
Returns the visible labels of the first selected elements as a list from
the select list identified by <b>locator</b>.<br>
<br>
Fails if there is no selection.<br>
<br>
Select list keywords work on both lists and combo boxes. Key attributes
for select lists are id and name. See `Introduction` for details about
locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the select list.<br><br><b>Returns:</b><br> The list of visible select list labels<br>
locator
Returns the value of the first selected element from the select list
identified by <b>locator</b>.<br>
<br>
The return value is read from the value attribute of the selected
element.<br>
<br>
Select list keywords work on both lists and combo boxes. Key attributes
for select lists are id and name. See `Introduction` for details about
locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the select list.<br><br><b>Returns:</b><br> The first select list value<br>
locator
Returns the values of the first selected elements as a list from the
select list identified by <b>locator</b>.<br>
<br>
Fails if there is no selection. The return values are read from the value
attribute of the selected element.<br>
<br>
Select list keywords work on both lists and combo boxes. Key attributes
for select lists are id and name. See `Introduction` for details about
locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the select list.<br><br><b>Returns:</b><br> The list of select list values<br>
Returns the implicit wait time in seconds that is used by Selenium.<br><br><b>Returns:</b><br> The implicit wait time in seconds.<br><br><b>See Also:</b><br> `Set Selenium Implicit Wait`<br>
<b>(NOT IMPLEMENTED)</b> Returns the delay in seconds that is waited
after each Selenium command.<br><br><b>Returns:</b><br> The delay in seconds.<br><br><b>See Also:</b><br> `Set Selenium Speed`<br>
Returns the timeout in seconds that is used by various keywords.<br><br><b>Returns:</b><br> The timeout in seconds.<br><br><b>See Also:</b><br> `Set Selenium Timeout`<br>
Returns the entire HTML source of the current page or frame.<br><b>Returns:</b><br> The HTML source.<br><br><b>See Also:</b><br> `Log Source`<br>
Returns basic system information about the execution environment.<br><br><b>Returns:</b><br> System information.<br><br><b>See Also:</b><br> `Log System Info`<br>
tableLocator
row
column
logLevel=INFO
Returns the content of the table cell at the coordinates <b>row</b> and
<b>column</b> of the table identified by <b>tableLocator</b>.<br>
<br>
Row and column number start from 1. Header and footer rows are included
in the count. That way also cell content from header or footer rows can
be obtained with this keyword.<br>
<br>
Key attributes for tables are id and name. See `Introduction` for details
about locators and log levels.<br><br><b>Parameters:</b><br> <b>tableLocator</b> The locator to locate the table.<br> <b>row</b> The table row.<br> <b>column</b> The table column.<br> <b>logLevel</b> Default=INFO. Optional log level.<br><br><b>Returns:</b><br> The table cell content.<br>
locator
Returns the text of the element identified by <b>locator</b>.<br>
<br>
Key attributes for arbitrary elements are id and name. See `Introduction`
for details about locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the element.<br><br><b>Returns:</b><br> The text of the element.<br>
Returns the title of current page.<br><b>Returns:</b><br> The title.<br><br><b>See Also:</b><br> `Log Title`<br>
locator
Returns the value attribute of the element identified by <b>locator</b>.<br>
<br>
Key attributes for arbitrary elements are id and name. See `Introduction`
for details about locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the element.<br><br><b>Returns:</b><br> The value attribute of the element.<br>
locator
Returns vertical position of element identified by <b>locator</b>.<br>
<br>
The position is returned in pixels off the top of the page, as an
integer. Fails if the matching element is not found.<br>
<br>
Key attributes for arbitrary elements are id and name. See `Introduction`
for details about locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the element.<br><br><b>Returns:</b><br> The vertical position<br>
Returns the id attributes of all windows known to the current browser
instance.<br><br><b>Returns:</b><br> List of window id attributes<br><br><b>See Also:</b><br> `Log Window Identifiers`<br>
Returns the names of all windows known to the current browser instance.<br><br><b>Returns:</b><br> List of window names<br><br><b>See Also:</b><br> `Log Window Names`<br>
Returns the titles of all windows known to the current browser instance.<br><br><b>Returns:</b><br> List of window titles<br><br><b>See Also:</b><br> `Log Window Titles`<br>
Simulates the user clicking the "back" button on their browser.<br>
url
Navigates the active browser instance to the provided URL.<br><br><b>Parameters:</b><br> <b>url</b> The URL to open.<br>
locator
text
Types the given <b>text</b> into the password field identified by
<b>locator</b>.<br>
<br>
Key attributes for input fields are id and name. See `Introduction` for
details about locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the password field.<br> <b>text</b> The password to input<br>
locator
text
Types the given <b>text</b> into the text field identified by
<b>locator</b>.<br>
<br>
Key attributes for input fields are id and name. See `Introduction` for
details about locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the text field.<br> <b>text</b> The password to input<br>
locator
*items
Verify the selection of the select list identified by <b>locator</b>is
exactly <b>*items</b>.<br>
<br>
If you want to verify no option is selected, simply give no items.<br>
<br>
Select list keywords work on both lists and combo boxes. Key attributes
for select lists are id and name. See `Introduction` for details about
locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the select list.<br> <b>items</b> The list of items to verify<br>
locator
Verify the select list identified by <b>locator</b>has no selections.<br>
<br>
Select list keywords work on both lists and combo boxes. Key attributes
for select lists are id and name. See `Introduction` for details about
locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the select list.<br>
url
Verify the current page URL is exactly <b>url</b>.<br><br><b>Parameters:</b><br> <b>url</b> The URL to verify.<br><br><b>See Also:</b><br> `Location Should Contain`<br>
url
Verify the current page URL contains <b>url</b>.<br><br><b>Parameters:</b><br> <b>url</b> The URL to verify.<br><br><b>See Also:</b><br> `Location Should Be`<br>
logLevel=INFO
Logs and returns the location of the current browser instance.<br>
<br>
See `Introduction` for details about the <b>logLevel</b>.<br><br><b>Parameters:</b><br> <b>logLevel</b> Default=INFO. Optional log level.<br><br><b>Returns:</b><br> The current location.<br><br><b>See Also:</b><br> `Get Location`<br>
logLevel=INFO
Logs and returns the actually supported capabilities of the remote
browser instance.<br>
<br>
Not all server implementations will support every WebDriver feature.
Therefore, the client and server should use JSON objects with the
properties listed below when describing which features a user requests
that a session support. <b>If a session cannot support a capability that
is requested in the desired capabilities, no error is thrown;</b> a
read-only capabilities object is returned that indicates the capabilities
the session actually supports. For more information see: <a href=
"http://code.google.com/p/selenium/wiki/DesiredCapabilities"
>DesiredCapabilities</a><br>
<br>
See `Introduction` for details about the <b>logLevel</b>.<br><br><b>Parameters:</b><br> <b>logLevel</b> Default=INFO. Optional log level.<br><br><b>Returns:</b><br> The capabilities of the remote node.<br><br><b>See Also:</b><br> `Get Remote Capabilities`<br>
logLevel=INFO
Logs and returns the session id of the remote browser instance.<br>
<br>
See `Introduction` for details about the <b>logLevel</b>.<br><br><b>Parameters:</b><br> <b>logLevel</b> Default=INFO. Optional log level.<br><br><b>Returns:</b><br> The remote session id.<br><br><b>See Also:</b><br> `Get Remote Session Id`<br>
logLevel=INFO
Logs and returns the entire html source of the current page or frame.<br>
<br>
See `Introduction` for details about the <b>logLevel</b>.<br><br><b>Parameters:</b><br> <b>logLevel</b> Default=INFO. Optional log level.<br><br><b>Returns:</b><br> The entire html source.<br><br><b>See Also:</b><br> `Get Source`<br>
logLevel=INFO
Logs and returns basic system information about the execution
environment.<br>
<br>
See `Introduction` for details about the <b>logLevel</b>.<br><br><b>Parameters:</b><br> <b>logLevel</b> Default=INFO. Optional log level.<br><br><b>Returns:</b><br> System information.<br><br><b>See Also:</b><br> `Get System Info`<br>
logLevel=INFO
Logs and returns the title of current page.<br>
<br>
See `Introduction` for details about the <b>logLevel</b>.<br><br><b>Parameters:</b><br> <b>logLevel</b> Default=INFO. Optional log level.<br><br><b>Returns:</b><br> The page title.<br><br><b>See Also:</b><br> `Get Source`<br>
logLevel=INFO
Logs and returns the id attributes of all windows known to the current
browser instance.<br><br><b>Parameters:</b><br> <b>logLevel</b> Default=INFO. Optional log level.<br><br><b>Returns:</b><br> List of window id attributes.<br><br><b>See Also:</b><br> `Get Window Identifiers`<br>
logLevel=INFO
Logs and returns the names of all windows known to the current browser
instance.<br>
<br>
See `Introduction` for details about the <b>logLevel</b>.<br><br><b>Parameters:</b><br> <b>logLevel</b> Default=INFO. Optional log level.<br><br><b>Returns:</b><br> List of windows names.<br><br><b>See Also:</b><br> `Get Window Names`<br>
logLevel=INFO
Logs and returns the titles of all windows known to the current browser
instance.<br>
<br>
See `Introduction` for details about the <b>logLevel</b>.<br><br><b>Parameters:</b><br> <b>logLevel</b> Default=INFO. Optional log level.<br><br><b>Returns:</b><br> List of window titles.<br><br><b>See Also:</b><br> `Get Window Titles`<br>
Maximizes current browser window.<br>
locator
Simulates pressing the left mouse button on the element identified by
<b>locator</b>.<br>
<br>
The element is pressed without releasing the mouse button.<br>
<br>
Key attributes for arbitrary elements are id and name. See `Introduction`
for details about locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the element.<br><br><b>See Also:</b><br> `Mouse Down On Image`<br> `Mouse Down On Link`<br>
locator
Simulates pressing the left mouse button on the image identified by
<b>locator</b>.<br>
<br>
The element is pressed without releasing the mouse button.<br>
<br>
Key attributes for images are id, src and alt. See `Introduction` for
details about locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the element.<br><br><b>See Also:</b><br> `Mouse Down`<br> `Mouse Down On Link`<br>
locator
Simulates pressing the left mouse button on the link identified by
<b>locator</b>.<br>
<br>
The element is pressed without releasing the mouse button.<br>
<br>
Key attributes for links are id, name, href and link text. See
`Introduction` for details about locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the element.<br><br><b>See Also:</b><br> `Mouse Down`<br> `Mouse Down On Image`<br>
locator
Simulates moving the mouse away from the element identified by
<b>locator</b>.<br>
<br>
Key attributes for arbitrary elements are id and name. See `Introduction`
for details about locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the element.<br>
locator
Simulates moving the mouse over the element identified by <b>locator</b>.<br>
<br>
Key attributes for arbitrary elements are id and name. See `Introduction`
for details about locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the element.<br>
locator
Simulates releasing the left mouse button on the element identified by
<b>locator</b>.<br>
<br>
Key attributes for arbitrary elements are id and name. See `Introduction`
for details about locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the element.<br>
url
browserName=firefox
alias=NONE
remoteUrl=False
desiredCapabilities=NONE
browserOptions=NONE
Opens a new browser instance to given URL.<br>
<br>
Possible values for browser are as follows:
<table border="1" cellspacing="0" summary="">
<tr>
<td>firefox</td>
<td>FireFox</td>
</tr>
<tr>
<td>ff</td>
<td>FireFox</td>
</tr>
<tr>
<td>internetexplorer</td>
<td>Internet Explorer</td>
</tr>
<tr>
<td>ie</td>
<td>Internet Explorer</td>
</tr>
<tr>
<td>googlechrome</td>
<td>Google Chrome</td>
</tr>
<tr>
<td>gc</td>
<td>Google Chrome</td>
</tr>
<tr>
<td>chrome</td>
<td>Google Chrome</td>
</tr>
<tr>
<td>opera</td>
<td>Opera</td>
</tr>
<tr>
<td>phantomjs</td>
<td>PhantomJS</td>
</tr>
<tr>
<td>htmlunitwithjs</td>
<td>HTMLUnit with Javascipt support</td>
</tr>
<tr>
<td>safari</td>
<td>Safari</td>
</tr>
<tr>
<td>ipad</td>
<td>iPad</td>
</tr>
<tr>
<td>iphone</td>
<td>iPhone</td>
</tr>
<tr>
<td>android</td>
<td>Android</td>
</tr>
<tr>
<td>htmlunit</td>
<td>HTMLUnit</td>
</tr>
</table>
<br>
Returns the index of the newly created browser instance which can be used
later to switch back to it. Index starts from 1 and is reset back to it
when the `Close All Browsers` keyword is used.<br>
<br>
<b>DesiredCapabilities</b><br>
The DesiredCapabilities can be specified in a simple key:value format or
as a JSON object. With the JSON format more complex parameters, like the
proxy, can be configured.<br>
<br>
Example of desiredCapabilities as simple string:<br>
<table border="1" cellspacing="0" summary="">
<tr>
<td>platform:Windows 8,browserName:firefox,version:25</td>
</tr>
</table>
<br>
Example of desiredCapabilities as JSON object:<br>
<table border="1" cellspacing="0" summary="">
<tr>
<td>
{<br>
 "platform":"Windows 8",<br>
 "browserName":"firefox",<br>
 "version":"25",<br>
 "proxy":<br>
 {<br>
  "proxyType":"manual",<br>
  "httpProxy":"localhost:8118"<br>
 }<br>
}<br>
</td>
</tr>
</table>
<br>
<b>BrowserOptions</b><br>
The BrowserOptions can be specified as JSON object to set more complex
browser specific parameters. At the moment only the following browsers
with the listed options are implemented.<br>
<br>
Firefox:
<table border="1" cellspacing="0" summary="">
<tr>
<td>
{<br>
 "preferences":<br>
 {<br>
  "extensions.firebug.currentVersion":"1.8.1",<br>
  "extensions.firebug.addonBarOpened":true,<br>
  "extensions.firebug.enableSites":true<br>
 }<br>
 "extensions":<br>
 [<br>
  "firebug-1.8.1.xpi",<br>
  "modify_headers-0.7.1.1-fx.xpi"<br>
 ]<br>
}<br>
</td>
</tr>
</table>
<br>
<b>Internet Explorer</b><br>
Note, that you will encounter strange behavior, if you open multiple
Internet Explorer browser instances. That is also why `Switch Browser`
only works with one IE browser at most. For more information see: <a
href=
"http://selenium-grid.seleniumhq.org/faq.html#i_get_some_strange_errors_when_i_run_multiple_internet_explorer_instances_on_the_same_machine"
>Strange errors with multiple IE instances</a><br><br><b>Parameters:</b><br> <b>url</b> The URL to open in the newly created browser instance.<br> <b>browserName</b> Default=firefox. Optional name of the browser to start.<br> <b>alias</b> Default=NONE. Optional alias for the newly created browser
instance. The alias can be used later for switching between
browsers instances, just as returned index.<br> <b>remoteUrl</b> Default=False. Optional remote grid URL. When specified no
local WebDriver instance is created, but a network connection
to a Selenium 2 WebDriver Grid Hub at the given URL is opened.<br> <b>desiredCapabilities</b> Default=NONE. Optional desired capabilities of the newly
created remote browser instances can be specified in a simple
key1:val1,key2:val2 format or as a JSON object (see examples
above). Used to communicate to the remote grid, which kind of
browser, etc. should be used. For more information see: <a
href=
"http://code.google.com/p/selenium/wiki/DesiredCapabilities"
>DesiredCapabilities</a><br> <b>browserOptions</b> Default=NONE. Extended browser options as JSON structure.<br><br><b>Returns:</b><br> The index of the newly created browser instance.<br><br><b>See Also:</b><br> `Close All Browsers`<br> `Close Browser`<br> `Switch Browser`<br>
locator
Opens the context menu on the element identified by <b>locator</b>.<br>
<br>
Key attributes for arbitrary elements are id and name. See `Introduction`
for details about locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the element.<br>
text
logLevel=INFO
Verify the current page contains <b>text</b>.<br>
<br>
See `Introduction` for details about log levels.<br><br><b>Parameters:</b><br> <b>text</b> The text to verify.<br> <b>logLevel</b> Default=INFO. Optional log level.<br>
locator
message=NONE
logLevel=INFO
Verify the button identified by <b>locator</b> is found on the current
page.<br>
<br>
Key attributes for buttons are id, name and value. See `Introduction` for
details about log levels and locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the button.<br> <b>message</b> Default=NONE. Optional custom error message.<br> <b>logLevel</b> Default=INFO. Optional log level.<br>
locator
message=NONE
logLevel=INFO
Verify the checkbox identified by <b>locator</b> is found on the current
page.<br>
<br>
Key attributes for checkboxes are id and name. See `Introduction` for
details about log levels and locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the checkbox.<br> <b>message</b> Default=NONE. Optional custom error message.<br> <b>logLevel</b> Default=INFO. Optional log level.<br>
locator
message=NONE
logLevel=INFO
Verify the element identified by <b>locator</b> is found on the current
page.<br>
<br>
Key attributes for arbitrary elements are id and name. See `Introduction`
for details about log levels and locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the element.<br> <b>message</b> Default=NONE. Optional custom error message.<br> <b>logLevel</b> Default=INFO. Optional log level.<br>
locator
message=NONE
logLevel=INFO
Verify the image identified by <b>locator</b> is found on the current
page.<br>
<br>
Key attributes for images are id, src and alt. See `Introduction` for
details about log levels and locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the link.<br> <b>message</b> Default=NONE. Optional custom error message.<br> <b>logLevel</b> Default=INFO. Optional log level.<br>
locator
message=NONE
logLevel=INFO
Verify the link identified by <b>locator</b> is found on the current
page.<br>
<br>
Key attributes for links are id, name, href and link text. See
`Introduction` for details about log levels and locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the link.<br> <b>message</b> Default=NONE. Optional custom error message.<br> <b>logLevel</b> Default=INFO. Optional log level.<br>
locator
message=NONE
logLevel=INFO
Verify the select list identified by <b>locator</b> is found on the
current page.<br>
<br>
Select list keywords work on both lists and combo boxes. Key attributes
for select lists are id and name. See `Introduction` for details about
locators and log levels.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the select list.<br> <b>message</b> Default=NONE. Optional custom error message.<br> <b>logLevel</b> Default=INFO. Optional log level.<br>
locator
message=NONE
logLevel=INFO
Verify the radio button identified by <b>locator</b> is found on the
current page.<br>
<br>
Key attributes for radio buttons are id and name. See `Introduction` for
details about log levels and locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the radio button.<br> <b>message</b> Default=NONE. Optional custom error message.<br> <b>logLevel</b> Default=INFO. Optional log level.<br>
locator
message=NONE
logLevel=INFO
Verify the text field identified by <b>locator</b> is found on the
current page.<br>
<br>
Key attributes for text field are id and name. See `Introduction` for
details about log levels and locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the text field.<br> <b>message</b> Default=NONE. Optional custom error message.<br> <b>logLevel</b> Default=INFO. Optional log level.<br>
text
logLevel=INFO
Verify the current page does not contain <b>text</b>.<br>
<br>
See `Introduction` for details about log levels.<br><br><b>Parameters:</b><br> <b>text</b> The text to verify.<br> <b>logLevel</b> Default=INFO. Optional log level.<br>
locator
message=NONE
logLevel=INFO
Verify the button identified by <b>locator</b> is not found on the
current page.<br>
<br>
Key attributes for buttons are id, name and value. See `Introduction` for
details about log levels and locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the button.<br> <b>message</b> Default=NONE. Optional custom error message.<br> <b>logLevel</b> Default=INFO. Optional log level.<br>
locator
message=NONE
logLevel=INFO
Verify the checkbox identified by <b>locator</b> is not found on the
current page.<br>
<br>
Key attributes for checkboxes are id and name. See `Introduction` for
details about log levels and locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the checkbox.<br> <b>message</b> Default=NONE. Optional custom error message.<br> <b>logLevel</b> Default=INFO. Optional log level.<br>
locator
message=NONE
logLevel=INFO
Verify the element identified by <b>locator</b> is not found on the
current page.<br>
<br>
Key attributes for arbitrary elements are id and name. See `Introduction`
for details about log levels and locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the element.<br> <b>message</b> Default=NONE. Optional custom error message.<br> <b>logLevel</b> Default=INFO. Optional log level.<br>
locator
message=NONE
logLevel=INFO
Verify the image identified by <b>locator</b> is not found on the current
page.<br>
<br>
Key attributes for images are id, src and alt. See `Introduction` for
details about log levels and locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the link.<br> <b>message</b> Default=NONE. Optional custom error message.<br> <b>logLevel</b> Default=INFO. Optional log level.<br>
locator
message=NONE
logLevel=INFO
Verify the link identified by <b>locator</b> is not found on the current
page.<br>
<br>
Key attributes for links are id, name, href and link text. See
`Introduction` for details about log levels and locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the link.<br> <b>message</b> Default=NONE. Optional custom error message.<br> <b>logLevel</b> Default=INFO. Optional log level.<br>
locator
message=NONE
logLevel=INFO
Verify the select list identified by <b>locator</b> is not found on the
current page.<br>
<br>
Select list keywords work on both lists and combo boxes. Key attributes
for select lists are id and name. See `Introduction` for details about
locators and log levels.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the select list.<br> <b>message</b> Default=NONE. Optional custom error message.<br> <b>logLevel</b> Default=INFO. Optional log level.<br>
locator
message=NONE
logLevel=INFO
Verify the radio button identified by <b>locator</b> is not found on the
current page.<br>
<br>
Key attributes for radio buttons are id and name. See `Introduction` for
details about log levels and locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the radio button.<br> <b>message</b> Default=NONE. Optional custom error message.<br> <b>logLevel</b> Default=INFO. Optional log level.<br>
locator
message=NONE
logLevel=INFO
Verify the text field identified by <b>locator</b> is not found on the
current page.<br>
<br>
Key attributes for text field are id and name. See `Introduction` for
details about log levels and locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the text field.<br> <b>message</b> Default=NONE. Optional custom error message.<br> <b>logLevel</b> Default=INFO. Optional log level.<br>
locator
key
Simulates pressing <b>key</b> on the element identified by
<b>locator</b>.<br>
<br>
Key is either a single character, or a numerical ASCII code of the key
lead by '\\'.<br>
<br>
Key attributes for arbitrary elements are id and name. See `Introduction`
for details about locators.<br>
<br>
Example:
<table border="1" cellspacing="0" summary="">
<tr>
<td>Press Key</td>
<td>text_field</td>
<td>q</td>
<td># Press 'q'</td>
</tr>
<tr>
<td>Press Key</td>
<td>login_button</td>
<td>\\13</td>
<td># ASCII code for enter key</td>
</tr>
</table><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the element.<br> <b>key</b> The key to press.<br>
groupName
value
Verify the radio button group identified by <b>groupName</b> has its
selection set to <b>value</b>.<br>
<br>
See `Select Radio Button` for details about locating radio buttons.<br><br><b>Parameters:</b><br> <b>groupName</b> The radio button group name.<br> <b>value</b> The expected value.<br>
groupName
Verify the radio button group identified by <b>groupName</b> has no
selection.<br>
<br>
See `Select Radio Button` for details about locating radio buttons.<br><br><b>Parameters:</b><br> <b>groupName</b> The radio button group name.<br>
keyword
Sets the actual and returns the previous keyword to execute when a
Selenium2Library keyword fails.<br>
<br>
The <b>keyword</b> is the name of a keyword (from any available
libraries) that will be executed, if a Selenium2Library keyword fails. It
is not possible to use a keyword that requires arguments. Using the value
<b>Nothing</b> will disable this feature altogether.<br>
<br>
The initial keyword to use is set at importing the library and the
keyword that is used by default is `Capture Page Screenshot`. Taking a
screenshot when something failed is a very useful feature, but notice
that it can slow down the execution.<br>
<br>
This keyword returns the name of the previously registered failure
keyword. It can be used to restore the original value later.<br>
<br>
Example:
<table border="1" cellspacing="0" summary="">
<tr>
<td>Register Keyword To Run On Failure</td>
<td>Log Source</td>
<td></td>
<td># Run `Log Source` on failure.</td>
</tr>
<tr>
<td>${previous kw}=</td>
<td>Register Keyword To Run On Failure</td>
<td>Nothing</td>
<td># Disable run-on-failure functionality and stors the previous kw name
in a variable.</td>
</tr>
<tr>
<td>Register Keyword To Run On Failure</td>
<td>${previous kw}</td>
<td></td>
<td># Restore to the previous keyword.</td>
</tr>
</table><br><b>Parameters:</b><br> <b>keyword</b> The keyword to execute on failure<br><br><b>Returns:</b><br> The previous keyword<br>
Simulates user reloading page.<br>
locator
Select all values of the multi-select list identified by <b>locator</b>.<br>
<br>
Select list keywords work on both lists and combo boxes. Key attributes
for select lists are id and name. See `Introduction` for details about
locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the multi-select list.<br>
locator
Select the checkbox identified by <b>locator</b>.<br>
<br>
Does nothing, if the checkbox is already selected.<br>
<br>
Key attributes for checkboxes are id and name. See `Introduction` for
details about locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the checkbox.<br>
locator
Selects the frame identified by <b>locator</b> as current frame.<br>
<br>
Key attributes for frames are <b>id</b> and <b>name</b>. See
`Introduction` for details about locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the frame<br>
locator
*items
Select the given <b>*items</b> of the multi-select list identified by
<b>locator</b>.<br>
<br>
An exception is raised for a single-selection list if the last value does
not exist in the list and a warning for all other non-existing items. For
a multi-selection list, an exception is raised for any and all
non-existing values.<br>
<br>
Select list keywords work on both lists and combo boxes. Key attributes
for select lists are id and name. See `Introduction` for details about
locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the multi-select list.<br> <b>items</b> The list of items to select<br>
locator
*indexes
Select the given <b>*indexes</b> of the multi-select list identified by
<b>locator</b>.<br>
<br>
Tries to select by value AND by label. It's generally faster to use 'by
index/value/label' keywords.<br>
<br>
Select list keywords work on both lists and combo boxes. Key attributes
for select lists are id and name. See `Introduction` for details about
locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the multi-select list.<br> <b>indexes</b> The list of indexes to select<br>
locator
*labels
Select the given <b>*labels</b> of the multi-select list identified by
<b>locator</b>.<br>
<br>
Select list keywords work on both lists and combo boxes. Key attributes
for select lists are id and name. See `Introduction` for details about
locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the multi-select list.<br> <b>labels</b> The list of labels to select<br>
locator
*values
Select the given <b>*values</b> of the multi-select list identified by
<b>locator</b>.<br>
<br>
Select list keywords work on both lists and combo boxes. Key attributes
for select lists are id and name. See `Introduction` for details about
locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the multi-select list.<br> <b>values</b> The list of values to select<br>
groupName
value
Sets the selection of the radio button group identified by
<b>groupName</b> to <b>value</b>.<br>
<br>
Example:
<table border="1" cellspacing="0" summary="">
<tr>
<td>Select Radio Button</td>
<td>size</td>
<td>XL</td>
<td># Matches HTML like <input type="radio" name="size"
value="XL">XL</input></td>
</tr>
<tr>
<td>Select Radio Button</td>
<td>size</td>
<td>sizeXL</td>
<td># Matches HTML like <input type="radio" name="size" value="XL"
id="sizeXL">XL</input></td>
</tr>
</table><br><b>Parameters:</b><br> <b>groupName</b> The radio button group name.<br> <b>value</b> The value or id attribute of the radio button to set.<br>
locator=NONE
Selects the window identified by <b>locator</b> as the context of
actions.<br>
<br>
If the window is found, all subsequent commands use that window, until
this keyword is used again. If the window is not found, this keyword
fails.<br>
<br>
By default, when a locator value is provided, it is matched against the
title of the window and the javascript name of the window. If multiple
windows with same identifier are found, the first one is selected.<br>
<br>
The special locator main (default) can be used to select the main window.<br>
<br>
Example:
<table border="1" cellspacing="0" summary="">
<tr>
<td>Click Link</td>
<td>popup_link</td>
<td># opens new window</td>
</tr>
<tr>
<td>Select Window</td>
<td>popupName</td>
<td></td>
</tr>
<tr>
<td>Title Should Be</td>
<td>Popup Title</td>
<td></td>
</tr>
<tr>
<td>Select Window</td>
<td></td>
<td># Chooses the main window again</td>
</tr>
</table>
<br>
It is also possible to specify the approach Selenium2Library should take
to find a window by specifying a locator strategy. See `Introduction` for
details about locators:
<table border="1" cellspacing="0" summary="">
<tr>
<td><b>Strategy</b></td>
<td><b>Example</b></td>
<td><b>Description</b></td>
</tr>
<tr>
<td>title</td>
<td>Select Window | title=My Document</td>
<td>Matches by window title</td>
</tr>
<tr>
<td>name</td>
<td>Select Window | name=${name}</td>
<td>Matches by window javascript name</td>
</tr>
<tr>
<td>url</td>
<td>Select Window | url=http://google.com</td>
<td>Matches by window's current URL</td>
</tr>
</table><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the window<br>
timestr
Sets and returns the implicit wait time in seconds that is used by the
current Selenium 2 WebDriver instance.<br>
<br>
From selenium 2 function: <i>Sets a sticky timeout to implicitly wait for
an element to be found, or a command to complete. This method only needs
to be called one time per session.</i><br>
<br>
Example:
<table border="1" cellspacing="0" summary="">
<tr>
<td>${orig wait} =</td>
<td>Set Browser Implicit Wait</td>
<td>10 seconds</td>
</tr>
<tr>
<td># Perform AJAX call that is slow</td>
<td></td>
<td></td>
</tr>
<tr>
<td>Set Browser Implicit Wait</td>
<td>${orig wait}</td>
<td># Reset to old value</td>
</tr>
</table><br><b>Parameters:</b><br> <b>timestr</b> The implicit wait time in seconds.<br><br><b>Returns:</b><br> The previous implicit wait time in seconds.<br><br><b>See Also:</b><br> `Set Selenium Implicit Wait`<br>
logDirectory
Set the <b>logDirectory</b>, where captured screenshots are stored, to
some custom path.<br>
<br>
Fails, if either the given path does not exist, is no directory or is not
writable.<br><br><b>Parameters:</b><br> <b>logDirectory</b> The directory to log to.<br>
host
port
username=NONE
password=NONE
domain=NONE
workstation=NONE
Configures proxy handling for remote WebDriver instances.<br>
<br>
This is needed to connect to an external Selenium 2 WebDriver rid through
a local HTTP proxy. This implementation handles BASIC, DIGEST and NTLM
based authentication schemes correctly.<br>
<br>
The given configuration will be used for all subsequent calls of `Open
Browser`. To remove the proxy call:<br>
Set Remote Web Driver Proxy | ${EMPTY} | ${EMPTY}<br>
<br>
Some additional info:
<ul>
<li>If no <b>username</b> is provided, it looks for a username at the
Java property http.proxyUser and the environment variables HTTP_PROXY and
http_proxy. If a username is found, it is only used, if the host and port
also match.</li>
<li>If no <b>password</b> is provided, it looks for a password at the
Java property http.proxyUser and the environment variables HTTP_PROXY and
http_proxy. If a password is found, it is only used, if the host, port
and username also match.</li>
<li>If a <b>domain</b> is provided, NTLM based authentication is used</li>
<li>If no <b>workstation</b> is provided and NTLM based authentication is
used, the hostname is used as workstation name.</li>
</ul><br><b>Parameters:</b><br> <b>host</b> The hostname of the proxy<br> <b>port</b> The port of the proxy<br> <b>username</b> Default=NONE. The usename<br> <b>password</b> Default=NONE. The password of the user<br> <b>domain</b> Default=NONE. The NTLM domain name<br> <b>workstation</b> Default=NONE. The name of the workstation<br>
timestr
Sets and returns the implicit wait time in seconds that is used by all
Selenium 2 WebDriver instances. This affects all currently open and from
now on opened instances.<br>
<br>
From selenium 2 function: <i>Sets a sticky timeout to implicitly wait for
an element to be found, or a command to complete. This method only needs
to be called one time per session.</i><br>
<br>
Example:
<table border="1" cellspacing="0" summary="">
<tr>
<td>${orig wait} =</td>
<td>Set Selenium Implicit Wait</td>
<td>10 seconds</td>
</tr>
<tr>
<td># Perform AJAX call that is slow</td>
<td></td>
<td></td>
</tr>
<tr>
<td>Set Selenium Implicit Wait</td>
<td>${orig wait}</td>
<td># Reset to old value</td>
</tr>
</table><br><b>Parameters:</b><br> <b>timestr</b> The implicit wait time in seconds.<br><br><b>Returns:</b><br> The previous implicit wait time in seconds.<br><br><b>See Also:</b><br> `Set Browser Implicit Wait`<br> `Get Selenium Implicit Wait`<br>
timestr
<b>(NOT IMPLEMENTED)</b> Sets and returns the delay in seconds that is
waited after each Selenium command.<br><br><b>Parameters:</b><br> <b>timestr</b> The delay in seconds.<br><br><b>Returns:</b><br> The previous delay in seconds.<br><br><b>See Also:</b><br> `Get Selenium Speed`<br>
timestr
Sets and returns the timeout in seconds that is used by various keywords.<br>
<br>
There are several Wait ... keywords that take a timeout as an argument.
All of these timeout arguments are optional. The timeout used by all of
them can be set globally using this keyword. See `Introduction` for more
information about timeouts.<br>
<br>
The previous timeout value is returned by this keyword and can be used to
set the old value back later. The default timeout is 5 seconds, but it
can be altered in importing the library.<br>
<br>
Example:
<table border="1" cellspacing="0" summary="">
<tr>
<td>${orig timeout} =</td>
<td>Set Selenium Timeout</td>
<td>15 seconds</td>
</tr>
<tr>
<td># Open page that loads slowly</td>
<td></td>
<td></td>
</tr>
<tr>
<td>Set Selenium Timeout</td>
<td>${orig timeout}</td>
<td># Reset to old value</td>
</tr>
</table><br><b>Parameters:</b><br> <b>timestr</b> The timeout in seconds.<br><br><b>Returns:</b><br> The previous timeout in seconds.<br><br><b>See Also:</b><br> `Get Selenium Timeout`<br>
width
height
Sets the <b>width</b> and <b>height</b> of the current window to the
specified values.<br>
<br>
Example:
<table border="1" cellspacing="0" summary="">
<tr>
<td>Set Window Size</td>
<td>800</td>
<td>600</td>
</tr>
<tr>
<td>${width}</td>
<td>${height}=</td>
<td>Get Window Size</td>
</tr>
<tr>
<td>Should Be Equal</td>
<td>${width}</td>
<td>800</td>
</tr>
<tr>
<td>Should Be Equal</td>
<td>${height}</td>
<td>600</td>
</tr>
</table><br><b>Parameters:</b><br> <b>width</b> The window width to set in px.<br> <b>height</b> The window height to set in px.<br>
locator
event
Simulates the given <b>event</b> on the element identified by
<b>locator</b>.<br>
<br>
This keyword is especially useful, when the element has an OnEvent
handler that needs to be explicitly invoked.<br>
<br>
Key attributes for arbitrary elements are id and name. See `Introduction`
for details about locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the element.<br> <b>event</b> The event to invoke.<br>
locator=NONE
Submit the form identified by <b>locator</b>.<br>
<br>
If the locator is empty, the first form in the page will be submitted.<br>
<br>
Key attributes for forms are id and name. See `Introduction` for details
about locators.<br><br><b>Parameters:</b><br> <b>locator</b> Default=NONE. The locator to locate the form.<br>
indexOrAlias
"Switches between active browser instances using an <b>index</b> or an
<b>alias</b>.<br>
<br>
The index is returned from `Open Browser` and an alias can be given to
it.<br>
<br>
Example:
<table border="1" cellspacing="0" summary="">
<tr>
<td>Open Browser</td>
<td>http://google.com</td>
<td>ff</td>
<td></td>
</tr>
<tr>
<td>Location Should Be</td>
<td>http://google.com</td>
<td></td>
<td></td>
</tr>
<tr>
<td>Open Browser</td>
<td>http://yahoo.com</td>
<td>ie</td>
<td>2nd conn</td>
</tr>
<tr>
<td>Location Should Be</td>
<td>http://yahoo.com</td>
<td></td>
<td></td>
</tr>
<tr>
<td>Switch Browser</td>
<td>1</td>
<td># index</td>
<td></td>
</tr>
<tr>
<td>Page Should Contain</td>
<td>I'm feeling lucky</td>
<td></td>
<td></td>
</tr>
<tr>
<td>Switch Browser</td>
<td>2nd conn</td>
<td># alias</td>
<td></td>
</tr>
<tr>
<td>Page Should Contain</td>
<td>More Yahoo!</td>
<td></td>
<td></td>
</tr>
<tr>
<td>Close All Browsers</td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
<br>
The above example expects that there was no other open browsers when
opening the first one because it used index '1' when switching to it
later. If you aren't sure about that you can store the index into a
variable as below.
<table border="1" cellspacing="0" summary="">
<tr>
<td>${id} =</td>
<td>Open Browser</td>
<td>http://google.com</td>
</tr>
<tr>
<td># Do something ...</td>
<td></td>
<td></td>
</tr>
<tr>
<td>Switch Browser</td>
<td>${id}</td>
<td></td>
</tr>
</table><br><b>Parameters:</b><br> <b>indexOrAlias</b> the index or alias of the browser instance to switch to<br><br><b>See Also:</b><br> `Close All Browsers`<br> `Close Browser`<br> `Open Browser`<br>
tableLocator
row
column
text
logLevel=INFO
Verify the content of the table cell at the coordinates <b>row</b> and
<b>column</b> of the table identified by <b>tableLocator</b> contains
<b>text</b>.<br>
<br>
Row and column number start from 1. Header and footer rows are included
in the count. That way also cell content from header or footer rows can
be obtained with this keyword.<br>
<br>
Key attributes for tables are id and name. See `Introduction` for details
about locators and log levels.<br><br><b>Parameters:</b><br> <b>tableLocator</b> The locator to locate the table.<br> <b>row</b> The table row.<br> <b>column</b> The table column.<br> <b>text</b> The text to verify.<br> <b>logLevel</b> Default=INFO. Optional log level.<br>
tableLocator
col
text
logLevel=INFO
Verify the content of any table cells of the table <b>column</b> of the
table identified by <b>tableLocator</b> contains <b>text</b>.<br>
<br>
Key attributes for tables are id and name. See `Introduction` for details
about locators and log levels.<br>
<br>
The first leftmost column is column number 1. If the table contains cells
that span multiple columns, those merged cells count as a single column.
For example both tests below work, if in one row columns A and B are
merged with colspan="2", and the logical third column contains "C".<br>
<br>
Example:
<table border="1" cellspacing="0" summary="">
<tr>
<td>Table Column Should Contain</td>
<td>tableId</td>
<td>3</td>
<td>C</td>
</tr>
<tr>
<td>Table Column Should Contain</td>
<td>tableId</td>
<td>2</td>
<td>C</td>
</tr>
</table><br><b>Parameters:</b><br> <b>tableLocator</b> The locator to locate the table.<br> <b>col</b> The table column.<br> <b>text</b> The text to verify.<br> <b>logLevel</b> Default=INFO. Optional log level.<br>
tableLocator
text
logLevel=INFO
Verify the content of any table footer cells of the table identified by
<b>tableLocator</b> contains <b>text</b>.<br>
<br>
Key attributes for tables are id and name. See `Introduction` for details
about locators and log levels.<br><br><b>Parameters:</b><br> <b>tableLocator</b> The locator to locate the table.<br> <b>text</b> The text to verify.<br> <b>logLevel</b> Default=INFO. Optional log level.<br>
tableLocator
text
logLevel=INFO
Verify the content of any table header cells of the table identified by
<b>tableLocator</b> contains <b>text</b>.<br>
<br>
Key attributes for tables are id and name. See `Introduction` for details
about locators and log levels.<br><br><b>Parameters:</b><br> <b>tableLocator</b> The locator to locate the table.<br> <b>text</b> The text to verify.<br> <b>logLevel</b> Default=INFO. Optional log level.<br>
tableLocator
row
text
logLevel=INFO
Verify the content of any table cells of the table <b>row</b> of the
table identified by <b>tableLocator</b> contains <b>text</b>.<br>
<br>
Key attributes for tables are id and name. See `Introduction` for details
about locators and log levels.<br>
<br>
The uppermost row is row number 1. For tables that are structured with
thead, tbody and tfoot, only the tbody section is searched. Please use
Table Header Should Contain or Table Footer Should Contain for tests
against the header or footer content.<br>
<br>
If the table contains cells that span multiple rows, a match only occurs
for the uppermost row of those merged cells.<br><br><b>Parameters:</b><br> <b>tableLocator</b> The locator to locate the table.<br> <b>row</b> The table row.<br> <b>text</b> The text to verify.<br> <b>logLevel</b> Default=INFO. Optional log level.<br>
tableLocator
text
logLevel=INFO
Verify the content of any table cells of the table identified by
<b>tableLocator</b> contains <b>text</b>.<br>
<br>
Key attributes for tables are id and name. See `Introduction` for details
about locators and log levels.<br><br><b>Parameters:</b><br> <b>tableLocator</b> The locator to locate the table.<br> <b>text</b> The text to verify.<br> <b>logLevel</b> Default=INFO. Optional log level.<br>
locator
text
message=NONE
Verify the text area identified by <b>locator</b> contains <b>text</b>.<br>
<br>
Key attributes for text areas are id and name. See `Introduction` for
details about log levels and locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the text area.<br> <b>text</b> The text to verify.<br> <b>message</b> Default=NONE. Optional custom error message.<br><br><b>See Also:</b><br> `Textarea Should Not Contain`<br> `Textarea Value Should Be`<br> `Textarea Value Should Not Be`<br>
locator
text
message=NONE
Verify the text area identified by <b>locator</b> does not contain <b>text</b>.<br>
<br>
Key attributes for text areas are id and name. See `Introduction` for
details about log levels and locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the text area.<br> <b>text</b> The text to verify.<br> <b>message</b> Default=NONE. Optional custom error message.<br><br><b>See Also:</b><br> `Textarea Should Contain`<br> `Textarea Value Should Be`<br> `Textarea Value Should Not Be`<br>
locator
text
message=NONE
Verify the text area identified by <b>locator</b> is exactly
<b>text</b>.<br>
<br>
Key attributes for text area are id and name. See `Introduction` for
details about log levels and locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the text area.<br> <b>text</b> The text to verify.<br> <b>message</b> Default=NONE. Optional custom error message.<br><br><b>See Also:</b><br> `Textarea Should Contain`<br> `Textarea Should Not Contain`<br> `Textarea Value Should Not Be`<br>
locator
text
message=NONE
Verify the text area identified by <b>locator</b> is not exactly
<b>text</b>.<br>
<br>
Key attributes for text area are id and name. See `Introduction` for
details about log levels and locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the text area.<br> <b>text</b> The text to verify.<br> <b>message</b> Default=NONE. Optional custom error message.<br><br><b>See Also:</b><br> `Textarea Should Contain`<br> `Textarea Should Not Contain`<br> `Textarea Value Should Be`<br>
locator
text
message=NONE
Verify the text field identified by <b>locator</b> contains <b>text</b>.<br>
<br>
Key attributes for text field are id and name. See `Introduction` for
details about log levels and locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the text field.<br> <b>text</b> The text to verify.<br> <b>message</b> Default=NONE. Optional custom error message.<br><br><b>See Also:</b><br> `Textfield Should Not Contain`<br> `Textfield Value Should Be`<br> `Textfield Value Should Not Be`<br>
locator
text
message=NONE
Verify the text field identified by <b>locator</b> does not contain
<b>text</b>.<br>
<br>
Key attributes for text field are id and name. See `Introduction` for
details about log levels and locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the text field.<br> <b>text</b> The text to verify.<br> <b>message</b> Default=NONE. Optional custom error message.<br><br><b>See Also:</b><br> `Textfield Should Contain`<br> `Textfield Value Should Be`<br> `Textfield Value Should Not Be`<br>
locator
text
message=NONE
Verify the text field identified by <b>locator</b> is exactly
<b>text</b>.<br>
<br>
Key attributes for text field are id and name. See `Introduction` for
details about log levels and locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the text field.<br> <b>text</b> The text to verify.<br> <b>message</b> Default=NONE. Optional custom error message.<br><br><b>See Also:</b><br> `Textfield Should Contain`<br> `Textfield Should Not Contain`<br> `Textfield Value Should Not Be`<br>
locator
text
message=NONE
Verify the text field identified by <b>locator</b> is not exactly
<b>text</b>.<br>
<br>
Key attributes for text field are id and name. See `Introduction` for
details about log levels and locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the text field.<br> <b>text</b> The text to verify.<br> <b>message</b> Default=NONE. Optional custom error message.<br><br><b>See Also:</b><br> `Textfield Should Contain`<br> `Textfield Should Not Contain`<br> `Textfield Value Should Be`<br>
title
Verify the current page title is exactly <b>title</b>.<br><br><b>Parameters:</b><br> <b>title</b> The title to verify.<br><br><b>See Also:</b><br> `Title Should Not Be`<br> `Title Should Contain`<br> `Title Should Not Contain`<br>
title
Verify the current page title contains <b>title</b>.<br><br><b>Parameters:</b><br> <b>title</b> The title to verify.<br><br><b>See Also:</b><br> `Title Should Be`<br> `Title Should Not Be`<br> `Title Should Not Contain`<br>
title
Verify the current page title is not exactly <b>title</b>.<br><br><b>Parameters:</b><br> <b>title</b> The title to verify.<br><br><b>See Also:</b><br> `Title Should Be`<br> `Title Should Contain`<br> `Title Should Not Contain`<br>
title
Verify the current page title does not contain <b>title</b>.<br><br><b>Parameters:</b><br> <b>title</b> The title to verify.<br><br><b>See Also:</b><br> `Title Should Be`<br> `Title Should Not Be`<br> `Title Should Contain`<br>
locator
Unselect the checkbox identified by <b>locator</b>.<br>
<br>
Does nothing, if the checkbox is not selected.<br>
<br>
Key attributes for checkboxes are id and name. See `Introduction` for
details about locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the checkbox.<br>
Selects the top frame as the current frame.
locator
*items
Unselect the given <b>*items</b> of the multi-select list identified by
<b>locator</b>.<br>
<br>
As a special case, giving an empty *items list will remove all
selections.<br>
<br>
Tries to unselect by value AND by label. It's generally faster to use 'by
index/value/label' keywords.<br>
<br>
Select list keywords work on both lists and combo boxes. Key attributes
for select lists are id and name. See `Introduction` for details about
locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the multi-select list.<br> <b>items</b> The list of items to select<br>
locator
*indexes
Unselect the given <b>*indexes</b> of the multi-select list identified by
<b>locator</b>.<br>
<br>
Select list keywords work on both lists and combo boxes. Key attributes
for select lists are id and name. See `Introduction` for details about
locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the multi-select list.<br> <b>indexes</b> The list of indexes to select<br>
locator
*labels
Unselect the given <b>*labels</b> of the multi-select list identified by
<b>locator</b>.<br>
<br>
Select list keywords work on both lists and combo boxes. Key attributes
for select lists are id and name. See `Introduction` for details about
locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the multi-select list.<br> <b>labels</b> The list of labels to select<br>
locator
*values
Unselect the given <b>*values</b> of the multi-select list identified by
<b>locator</b>.<br>
<br>
Select list keywords work on both lists and combo boxes. Key attributes
for select lists are id and name. See `Introduction` for details about
locators.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the multi-select list.<br> <b>values</b> The list of values to select<br>
condition
timeout=NONE
message=NONE
Waits until the given JavaScript <b>condition</b> is true.<br>
<br>
Fails, if the timeout expires, before the condition gets true. <br>
<br>
The condition may contain multiple JavaScript statements, but the last
statement must return a boolean. Otherwise this keyword will always hit
the timeout.<br>
<br>
Note that by default the code will be executed in the context of the
Selenium object itself, so <b>this</b> will refer to the Selenium object.
Use <b>window</b> to refer to the window of your application, e.g.
<i>window.document.getElementById('foo')</i>.<br>
<br>
See `Introduction` for details about timeouts.<br><br><b>Parameters:</b><br> <b>condition</b> The JavaScript condition returning a boolean.<br> <b>timeout</b> Default=NONE. Optional timeout interval.<br> <b>message</b> Default=NONE. Optional custom error message.<br>
locator
timeout=NONE
message=NONE
Waits until the element identified by <b>locator</b> is clickable.<br>
<br>
Fails, if the timeout expires, before the element gets clickable. <br>
<br>
See `Introduction` for details about locators and timeouts.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the element.<br> <b>timeout</b> Default=NONE. Optional timeout interval.<br> <b>message</b> Default=NONE. Optional custom error message.<br>
locator
timeout=NONE
message=NONE
Waits until the element identified by <b>locator</b> is not clickable.<br>
<br>
Fails, if the timeout expires, before the element gets unclickable. <br>
<br>
See `Introduction` for details about locators and timeouts.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the element.<br> <b>timeout</b> Default=NONE. Optional timeout interval.<br> <b>message</b> Default=NONE. Optional custom error message.<br>
locator
timeout=NONE
message=NONE
Waits until the element identified by <b>locator</b> is not selected.<br>
<br>
Fails, if the timeout expires, before the element gets unselected. <br>
<br>
See `Introduction` for details about locators and timeouts.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the element.<br> <b>timeout</b> Default=NONE. Optional timeout interval.<br> <b>message</b> Default=NONE. Optional custom error message.<br>
locator
timeout=NONE
message=NONE
Waits until the element identified by <b>locator</b> is not visible.<br>
<br>
Fails, if the timeout expires, before the element gets invisible. <br>
<br>
See `Introduction` for details about locators and timeouts.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the element.<br> <b>timeout</b> Default=NONE. Optional timeout interval.<br> <b>message</b> Default=NONE. Optional custom error message.<br>
locator
timeout=NONE
message=NONE
Waits until the element identified by <b>locator</b> is selected.<br>
<br>
Fails, if the timeout expires, before the element gets selected. <br>
<br>
See `Introduction` for details about locators and timeouts.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the element.<br> <b>timeout</b> Default=NONE. Optional timeout interval.<br> <b>message</b> Default=NONE. Optional custom error message.<br>
locator
timeout=NONE
message=NONE
Waits until the element identified by <b>locator</b> is sucessfully
clicked on.<br>
<br>
Fails, if the timeout expires, before the element gets clicked on. <br>
<br>
See `Introduction` for details about locators and timeouts.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the element.<br> <b>timeout</b> Default=NONE. Optional timeout interval.<br> <b>message</b> Default=NONE. Optional custom error message.<br>
locator
timeout=NONE
message=NONE
Waits until the element identified by <b>locator</b> is visible.<br>
<br>
Fails, if the timeout expires, before the element gets visible. <br>
<br>
See `Introduction` for details about locators and timeouts.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the element.<br> <b>timeout</b> Default=NONE. Optional timeout interval.<br> <b>message</b> Default=NONE. Optional custom error message.<br>
condition
timeout=NONE
message=NONE
Waits until the current page contains <b>text</b>.<br>
<br>
Fails, if the timeout expires, before the text appears. <br>
<br>
See `Introduction` for details about timeouts.<br><br><b>Parameters:</b><br> <b>text</b> The text to verify.<br> <b>timeout</b> Default=NONE. Optional timeout interval.<br> <b>message</b> Default=NONE. Optional custom error message.<br>
locator
timeout=NONE
message=NONE
Waits until the element identified by <b>locator</b> is found on the
current page.<br>
<br>
Fails, if the timeout expires, before the element appears. <br>
<br>
See `Introduction` for details about locators and timeouts.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the element.<br> <b>timeout</b> Default=NONE. Optional timeout interval.<br> <b>message</b> Default=NONE. Optional custom error message.<br>
text
timeout=NONE
message=NONE
Waits until the current page does not contain <b>text</b>.<br>
<br>
Fails, if the timeout expires, before the text disappears. <br>
<br>
See `Introduction` for details about timeouts.<br><br><b>Parameters:</b><br> <b>text</b> The text to verify.<br> <b>timeout</b> Default=NONE. Optional timeout interval.<br> <b>message</b> Default=NONE. Optional custom error message.<br>
locator
timeout=NONE
message=NONE
Waits until the element identified by <b>locator</b> is not found on the
current page.<br>
<br>
Fails, if the timeout expires, before the element disappears. <br>
<br>
See `Introduction` for details about locators and timeouts.<br><br><b>Parameters:</b><br> <b>locator</b> The locator to locate the element.<br> <b>timeout</b> Default=NONE. Optional timeout interval.<br> <b>message</b> Default=NONE. Optional custom error message.<br>
title
timeout=NONE
message=NONE
Waits until the current page title contains <b>title</b>.<br>
<br>
Fails, if the timeout expires, before the page title contains the given
title.<br><br><b>Parameters:</b><br> <b>title</b> The title to verify.<br> <b>timeout</b> Default=NONE. Optional timeout interval.<br> <b>message</b> Default=NONE. Optional custom error message.<br>
title
timeout=NONE
message=NONE
Waits until the current page title is exactly <b>title</b>.<br>
<br>
Fails, if the timeout expires, before the page title matches the given
title.<br><br><b>Parameters:</b><br> <b>title</b> The title to verify.<br> <b>timeout</b> Default=NONE. Optional timeout interval.<br> <b>message</b> Default=NONE. Optional custom error message.<br>
title
timeout=NONE
message=NONE
Waits until the current page title is not exactly <b>title</b>.<br>
<br>
Fails, if the timeout expires, before the page title does not match the
given title.<br><br><b>Parameters:</b><br> <b>title</b> The title to verify.<br> <b>timeout</b> Default=NONE. Optional timeout interval.<br> <b>message</b> Default=NONE. Optional custom error message.<br>
title
timeout=NONE
message=NONE
Waits until the current page title does not contain <b>title</b>.<br>
<br>
Fails, if the timeout expires, before the page title does not contain the
given title.<br><br><b>Parameters:</b><br> <b>title</b> The title to verify.<br> <b>timeout</b> Default=NONE. Optional timeout interval.<br> <b>message</b> Default=NONE. Optional custom error message.<br>
xpath
expectedXpathCount
message=NONE
logLevel=INFO
Verify that the page contains the <b>expectedXpathCount</b> of elements
located by the given <b>xpath</b>.<br><br><b>Parameters:</b><br> <b>xpath</b> The XPath to match page elements<br> <b>expectedXpathCount</b> The expected number of located elements<br> <b>message</b> Default=NONE. Optional custom error message.<br> <b>logLevel</b> Default=INFO. Optional log level.<br>