Selenium Reference

Concepts

Acommandis what tells Selenium what to do. Selenium commands come in three 'flavors':Actions,AccessorsandAssertions. Each command call is one line in the test table of the form:

command

target

value

Actionsare commands that generally manipulate the state of the application. They do things like "click this link" and "select that option". If an Action fails, or has an error, the execution of the current test is stopped.

Many Actions can be called with the "AndWait" suffix, e.g. "clickAndWait". This suffix tells Selenium that the action will cause the browser to make a call to the server, and that Selenium should wait for a new page to load.

Accessorsexamine the state of the application and store the results in variables, e.g. "storeTitle". They are also used to automatically generate Assertions.

Assertionsare like Accessors, but they verify that the state of the application conforms to what is expected. Examples include "make sure the page title is X" and "verify that this checkbox is checked".

All Selenium Assertions can be used in 3 modes: "assert", "verify", and "waitFor". For example, you can "assertText", "verifyText" and "waitForText". When an "assert" fails, the test is aborted. When a "verify" fails, the test will continue execution, logging the failure. This allows a single "assert" to ensure that the application is on the correct page, followed by a bunch of "verify" assertions to test form field values, labels, etc.

"waitFor" commands wait for some condition to become true (which can be useful for testing Ajax applications). They will succeed immediately if the condition is already true. However, they will fail and halt the test if the condition does not become true within the current timeout setting (see thesetTimeoutaction below).

Element Locatorstell Selenium which HTML element a command refers to. Many commands require an Element Locator as the "target" attribute. Examples of Element Locators include "elementId" and "document.forms[0].element". These are described more clearly in the next section.

Patternsare used for various reasons, e.g. to specify the expected value of an input field, or identify a select option. Selenium supports various types of pattern, including regular-expressions, all of which are described in more detail below.

Defines an object that runs Selenium commands.

Element Locators

Element Locators tell Selenium which HTML element a command refers to. The format of a locator is:

locatorType=argument

We support the following strategies for locating elements:

identifier=id

Select the element with the specified @id attribute. If no match is found, select the first element whose @name attribute isid. (This is normally the default; see below.)

id=id

Select the element with the specified @id attribute.

name=name

Select the first element with the specified @name attribute.

• username
• name=username

The name may optionally be followed by one or moreelement-filters, separated from the name by whitespace. If thefilterTypeis not specified,valueis assumed.

• name=flavour value=chocolate

dom=javascrīptExpression

Find an element using Javascrīpt traversal of the HTML Document Object Model. DOM locatorsmustbegin with "document.".

• dom=document.forms['myForm'].myDropdown
• dom=document.images[56]

xpath=xpathExpression

Locate an element using an XPath expression.

• xpath=//img[@alt='The image alt text']
• xpath=//table[@id='table1']//tr[4]/td[2]

link=textPattern

Select the link (anchor) element which contains text matching the specifiedpattern.

• link=The link text

css=cssSelectorSyntax

Select the element using css selectors. Please refer toCSS2 selectors,CSS3 selectorsfor more information. You can also check the TestCssLocators test in the selenium test suite for an example of usage, which is included in the downloaded selenium core package.

• css=a[href="#id3"]
• css=span#firstChild + span

Currently the css selector locator supports all css1, css2 and css3 selectors except namespace in css3, some pseudo classes(:nth-of-type, :nth-last-of-type, :first-of-type, :last-of-type, :only-of-type, :visited, :hover, :active, :focus, :indeterminate) and pseudo elements(::first-line, ::first-letter, ::selection, ::before, ::after).

Without an explicit locator prefix, Selenium uses the following default strategies:

• dom, for locators starting with "document."
• xpath, for locators starting with "//"
• identifier, otherwise

Element Filters

Element filters can be used with a locator to refine a list of candidate elements. They are currently used only in the 'name' element-locator.

Filters look much like locators, ie.

filterType=argument

Supported element-filters are:

value=valuePattern

Matches elements based on their values. This is particularly useful for refining a list of similarly-named toggle-buttons.

index=index

Selects a single element based on its position in the list (offset from zero).

String-match Patterns

Various Pattern syntaxes are available for matching string values:

glob:pattern

Match a string against a "glob" (aka "wildmat") pattern. "Glob" is a kind of limited regular-expression syntax typically used in command-line shells. In a glob pattern, "*" represents any sequence of characters, and "?" represents any single character. Glob patterns match against the entire string.

regexp:regexp

Match a string using a regular-expression. The full power of Javascrīpt regular-expressions is available.

exact:string

Match a string exactly, verbatim, without any of that fancy wildcard stuff.

If no pattern prefix is specified, Selenium assumes that it's a "glob" pattern.

Selenium Actions

addSelection ( locator,optionLocator )

Add a selection to the set of selected options in a multi-select element using an option locator. @see #doSelect for details of option locators

Arguments:

• locator - anelement locatoridentifying a multi-select box
• optionLocator - an option locator (a label by default)

answerOnNextPrompt ( answer )

Instructs Selenium to return the specified answer string in response to the next Javascrīpt prompt [window.prompt()].

Arguments:

• answer - the answer to give in response to the prompt pop-up

check ( locator )

Check a toggle-button (checkbox/radio)

Arguments:

• locator - anelement locator

chooseCancelOnNextConfirmation ( )

By default, Selenium's overridden window.confirm() function will return true, as if the user had manually clicked OK. After running this command, the next call to confirm() will return false, as if the user had clicked Cancel.

click ( locator )

Clicks on a link, button, checkbox or radio button. If the click action causes a new page to load (like a link usually does), call waitForPageToLoad.

Arguments:

• locator - an element locator

clickAt ( locator,coordString )

Clicks on a link, button, checkbox or radio button. If the click action causes a new page to load (like a link usually does), call waitForPageToLoad. Beware of http://jira.openqa.org/browse/SEL-280, which will lead some event handlers to get null event arguments. Read the bug for more details, including a workaround.

Arguments:

• locator - an element locator
• coordString - specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.

close ( )

Simulates the user clicking the "close" button in the titlebar of a popup window or tab.

createCookie ( nameValuePair,optionsString )

Create a new cookie whose path and domain are same with those of current page under test, unless you specified a path for this cookie explicitly.

Arguments:

• nameValuePair - name and value of the cookie in a format "name=value"
• optionsString - options for the cookie. Currently supported options include 'path' and 'max_age'. the optionsString's format is "path=/path/, max_age=60". The order of options are irrelevant, the unit of the value of 'max_age' is second.

deleteCookie ( name,path )

Delete a named cookie with specified path.

Arguments:

• name - the name of the cookie to be deleted
• path - the path property of the cookie to be deleted

dragdrop ( locator,movementsString )

Drags an element a certain distance and then drops it Beware of http://jira.openqa.org/browse/SEL-280, which will lead some event handlers to get null event arguments. Read the bug for more details, including a workaround.

Arguments:

• locator - an element locator
• movementsString - offset in pixels from the current location to which the element should be moved, e.g., "+70,-300"

fireEvent ( locator,eventName )

Explicitly simulate an event, to trigger the corresponding "onevent" handler.

Arguments:

• locator - anelement locator
• eventName - the event name, e.g. "focus" or "blur"

goBack ( )

Simulates the user clicking the "back" button on their browser.

keyDown ( locator,keySequence )

Simulates a user pressing a key (without releasing it yet).

Arguments:

• locator - anelement locator
• keySequence - Either be a string("\" followed by the numeric keycode of the key to be pressed, normally the ASCII value of that key), or a single character. For example: "w", "\119".

keyPress ( locator,keySequence )

Simulates a user pressing and releasing a key.

Arguments:

• locator - anelement locator
• keySequence - Either be a string("\" followed by the numeric keycode of the key to be pressed, normally the ASCII value of that key), or a single character. For example: "w", "\119".

keyUp ( locator,keySequence )

Simulates a user releasing a key.

Arguments:

• locator - anelement locator
• keySequence - Either be a string("\" followed by the numeric keycode of the key to be pressed, normally the ASCII value of that key), or a single character. For example: "w", "\119".

mouseDown ( locator )

Simulates a user pressing the mouse button (without releasing it yet) on the specified element.

Arguments:

• locator - anelement locator

mouseDownAt ( locator,coordString )

Simulates a user pressing the mouse button (without releasing it yet) on the specified element. Beware of http://jira.openqa.org/browse/SEL-280, which will lead some event handlers to get null event arguments. Read the bug for more details, including a workaround.

Arguments:

• locator - anelement locator
• coordString - specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.

mouseMove ( locator )

Simulates a user pressing the mouse button (without releasing it yet) on the specified element.

Arguments:

• locator - anelement locator

mouseMoveAt ( locator,coordString )

Simulates a user pressing the mouse button (without releasing it yet) on the specified element. Beware of http://jira.openqa.org/browse/SEL-280, which will lead some event handlers to get null event arguments. Read the bug for more details, including a workaround.

Arguments:

• locator - anelement locator
• coordString - specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.

mouseOut ( locator )

Simulates a user moving the mouse pointer away from the specified element.

Arguments:

• locator - anelement locator

mouseOver ( locator )

Simulates a user hovering a mouse over the specified element.

Arguments:

• locator - anelement locator

mouseUp ( locator )

Simulates a user pressing the mouse button (without releasing it yet) on the specified element.

Arguments:

• locator - anelement locator

mouseUpAt ( locator,coordString )

Simulates a user pressing the mouse button (without releasing it yet) on the specified element. Beware of http://jira.openqa.org/browse/SEL-280, which will lead some event handlers to get null event arguments. Read the bug for more details, including a workaround.

Arguments:

• locator - anelement locator
• coordString - specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.

open ( url )

Opens an URL in the test frame. This accepts both relative and absolute URLs. The "open" command waits for the page to load before proceeding, ie. the "AndWait" suffix is implicit.Note: The URL must be on the same domain as the runner HTML due to security restrictions in the browser (Same Origin Policy). If you need to open an URL on another domain, use the Selenium Server to start a new browser session on that domain.

Arguments:

• url - the URL to open; may be relative or absolute

refresh ( )

Simulates the user clicking the "Refresh" button on their browser.

removeSelection ( locator,optionLocator )

Remove a selection from the set of selected options in a multi-select element using an option locator. @see #doSelect for details of option locators

Arguments:

• locator - anelement locatoridentifying a multi-select box
• optionLocator - an option locator (a label by default)

select ( selectLocator,optionLocator )

Select an option from a drop-down using an option locator.

Option locators provide different ways of specifying options of an HTML Select element (e.g. for selecting a specific option, or for asserting that the selected option satisfies a specification). There are several forms of Select Option Locator.

label=labelPattern

matches options based on their labels, i.e. the visible text. (This is the default.)

• label=regexp:^[Oo]ther

value=valuePattern

matches options based on their values.

• value=other

id=id

matches options based on their ids.

• id=option1

index=index

matches an option based on its index (offset from zero).

• index=2

If no option locator prefix is provided, the default behaviour is to match onlabel.

Arguments:

• selectLocator - anelement locatoridentifying a drop-down menu
• optionLocator - an option locator (a label by default)

selectFrame ( locator )

Selects a frame within the current window. (You may invoke this command multiple times to select nested frames.) To select the parent frame, use "relative=parent" as a locator; to select the top frame, use "relative=top".

You may also use a DOM expression to identify the frame you want directly, like this:dom=frames["main"].frames["subframe"]

Arguments:

• locator - anelement locatoridentifying a frame or iframe

selectWindow ( windowID )

Selects a popup window; once a popup window has been selected, all commands go to that window. To select the main window again, use "null" as the target.

Arguments:

• windowID - the Javascrīpt window ID of the window to select

setContext ( context,logLevelThreshold )

Writes a message to the status bar and adds a note to the browser-side log.

If logLevelThreshold is specified, set the threshold for logging to that level (debug, info, warn, error).

(Note that the browser-side logs willnotbe sent back to the server, and are invisible to the Client Driver.)

Arguments:

• context - the message to be sent to the browser
• logLevelThreshold - one of "debug", "info", "warn", "error", sets the threshold for browser-side logging

setCursorPosition ( locator,position )

Moves the text cursor to the specified position in the given input element or textarea. This method will fail if the specified element isn't an input element or textarea.

Arguments:

• locator - anelement locatorpointing to an input element or textarea
• position - the numerical position of the cursor in the field; position should be 0 to move the position to the beginning of the field. You can also set the cursor to -1 to move it to the end of the field.

setTimeout ( timeout )

Specifies the amount of time that Selenium will wait for actions to complete.

Actions that require waiting include "open" and the "waitFor*" actions.

The default timeout is 30 seconds.

Arguments:

• timeout - a timeout in milliseconds, after which the action will return with an error

submit ( formLocator )

Submit the specified form. This is particularly useful for forms without submit buttons, e.g. single-input "Search" forms.

Arguments:

• formLocator - anelement locatorfor the form you want to submit

type ( locator,value )

Sets the value of an input field, as though you typed it in.

Can also be used to set the value of combo boxes, check boxes, etc. In these cases, value should be the value of the option selected, not the visible text.

Arguments:

• locator - anelement locator
• value - the value to type

uncheck ( locator )

Uncheck a toggle-button (checkbox/radio)

Arguments:

• locator - anelement locator

waitForCondition ( scrīpt,timeout )

Runs the specified Javascrīpt snippet repeatedly until it evaluates to "true". The snippet may have multiple lines, but only the result of the last line will be considered.

Note that, by default, the snippet will be run in the runner's test window, not in the window of your application. To get the window of your application, you can use the Javascrīpt snippetselenium.browserbot.getCurrentWindow(), and then run your Javascrīpt in there

Arguments:

• scrīpt - the Javascrīpt snippet to run
• timeout - a timeout in milliseconds, after which this command will return with an error

waitForPageToLoad ( timeout )

Waits for a new page to load.

You can use this command instead of the "AndWait" suffixes, "clickAndWait", "selectAndWait", "typeAndWait" etc. (which are only available in the JS API).

Selenium constantly keeps track of new pages loading, and sets a "newPageLoaded" flag when it first notices a page load. Running any other Selenium command after turns the flag to false. Hence, if you want to wait for a page to load, you must wait immediately after a Selenium command that caused a page-load.

Arguments:

• timeout - a timeout in milliseconds, after which this command will return with an error

waitForPopUp ( windowID,timeout )

Waits for a popup window to appear and load up.

Arguments:

• windowID - the Javascrīpt window ID of the window that will appear
• timeout - a timeout in milliseconds, after which the action will return with an error

windowFocus ( windowName )

Gives focus to a window

Arguments:

• windowName - name of the window to be given focus

windowMaximize ( windowName )

Resize window to take up the entire screen

Arguments:

• windowName - name of the window to be enlarged

Selenium Accessors

storeAlert ( variableName )

Retrieves the message of a Javascrīpt alert generated during the previous action, or fail if there were no alerts.

Getting an alert has the same effect as manually clicking OK. If an alert is generated but you do not get/verify it, the next Selenium action will fail.

NOTE: under Selenium, Javascrīpt alerts will NOT pop up a visible alert dialog.

NOTE: Selenium does NOT support Javascrīpt alerts that are generated in a page's onload() event handler. In this case a visible dialog WILL be generated and Selenium will hang until someone manually clicks OK.

Returns:

The message of the most recent Javascrīpt alert

Related Assertions, automatically generated:

• assertAlert (pattern)
• assertNotAlert (pattern)
• verifyAlert (pattern)
• verifyNotAlert (pattern)
• waitForAlert (pattern)
• waitForNotAlert (pattern)

storeAllButtons ( variableName )

Returns the IDs of all buttons on the page.

If a given button has no ID, it will appear as "" in this array.

Returns:

the IDs of all buttons on the page

Related Assertions, automatically generated:

• assertAllButtons (pattern)
• assertNotAllButtons (pattern)
• verifyAllButtons (pattern)
• verifyNotAllButtons (pattern)
• waitForAllButtons (pattern)
• waitForNotAllButtons (pattern)

storeAllFields ( variableName )

Returns the IDs of all input fields on the page.

If a given field has no ID, it will appear as "" in this array.

Returns:

the IDs of all field on the page

Related Assertions, automatically generated:

• assertAllFields (pattern)
• assertNotAllFields (pattern)
• verifyAllFields (pattern)
• verifyNotAllFields (pattern)
• waitForAllFields (pattern)
• waitForNotAllFields (pattern)

storeAllLinks ( variableName )

Returns the IDs of all links on the page.

If a given link has no ID, it will appear as "" in this array.

Returns:

the IDs of all links on the page

Related Assertions, automatically generated:

• assertAllLinks (pattern)
• assertNotAllLinks (pattern)
• verifyAllLinks (pattern)
• verifyNotAllLinks (pattern)
• waitForAllLinks (pattern)
• waitForNotAllLinks (pattern)

storeAllWindowIds ( variableName )

Returns the IDs of all windows that the browser knows about.

Returns:

the IDs of all windows that the browser knows about.

Related Assertions, automatically generated:

• assertAllWindowIds (pattern)
• assertNotAllWindowIds (pattern)
• verifyAllWindowIds (pattern)
• verifyNotAllWindowIds (pattern)
• waitForAllWindowIds (pattern)
• waitForNotAllWindowIds (pattern)

storeAllWindowNames ( variableName )

Returns the names of all windows that the browser knows about.

Returns:

the names of all windows that the browser knows about.

Related Assertions, automatically generated:

• assertAllWindowNames (pattern)
• assertNotAllWindowNames (pattern)
• verifyAllWindowNames (pattern)
• verifyNotAllWindowNames (pattern)
• waitForAllWindowNames (pattern)
• waitForNotAllWindowNames (pattern)

storeAllWindowTitles ( variableName )

Returns the titles of all windows that the browser knows about.

Returns:

the titles of all windows that the browser knows about.

Related Assertions, automatically generated:

• assertAllWindowTitles (pattern)
• assertNotAllWindowTitles (pattern)
• verifyAllWindowTitles (pattern)
• verifyNotAllWindowTitles (pattern)
• waitForAllWindowTitles (pattern)
• waitForNotAllWindowTitles (pattern)

storeAttribute ( attributeLocator, variableName )

Gets the value of an element attribute. Beware of http://jira.openqa.org/browse/SEL-280, which will lead some event handlers to get null event arguments. Read the bug for more details, including a workaround.

Arguments:

• attributeLocator - an element locator followed by an
• variableName - the name of avariablein which the result is to be stored.

Returns:

the value of the specified attribute

Related Assertions, automatically generated:

• assertAttribute ( attributeLocator,pattern)
• assertNotAttribute ( attributeLocator,pattern)
• verifyAttribute ( attributeLocator,pattern)
• verifyNotAttribute ( attributeLocator,pattern)
• waitForAttribute ( attributeLocator,pattern)
• waitForNotAttribute ( attributeLocator,pattern)

storeAttributeFromAllWindows ( attributeName, variableName )

Returns every instance of some attribute from all known windows.

Arguments:

• attributeName - name of an attribute on the windows
• variableName - the name of avariablein which the result is to be stored.

Returns:

the set of values of this attribute from all known windows.

Related Assertions, automatically generated:

• assertAttributeFromAllWindows ( attributeName,pattern)
• assertNotAttributeFromAllWindows ( attributeName,pattern)
• verifyAttributeFromAllWindows ( attributeName,pattern)
• verifyNotAttributeFromAllWindows ( attributeName,pattern)
• waitForAttributeFromAllWindows ( attributeName,pattern)
• waitForNotAttributeFromAllWindows ( attributeName,pattern)

storeBodyText ( variableName )

Gets the entire text of the page.

Returns:

the entire text of the page

Related Assertions, automatically generated:

• assertBodyText (pattern)
• assertNotBodyText (pattern)
• verifyBodyText (pattern)
• verifyNotBodyText (pattern)
• waitForBodyText (pattern)
• waitForNotBodyText (pattern)

storeConfirmation ( variableName )

Retrieves the message of a Javascrīpt confirmation dialog generated during the previous action.

By default, the confirm function will return true, having the same effect as manually clicking OK. This can be changed by prior execution of the chooseCancelOnNextConfirmation command. If an confirmation is generated but you do not get/verify it, the next Selenium action will fail.

NOTE: under Selenium, Javascrīpt confirmations will NOT pop up a visible dialog.

NOTE: Selenium does NOT support Javascrīpt confirmations that are generated in a page's onload() event handler. In this case a visible dialog WILL be generated and Selenium will hang until you manually click OK.

Returns:

the message of the most recent Javascrīpt confirmation dialog

Related Assertions, automatically generated:

• assertConfirmation (pattern)
• assertNotConfirmation (pattern)
• verifyConfirmation (pattern)
• verifyNotConfirmation (pattern)
• waitForConfirmation (pattern)
• waitForNotConfirmation (pattern)

storeCookie ( variableName )

Return all cookies of the current page under test.

Returns:

all cookies of the current page under test

Related Assertions, automatically generated:

• assertCookie (pattern)
• assertNotCookie (pattern)
• verifyCookie (pattern)
• verifyNotCookie (pattern)
• waitForCookie (pattern)
• waitForNotCookie (pattern)

storeCursorPosition ( locator, variableName )

Retrieves the text cursor position in the given input element or textarea; beware, this may not work perfectly on all browsers.

Specifically, if the cursor/selection has been cleared by Javascrīpt, this command will tend to return the position of the last location of the cursor, even though the cursor is now gone from the page. This is filed asSEL-243.

This method will fail if the specified element isn't an input element or textarea, or there is no cursor in the element.

Arguments:

• locator - anelement locatorpointing to an input element or textarea
• variableName - the name of avariablein which the result is to be stored.

Returns:

the numerical position of the cursor in the field

Related Assertions, automatically generated:

• assertCursorPosition ( locator,pattern)
• assertNotCursorPosition ( locator,pattern)
• verifyCursorPosition ( locator,pattern)
• verifyNotCursorPosition ( locator,pattern)
• waitForCursorPosition ( locator,pattern)
• waitForNotCursorPosition ( locator,pattern)

storeElementHeight ( locator, variableName )

Retrieves the height of an element

Arguments:

• locator - anelement locatorpointing to an element
• variableName - the name of avariablein which the result is to be stored.

Returns:

height of an element in pixels

Related Assertions, automatically generated:

• assertElementHeight ( locator,pattern)
• assertNotElementHeight ( locator,pattern)
• verifyElementHeight ( locator,pattern)
• verifyNotElementHeight ( locator,pattern)
• waitForElementHeight ( locator,pattern)
• waitForNotElementHeight ( locator,pattern)

storeElementIndex ( locator, variableName )

Get the relative index of an element to its parent (starting from 0). The comment node and empty text node will be ignored.

Arguments:

• locator - anelement locatorpointing to an element
• variableName - the name of avariablein which the result is to be stored.

Returns:

of relative index of the element to its parent (starting from 0)

Related Assertions, automatically generated:

• assertElementIndex ( locator,pattern)
• assertNotElementIndex ( locator,pattern)
• verifyElementIndex ( locator,pattern)
• verifyNotElementIndex ( locator,pattern)
• waitForElementIndex ( locator,pattern)
• waitForNotElementIndex ( locator,pattern)

storeElementPositionLeft ( locator, variableName )

Retrieves the horizontal position of an element

Arguments:

• locator - anelement locatorpointing to an element OR an element itself
• variableName - the name of avariablein which the result is to be stored.

Returns:

of pixels from the edge of the frame.

Related Assertions, automatically generated:

• assertElementPositionLeft ( locator,pattern)
• assertNotElementPositionLeft ( locator,pattern)
• verifyElementPositionLeft ( locator,pattern)
• verifyNotElementPositionLeft ( locator,pattern)
• waitForElementPositionLeft ( locator,pattern)
• waitForNotElementPositionLeft ( locator,pattern)

storeElementPositionTop ( locator, variableName )

Retrieves the vertical position of an element

Arguments:

• locator - anelement locatorpointing to an element OR an element itself
• variableName - the name of avariablein which the result is to be stored.

Returns:

of pixels from the edge of the frame.

Related Assertions, automatically generated:

• assertElementPositionTop ( locator,pattern)
• assertNotElementPositionTop ( locator,pattern)
• verifyElementPositionTop ( locator,pattern)
• verifyNotElementPositionTop ( locator,pattern)
• waitForElementPositionTop ( locator,pattern)
• waitForNotElementPositionTop ( locator,pattern)

storeElementWidth ( locator, variableName )

Retrieves the width of an element

Arguments:

• locator - anelement locatorpointing to an element
• variableName - the name of avariablein which the result is to be stored.

Returns:

width of an element in pixels

Related Assertions, automatically generated:

• assertElementWidth ( locator,pattern)
• assertNotElementWidth ( locator,pattern)
• verifyElementWidth ( locator,pattern)
• verifyNotElementWidth ( locator,pattern)
• waitForElementWidth ( locator,pattern)
• waitForNotElementWidth ( locator,pattern)

storeEval ( scrīpt, variableName )

Gets the result of evaluating the specified Javascrīpt snippet. The snippet may have multiple lines, but only the result of the last line will be returned.

Note that, by default, the snippet will run in the context of the "selenium" object itself, sothiswill refer to the Selenium object, andwindowwill refer to the top-level runner test window, not the window of your application.

If you need a reference to the window of your application, you can refer tothis.browserbot.getCurrentWindow()and if you need to use a locator to refer to a single element in your application page, you can usethis.page().findElement("foo")where "foo" is your locator.

Arguments:

• scrīpt - the Javascrīpt snippet to run
• variableName - the name of avariablein which the result is to be stored.

Returns:

the results of evaluating the snippet

Related Assertions, automatically generated:

• assertEval ( scrīpt,pattern)
• assertNotEval ( scrīpt,pattern)
• verifyEval ( scrīpt,pattern)
• verifyNotEval ( scrīpt,pattern)
• waitForEval ( scrīpt,pattern)
• waitForNotEval ( scrīpt,pattern)

storeExpression ( expression, variableName )

Returns the specified expression.

This is useful because of Javascrīpt preprocessing. It is used to generate commands like assertExpression and waitForExpression.

Arguments:

• expression - the value to return
• variableName - the name of avariablein which the result is to be stored.

Returns:

the value passed in

Related Assertions, automatically generated:

• assertExpression ( expression,pattern)
• assertNotExpression ( expression,pattern)
• verifyExpression ( expression,pattern)
• verifyNotExpression ( expression,pattern)
• waitForExpression ( expression,pattern)
• waitForNotExpression ( expression,pattern)

storeHtmlSource ( variableName )

Returns the entire HTML source between the opening and closing "html" tags.

Returns:

the entire HTML source

Related Assertions, automatically generated:

• assertHtmlSource (pattern)
• assertNotHtmlSource (pattern)
• verifyHtmlSource (pattern)
• verifyNotHtmlSource (pattern)
• waitForHtmlSource (pattern)
• waitForNotHtmlSource (pattern)

storeLocation ( variableName )

Gets the absolute URL of the current page.

Returns:

the absolute URL of the current page

Related Assertions, automatically generated:

• assertLocation (pattern)
• assertNotLocation (pattern)
• verifyLocation (pattern)
• verifyNotLocation (pattern)
• waitForLocation (pattern)
• waitForNotLocation (pattern)

storeLogMessages ( variableName )

Return the contents of the log.

This is a placeholder intended to make the code generator make this API available to clients. The selenium server will intercept this call, however, and return its recordkeeping of log messages since the last call to this API. Thus this code in Javascrīpt will never be called.

The reason I opted for a servercentric solution is to be able to support multiple frames served from different domains, which would break a centralized Javascrīpt logging mechanism under some conditions.

Returns:

all log messages seen since the last call to this API

Related Assertions, automatically generated:

• assertLogMessages (pattern)
• assertNotLogMessages (pattern)
• verifyLogMessages (pattern)
• verifyNotLogMessages (pattern)
• waitForLogMessages (pattern)
• waitForNotLogMessages (pattern)

storePrompt ( variableName )

Retrieves the message of a Javascrīpt question prompt dialog generated during the previous action.

Successful handling of the prompt requires prior execution of the answerOnNextPrompt command. If a prompt is generated but you do not get/verify it, the next Selenium action will fail.

NOTE: under Selenium, Javascrīpt prompts will NOT pop up a visible dialog.

NOTE: Selenium does NOT support Javascrīpt prompts that are generated in a page's onload() event handler. In this case a visible dialog WILL be generated and Selenium will hang until someone manually clicks OK.

Returns:

the message of the most recent Javascrīpt question prompt

Related Assertions, automatically generated:

• assertPrompt (pattern)
• assertNotPrompt (pattern)
• verifyPrompt (pattern)
• verifyNotPrompt (pattern)
• waitForPrompt (pattern)
• waitForNotPrompt (pattern)

storeSelectedId ( selectLocator, variableName )

Gets option element ID for selected option in the specified select element.

Arguments:

• selectLocator - anelement locatoridentifying a drop-down menu
• variableName - the name of avariablein which the result is to be stored.

Returns:

the selected option ID in the specified select drop-down

Related Assertions, automatically generated:

• assertSelectedId ( selectLocator,pattern)
• assertNotSelectedId ( selectLocator,pattern)
• verifySelectedId ( selectLocator,pattern)
• verifyNotSelectedId ( selectLocator,pattern)
• waitForSelectedId ( selectLocator,pattern)
• waitForNotSelectedId ( selectLocator,pattern)

storeSelectedIds ( selectLocator, variableName )

Gets all option element IDs for selected options in the specified select or multi-select element.

Arguments:

• selectLocator - anelement locatoridentifying a drop-down menu
• variableName - the name of avariablein which the result is to be stored.

Returns:

an array of all selected option IDs in the specified select drop-down

Related Assertions, automatically generated:

• assertSelectedIds ( selectLocator,pattern)
• assertNotSelectedIds ( selectLocator,pattern)
• verifySelectedIds ( selectLocator,pattern)
• verifyNotSelectedIds ( selectLocator,pattern)
• waitForSelectedIds ( selectLocator,pattern)
• waitForNotSelectedIds ( selectLocator,pattern)

storeSelectedIndex ( selectLocator, variableName )

Gets option index (option number, starting at 0) for selected option in the specified select element.

Arguments:

• selectLocator - anelement locatoridentifying a drop-down menu
• variableName - the name of avariablein which the result is to be stored.

Returns:

the selected option index in the specified select drop-down

Related Assertions, automatically generated:

• assertSelectedIndex ( selectLocator,pattern)
• assertNotSelectedIndex ( selectLocator,pattern)
• verifySelectedIndex ( selectLocator,pattern)
• verifyNotSelectedIndex ( selectLocator,pattern)
• waitForSelectedIndex ( selectLocator,pattern)
• waitForNotSelectedIndex ( selectLocator,pattern)

storeSelectedIndexes ( selectLocator, variableName )

Gets all option indexes (option number, starting at 0) for selected options in the specified select or multi-select element.

Arguments:

• selectLocator - anelement locatoridentifying a drop-down menu
• variableName - the name of avariablein which the result is to be stored.

Returns:

an array of all selected option indexes in the specified select drop-down

Related Assertions, automatically generated:

• assertSelectedIndexes ( selectLocator,pattern)
• assertNotSelectedIndexes ( selectLocator,pattern)
• verifySelectedIndexes ( selectLocator,pattern)
• verifyNotSelectedIndexes ( selectLocator,pattern)
• waitForSelectedIndexes ( selectLocator,pattern)
• waitForNotSelectedIndexes ( selectLocator,pattern)

storeSelectedLabel ( selectLocator, variableName )

Gets option label (visible text) for selected option in the specified select element.

Arguments:

• selectLocator - anelement locatoridentifying a drop-down menu
• variableName - the name of avariablein which the result is to be stored.

Returns