Supported Selenium IDE Commands
Below is a list of the commands we currently support in our Codeless Automation.
Browsing
-
close
Simulates the user clicking the "close" button in the titlebar of a popup window or tab.
-
closeAndWait
Simulates the user clicking the "close" button in the titlebar of a popup window or tab.
-
goBack
Simulates the user clicking the "back" button on their browser.
-
goBackAndWait
Simulates the user clicking the "back" button on their browser.
-
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.
-
openAndWait
(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.
-
openWindow
(url - windowID)Opens a popup window (if a window with that ID isn't already open). After opening the window, you'll need to select it using the selectWindow command.
This command can also be a useful workaround for bug SEL-339. In some cases, Selenium will be unable to intercept a call to window.open (if the call occurs during or before the "onLoad" event, for example). In those cases, you can force Selenium to notice the open window's name by using the Selenium openWindow command, using an empty (blank) url, like this: openWindow("", "myFunnyWindow").
-
openWindowAndWait
(url - windowID)Opens a popup window (if a window with that ID isn't already open). After opening the window, you'll need to select it using the selectWindow command.
This command can also be a useful workaround for bug SEL-339. In some cases, Selenium will be unable to intercept a call to window.open (if the call occurs during or before the "onLoad" event, for example). In those cases, you can force Selenium to notice the open window's name by using the Selenium openWindow command, using an empty (blank) url, like this: openWindow("", "myFunnyWindow").
-
refresh
Simulates the user clicking the "Refresh" button on their browser.
-
refreshAndWait
Simulates the user clicking the "Refresh" button on their browser.
-
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 can also select a frame by its 0-based index number; select the first frame with "index=0", or the third frame with "index=2".
You may also use a DOM expression to identify the frame you want directly, like this:
dom=frames["main"].frames["subframe"]
-
selectFrameAndWait
(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 can also select a frame by its 0-based index number; select the first frame with "index=0", or the third frame with "index=2".
You may also use a DOM expression to identify the frame you want directly, like this:
dom=frames["main"].frames["subframe"]
-
selectWindow
(windowID)Selects a popup window using a window locator; once a popup window has been selected, all commands go to that window. To select the main window again, use null as the target.
Window locators provide different ways of specifying the window object: by title, by internal JavaScript "name," or by JavaScript variable.
- title=My Special Window: Finds the window using the text that appears in the title bar. Be careful; two windows can share the same title. If that happens, this locator will just pick one.
- name=myWindow: Finds the window using its internal JavaScript "name" property. This is the second parameter "windowName" passed to the JavaScript method window.open(url, windowName, windowFeatures, replaceFlag) (which Selenium intercepts).
-
var=variableName:
Some pop-up windows are unnamed (anonymous), but are associated with a JavaScript variable name in the current
application window, e.g. "window.foo = window.open(url);". In those cases, you can open the window using
"var=foo".
If no window locator prefix is provided, we'll try to guess what you mean like this:
1.) if windowID is null, (or the string "null") then it is assumed the user is referring to the original window instantiated by the browser).
2.) if the value of the "windowID" parameter is a JavaScript variable name in the current application window, then it is assumed that this variable contains the return value from a call to the JavaScript window.open() method.
3.) Otherwise, selenium looks in a hash it maintains that maps string names to window "names".
4.) If
that fails, we'll try looping over all of the known windows to try to find the appropriate "title". Since "title" is not necessarily unique, this may have unexpected behavior.If you're having trouble figuring out the name of a window that you want to manipulate, look at the Selenium log messages which identify the names of windows created via window.open (and therefore intercepted by Selenium). You will see messages like the following for each window as it is opened:
debug: window.open call intercepted; window ID (which you can use with selectWindow()) is "myNewWindow"
In some cases, Selenium will be unable to intercept a call to window.open (if the call occurs during or before the "onLoad" event, for example). (This is bug SEL-339.) In those cases, you can force Selenium to notice the open window's name by using the Selenium openWindow command, using an empty (blank) url, like this: openWindow("", "myFunnyWindow").
-
selectWindowAndWait
(windowID)Selects a popup window using a window locator; once a popup window has been selected, all commands go to that window. To select the main window again, use null as the target.
Window locators provide different ways of specifying the window object: by title, by internal JavaScript "name," or by JavaScript variable.
- title=My Special Window: Finds the window using the text that appears in the title bar. Be careful; two windows can share the same title. If that happens, this locator will just pick one.
- name=myWindow: Finds the window using its internal JavaScript "name" property. This is the second parameter "windowName" passed to the JavaScript method window.open(url, windowName, windowFeatures, replaceFlag) (which Selenium intercepts).
-
var=variableName:
Some pop-up windows are unnamed (anonymous), but are associated with a JavaScript variable name in the current
application window, e.g. "window.foo = window.open(url);". In those cases, you can open the window using
"var=foo".
If no window locator prefix is provided, we'll try to guess what you mean like this:
1.) if windowID is null, (or the string "null") then it is assumed the user is referring to the original window instantiated by the browser).
2.) if the value of the "windowID" parameter is a JavaScript variable name in the current application window, then it is assumed that this variable contains the return value from a call to the JavaScript window.open() method.
3.) Otherwise, selenium looks in a hash it maintains that maps string names to window "names".
4.) If
that fails, we'll try looping over all of the known windows to try to find the appropriate "title". Since "title" is not necessarily unique, this may have unexpected behavior.If you're having trouble figuring out the name of a window that you want to manipulate, look at the Selenium log messages which identify the names of windows created via window.open (and therefore intercepted by Selenium). You will see messages like the following for each window as it is opened:
debug: window.open call intercepted; window ID (which you can use with selectWindow()) is "myNewWindow"
In some cases, Selenium will be unable to intercept a call to window.open (if the call occurs during or before the "onLoad" event, for example). (This is bug SEL-339.) In those cases, you can force Selenium to notice the open window's name by using the Selenium openWindow command, using an empty (blank) url, like this: openWindow("", "myFunnyWindow").
-
windowFocus
Gives focus to the currently selected window
-
windowFocusAndWait
Gives focus to the currently selected window
-
windowMaximize
Resize currently selected window to take up the entire screen
-
windowMaximizeAndWait
Resize currently selected window to take up the entire screen
Clicks
-
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.
-
clickAndWait
(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.
-
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.
-
clickAtAndWait
(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.
-
doubleClick
(locator)Double clicks on a link, button, checkbox or radio button. If the double click action causes a new page to load (like a link usually does), call waitForPageToLoad.
-
doubleClickAndWait
(locator)Double clicks on a link, button, checkbox or radio button. If the double click action causes a new page to load (like a link usually does), call waitForPageToLoad.
-
doubleClickAt
(locator - coordString)Doubleclicks on a link, button, checkbox or radio button. If the action causes a new page to load (like a link usually does), call waitForPageToLoad.
-
doubleClickAtAndWait
(locator - coordString)Doubleclicks on a link, button, checkbox or radio button. If the action causes a new page to load (like a link usually does), call waitForPageToLoad.
-
dragAndDrop
(locator - movementsString)Drags an element a certain distance and then drops it
-
dragAndDropAndWait
(locator - movementsString)Drags an element a certain distance and then drops it
-
dragAndDropToObject
(locatorOfObjectToBeDragged - locatorOfDragDestinationObject)Drags an element and drops it on another element
-
dragAndDropToObjectAndWait
(locatorOfObjectToBeDragged - locatorOfDragDestinationObject)Drags an element and drops it on another element
Form Fields
-
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
-
addSelectionAndWait
(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
-
check
(locator)Check a toggle-button (checkbox/radio)
-
checkAndWait
(locator)Check a toggle-button (checkbox/radio)
-
focus
(locator)Move the focus to the specified element; for example, if the element is an input field, move the cursor to that field.
-
focusAndWait
(locator)Move the focus to the specified element; for example, if the element is an input field, move the cursor to that field.
-
removeAllSelections
(locator)Unselects all of the selected options in a multi-select element.
-
removeAllSelectionsAndWait
(locator)Unselects all of the selected options in a multi-select element.
-
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
-
removeSelectionAndWait
(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
-
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
-
selectAndWait
(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
-
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.
-
setCursorPositionAndWait
(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.
-
submit
(formLocator)Submit the specified form. This is particularly useful for forms without submit buttons, e.g. single-input "Search" forms.
-
submitAndWait
(formLocator)Submit the specified form. This is particularly useful for forms without submit buttons, e.g. single-input "Search" forms.
-
uncheck
(locator)Uncheck a toggle-button (checkbox/radio)
-
uncheckAndWait
(locator)Uncheck a toggle-button (checkbox/radio)
-
getSelectedLabels
(selectLocator)Gets all option labels (visible text) for selected options in the specified select or multi-select element.
-
getSelectedLabel
(selectLocator)Gets option label (visible text) for selected option in the specified select element.
-
getSelectedValues
(selectLocator)Gets all option values (value attributes) for selected options in the specified select or multi-select element.
-
getSelectedValue
(selectLocator)Gets option value (value attribute) for selected option in the specified select element.
-
getSelectedIndexes
(selectLocator)Gets all option indexes (option number, starting at 0) for selected options in the specified select or multi-select element.
-
getSelectedIndex
(selectLocator)Gets option index (option number, starting at 0) for selected option in the specified select element.
-
getSelectedIds
(selectLocator)Gets all option element IDs for selected options in the specified select or multi-select element.
-
getSelectedId
(selectLocator)Gets option element ID for selected option in the specified select element.
-
verifyAllButtons
(equalTo) -
verifyAllFields
(equalTo) -
verifyChecked
(locator) -
isChecked
(locator)Gets whether a toggle-button (checkbox/radio) is checked. Fails if the specified element doesn't exist or isn't a toggle-button.
-
verifyCursorPosition
(locator - equalTo) -
verifyEditable
(locator) -
waitForElementEditable
(locator) -
verifyNotAllButtons
(equalTo) -
verifyNotAllFields
(equalTo) -
verifyNotChecked
(locator) -
verifyNotCursorPosition
(locator - equalTo) -
verifyNotEditable
(locator) -
verifyNotSelectedIds
(selectLocator - equalTo) -
verifyNotSelectedIndexes
(selectLocator - equalTo) -
verifyNotSelectedLabels
(selectLocator - equalTo) -
verifyNotSelectedValues
(selectLocator - equalTo) -
verifyNotSelectedOptions
(selectLocator - equalTo) -
verifyNotSomethingSelected
(selectLocator) -
verifyNotValue
(locator - equalTo) -
verifySelectedIds
(selectLocator - equalTo) -
verifySelectedIndexes
(selectLocator - equalTo) -
verifySelectedLabels
(selectLocator - equalTo) -
verifySelectedValues
(selectLocator - equalTo) -
verifySelectOptions
(selectLocator - equalTo) -
verifySomethingSelected
(selectLocator) -
isSomethingSelected
(selectLocator)Determines whether some option in a drop-down menu is selected.
-
verifyValue
(locator - equalTo) -
assertAllButtons
(equalTo) -
assertAllFields
(equalTo) -
assertChecked
(locator) -
assertCursorPosition
(locator - equalTo) -
assertEditable
(locator) -
assertNotAllButtons
-
assertNotAllFields
-
assertNotChecked
(locator) -
assertNotCursorPosition
(locator - equalTo) -
assertNotEditable
(locator) -
assertNotSelectedIds
(selectLocator - equalTo) -
assertNotSelectedIndexes
(selectLocator - equalTo) -
assertNotSelectedLabels
(selectLocator - equalTo) -
assertNotSelectedValues
(selectLocator - equalTo) -
assertNotSelectOptions
(selectLocator - equalTo) -
assertNotSomethingSelected
(selectLocator) -
assertNotValue
(locator - equalTo) -
assertSelectedIds
(selectLocator - equalTo) -
assertSelectedIndexes
(selectLocator - equalTo) -
assertSelectedLabels
(selectLocator - equalTo) -
assertSelectedValues
(selectLocator - equalTo) -
assertSelectOptions
(selectLocator - equalTo) -
assertSomethingSelected
(selectLocator) -
assertValue
(locator - equalTo) -
waitForAllWindowIds
(equalTo) -
waitForAllWindowNames
(equalTo) -
waitForAllWindowTitles
(equalTo) -
waitForAttributeFromAllWindows
(attributeName - equalTo) -
waitForLocation
(equalTo) -
waitForNotAllWindowIds
(equalTo) -
waitForNotAllWindowNames
(equalTo) -
waitForNotAllWindowTitles
(equalTo) -
waitForNotAttributeFromAllWindows
(attributeName - equalTo) -
WaitForNotLocation
(equalTo) -
waitForNotTitle
(equalTo) -
waitForTitle
(equalTo) -
storeAllButtons
-
storeAllFields
-
storeChecked
(locator - variable) -
storeCursorPosition
(locator - variable) -
storeEditable
(locator - variable) -
storeSelectedIds
(selectLocator - variable) -
storeSelectedIndexes
(selectLocator - variable) -
storeSelectedLabels
(selectLocator - variable) -
storeSelectedValues
(selectLocator - variable) -
storeSelectOptions
(selectLocator - variable) -
storeSomethingSelected
(selectLocator - variable) -
storeValue
(locator - variable)
If no option locator prefix is provided, the default behaviour is to match on
label.If no option locator prefix is provided, the default behaviour is to match on
label.Keyboard Events
-
keyDown
(locator - keySequence)Simulates a user pressing a key (without releasing it yet).
-
keyDownAndWait
(locator - keySequence)Simulates a user pressing a key (without releasing it yet).
-
keyPress
(locator - keySequence)Simulates a user pressing and releasing a key.
-
keyPressAndWait
(locator - keySequence)Simulates a user pressing and releasing a key.
-
keyUp
(locator - keySequence)Simulates a user releasing a key.
-
keyUpAndWait
(locator - keySequence)Simulates a user releasing a key.
-
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.
-
typeAndWait
(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.
-
typeKeys
(locator - value)Simulates keystroke events on the specified element, as though you typed the value key-by-key.
This is a convenience method for calling keyDown, keyUp, keyPress for every character in the specified string; this is useful for dynamic UI widgets (like auto-completing combo boxes) that require explicit key events.
Unlike the simple "type" command, which forces the specified value into the page directly, this command may or may not have any visible effect, even in cases where typing keys would normally have a visible effect. For example, if you use "typeKeys" on a form element, you may or may not see the results of what you typed in the field.
In some cases, you may need to use the simple "type" command to set the value of the field and then the "typeKeys" command to send the keystroke events corresponding to what you just typed.
-
sendKeys
(locator - value) -
typeKeysAndWait
(locator - value)Simulates keystroke events on the specified element, as though you typed the value key-by-key.
This is a convenience method for calling keyDown, keyUp, keyPress for every character in the specified string; this is useful for dynamic UI widgets (like auto-completing combo boxes) that require explicit key events.
Unlike the simple "type" command, which forces the specified value into the page directly, this command may or may not have any visible effect, even in cases where typing keys would normally have a visible effect. For example, if you use "typeKeys" on a form element, you may or may not see the results of what you typed in the field.
In some cases, you may need to use the simple "type" command to set the value of the field and then the "typeKeys" command to send the keystroke events corresponding to what you just typed.
Keyboard Modifiers
-
altKeyDown
Press the alt key and hold it down until doAltUp() is called or a new page is loaded.
-
altKeyDownAndWait
Press the alt key and hold it down until doAltUp() is called or a new page is loaded.
-
altKeyUp
Release the alt key.
-
altKeyUpAndWait
Release the alt key.
-
controlKeyDown
Press the control key and hold it down until doControlUp() is called or a new page is loaded.
-
controlKeyDownAndWait
Press the control key and hold it down until doControlUp() is called or a new page is loaded.
-
controlKeyUp
Release the control key.
-
controlKeyUpAndWait
Release the control key.
-
metaKeyDown
Press the meta key and hold it down until doMetaUp() is called or a new page is loaded.
-
metaKeyUp
Release the meta key.
-
metaKeyUpAndWait
Release the meta key.
-
shiftKeyDown
Press the shift key and hold it down until doShiftUp() is called or a new page is loaded.
-
shiftKeyDownAndWait
Press the shift key and hold it down until doShiftUp() is called or a new page is loaded.
-
shiftKeyUp
Release the shift key.
-
shiftKeyUpAndWait
Release the shift key.
Mouse Events
-
mouseDown
(locator)Simulates a user pressing the left mouse button (without releasing it yet) on the specified element.
-
mouseDownAndWait
(locator)Simulates a user pressing the left mouse button (without releasing it yet) on the specified element.
-
mouseDownAt
(locator - coordString)Simulates a user pressing the left mouse button (without releasing it yet) at the specified location.
-
mouseDownAtAndWait
(locator - coordString)Simulates a user pressing the left mouse button (without releasing it yet) at the specified location.
-
mouseDownRight
(locator)Simulates a user pressing the right mouse button (without releasing it yet) on the specified element.
-
mouseDownRightAndWait
(locator)Simulates a user pressing the right mouse button (without releasing it yet) on the specified element.
-
mouseDownRightAt
(locator - coordString)Simulates a user pressing the right mouse button (without releasing it yet) at the specified location.
-
mouseDownRightAtAndWait
(locator - coordString)Simulates a user pressing the right mouse button (without releasing it yet) at the specified location.
-
mouseMove
(locator)Simulates a user pressing the mouse button (without releasing it yet) on the specified element.
-
mouseMoveAndWait
(locator)Simulates a user pressing the mouse button (without releasing it yet) on the specified element.
-
mouseMoveAt
(locator - coordString)Simulates a user pressing the mouse button (without releasing it yet) on the specified element.
-
mouseMoveAtAndWait
(locator - coordString)Simulates a user pressing the mouse button (without releasing it yet) on the specified element.
-
mouseOut
(locator)Simulates a user moving the mouse pointer away from the specified element.
-
mouseOutAndWait
(locator)Simulates a user moving the mouse pointer away from the specified element.
-
mouseOver
(locator)Simulates a user hovering a mouse over the specified element.
-
mouseOverAndWait
(locator)Simulates a user hovering a mouse over the specified element.
-
mouseUp
(locator)Simulates the event that occurs when the user releases the mouse button (i.e., stops holding the button down) on the specified element.
-
mouseUpAndWait
(locator)Simulates the event that occurs when the user releases the mouse button (i.e., stops holding the button down) on the specified element.
-
mouseUpAt
(locator - coordString)Simulates the event that occurs when the user releases the mouse button (i.e., stops holding the button down) at the specified location.
-
mouseUpAtAndWait
(locator - coordString)Simulates the event that occurs when the user releases the mouse button (i.e., stops holding the button down) at the specified location.
-
mouseUpRight
(locator)Simulates the event that occurs when the user releases the right mouse button (i.e., stops holding the button down) on the specified element.
-
mouseUpRightAndWait
(locator)Simulates the event that occurs when the user releases the right mouse button (i.e., stops holding the button down) on the specified element.
-
mouseUpRightAt
(locator - coordString)Simulates the event that occurs when the user releases the right mouse button (i.e., stops holding the button down) at the specified location.
-
mouseUpRightAtAndWait
(locator - coordString)Simulates the event that occurs when the user releases the right mouse button (i.e., stops holding the button down) at the specified location.
Popups and Menus
-
answerOnNextPrompt
(answer)Instructs Selenium to return the specified answer string in response to the next JavaScript prompt [window.prompt()].
-
answerOnNextPromptAndWait
(answer)Instructs Selenium to return the specified answer string in response to the next JavaScript prompt [window.prompt()].
-
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. Selenium will then resume using the default behavior for future confirmations, automatically returning true (OK) unless/until you explicitly call this command for each confirmation.
Take note - every time a confirmation comes up, you must consume it with a corresponding getConfirmation, or else the next selenium operation will fail.
-
chooseCancelOnNextConfirmationAndWait
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. Selenium will then resume using the default behavior for future confirmations, automatically returning true (OK) unless/until you explicitly call this command for each confirmation.
Take note - every time a confirmation comes up, you must consume it with a corresponding getConfirmation, or else the next selenium operation will fail.
-
chooseOkOnNextConfirmation
Undo the effect of calling chooseCancelOnNextConfirmation. Note that Selenium's overridden window.confirm() function will normally automatically return true, as if the user had manually clicked OK, so you shouldn't need to use this command unless for some reason you need to change your mind prior to the next confirmation. After any confirmation, Selenium will resume using the default behavior for future confirmations, automatically returning true (OK) unless/until you explicitly call chooseCancelOnNextConfirmation for each confirmation.
Take note - every time a confirmation comes up, you must consume it with a corresponding getConfirmation, or else the next selenium operation will fail.
-
chooseOkOnNextConfirmationAndWait
Undo the effect of calling chooseCancelOnNextConfirmation. Note that Selenium's overridden window.confirm() function will normally automatically return true, as if the user had manually clicked OK, so you shouldn't need to use this command unless for some reason you need to change your mind prior to the next confirmation. After any confirmation, Selenium will resume using the default behavior for future confirmations, automatically returning true (OK) unless/until you explicitly call chooseCancelOnNextConfirmation for each confirmation.
Take note - every time a confirmation comes up, you must consume it with a corresponding getConfirmation, or else the next selenium operation will fail.
-
contextMenu
(locator)Simulates opening the context menu for the specified element (as might happen if the user "right-clicked" on the element).
-
contextMenuAndWait
(locator)Simulates opening the context menu for the specified element (as might happen if the user "right-clicked" on the element).
-
contextMenuAt
(locator - coordString)Simulates opening the context menu for the specified element (as might happen if the user "right-clicked" on the element).
-
contextMenuAtAndWait
(locator - coordString)Simulates opening the context menu for the specified element (as might happen if the user "right-clicked" on the element).
-
selectPopUp
(windowID)Simplifies the process of selecting a popup window (and does not offer functionality beyond what
selectWindow()
already provides). - If
- Otherwise, the window will be looked up considering
-
deselectPopUp
Selects the main window. Functionally equivalent to using
selectWindow()
and specifying no value forwindowID
. -
getAlert
Retrieves the message of a JavaScript 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 consume it with getAlert, the next Selenium action will fail.
Under Selenium, JavaScript alerts will NOT pop up a visible alert dialog.
Selenium does NOT support JavaScript 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.
-
getConfirmation
Retrieves the message of a JavaScript 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 consume it with getConfirmation, the next Selenium action will fail.
NOTE: under Selenium, JavaScript confirmations will NOT pop up a visible dialog.
NOTE: Selenium does NOT support JavaScript 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.
-
getPrompt
Retrieves the message of a JavaScript 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, JavaScript prompts will NOT pop up a visible dialog.
NOTE: Selenium does NOT support JavaScript 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.
-
getWhetherThisFrameMatchFrameExpression
(currentFrameString - target)Determine whether current/locator identify the frame containing this running code.
This is useful in proxy injection mode, where this code runs in every browser frame and window, and sometimes the selenium server needs to identify the "current" frame. In this case, when the test calls selectFrame, this routine is called for each frame to figure out which one has been selected. The selected frame will return true, while all others will return false.
-
getWhetherThisWindowMatchWindowExpression
(currentWindowString - target)Determine whether currentWindowString plus target identify the window containing this running code.
This is useful in proxy injection mode, where this code runs in every browser frame and window, and sometimes the selenium server needs to identify the "current" window. In this case, when the test calls selectWindow, this routine is called for each window to figure out which one has been selected. The selected window will return true, while all others will return false.
windowID
is either not specified, or specified as
"null", the first non-top window is selected. The top window is the one
that would be selected by selectWindow()
without providing a
windowID
. This should not be used when more than one popup
window is in play.
windowID
as the following in order: 1) the "name" of the
window, as specified to window.open()
; 2) a javascript
variable which is a reference to a window; and 3) the title of the
window. This is the same ordered lookup performed by
selectWindow
.
Browser Window
-
verifyAllWindowIds
(equalTo) -
verifyAllWindowNames
(equalTo) -
verifyAllWindowTitles
(equalTo) -
verifyAttributeFromAllWindows
(attributeName - equalTo) -
verifyLocation
(equalTo) -
verifyNotAllWindowIds
(equalTo) -
verifyNotAllWindowNames
(equalTo) -
verifyNotAttributeFromAllWindows
(attributeName - equalTo) -
verifyNotLocation
(equalTo) -
verifyNotTitle
(equalTo) -
verifyTitle
(equalTo) -
assertAllWindowIds
(equalTo) -
assertAllWindowNames
(equalTo) -
assertAllWindowTitles
(equalTo) -
assertAttributeFromAllWindows
(attributeName - equalTo) -
assertLocation
(equalTo) -
assertNotAllWindowIds
(equalTo) -
assertNotAllWindowNames
(equalTo) -
assertNotAllWindowTitles
(equalTo) -
assertNotAttributeFromAllWindows
(attributeName) -
assertNotLocation
(equalTo) -
assertNotTitle
(equalTo) -
assertTitle
(equalTo) -
assert
Check that a variable is an expected value. The variable's value will be converted to a string for comparison. The test will stop if the assert fails.
-
validateXml
Custom command by TestingBot. Validates if the document contents is valid XML.
-
waitForAlert
(equalTo) -
waitForAlertNotPresent
-
waitForAlertPresent
-
waitForConfirmation
(equalTo) -
waitForConfirmationNotPresent
-
waitForConfirmationPresent
-
waitForNotAlert
(equalTo) -
waitForNotConfirmation
(equalTo) -
waitForNotPrompt
(equalTo) -
waitForPrompt
(equalTo) -
waitForPromptNotPresent
-
waitForPromptPresent
-
storeAllWindowIds
-
storeAllWindowNames
-
storeAllWindowTitles
-
storeAttributeFromAllWindows
(attributeName - variable) -
storeLocation
-
storeTitle
-
storeAllWindowHandles
-
storeNewWindowHandle
-
storeWindowHandle
-
setWindowSize
(size)Sets the current window size.
Cookies
-
verifyCookie
(equalTo) -
verifyCookieByName
(name - equalTo) -
verifyCookieNotPresent
(name) -
verifyCookiePresent
(name) -
verifyNotCookie
(equalTo) -
verifyNotCookieByName
(name - equalTo) -
assertCookie
(equalTo) -
assertCookieByName
(name - equalTo) -
assertCookieNotPresent
(name) -
assertCookiePresent
(name) -
assertNotCookie
(equalTo) -
assertNotCookieByName
(name - equalTo) -
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.
-
deleteAllVisibleCookies
Calls deleteCookie with recurse=true on all cookies visible to the current page. As noted on the documentation for deleteCookie, recurse=true can be much slower than simply deleting the cookies using a known domain/path.
-
deleteCookie
(name - optionsString)Delete a named cookie with specified path and domain. Be careful; to delete a cookie, you need to delete it using the exact same path and domain that were used to create the cookie. If the path is wrong, or the domain is wrong, the cookie simply won't be deleted. Also note that specifying a domain that isn't a subset of the current domain will usually fail. Since there's no way to discover at runtime the original path and domain of a given cookie, we've added an option called 'recurse' to try all sub-domains of the current domain with all paths that are a subset of the current path. Beware; this option can be slow. In big-O notation, it operates in O(n*m) time, where n is the number of dots in the domain name and m is the number of slashes in the path.
-
storeCookie
-
storeCookieByName
(name - variable) -
storeCookiePresent
(name - variable)
Page Content
-
verifyAllLinks
(equalTo) -
verifyAttribute
(attributeLocator - equalTo) -
verifyBodyText
(equalTo) -
verifyElementNotPresent
(locator) -
verifyElementPresent
(locator) -
verifyHtmlSource
(equalTo) -
verifyNotAllLinks
(equalTo) -
verifyNotAttribute
(attributeLocator) -
verifyNotBodyText
(equalTo) -
verifyNotHtmlSource
(equalTo) -
verifyNotOrdered
(locator1 - locator2) -
verifyNotTable
(tableCellAddress - equalTo) -
verifyNotText
(locator - equalTo) -
verifyNotVisible
(locator) -
verifyOrdered
(locator1 - locator2) -
verifyTable
(tableCellAddress - equalTo) -
verifyText
(locator - equalTo) -
verifyTextNotPresent
(pattern) -
verifyTextPresent
(pattern) -
verifyVisible
(locator) -
assertAllLinks
(equalTo) -
assertAttribute
(attributeLocator - equalTo) -
assertBodyText
(equalTo) -
assertElementNotPresent
(locator) -
assertElementPresent
(locator) -
assertHtmlSource
(equalTo) -
assertNotAllLinks
(equalTo) -
assertNotAttribute
(attributeLocator - equalTo) -
assertNotBodyText
(equalTo) -
assertNotHtmlSource
(equalTo) -
assertNotOrdered
(locator1 - locator2) -
assertNotTable
(tableCellAddress - equalTo) -
assertNotText
(locator - equalTo) -
assertNotVisible
(locator) -
assertOrdered
(locator1 - locator2) -
assertTable
(tableCellAddress - equalTo) -
assertText
(locator - equalTo) -
assertTextNotPresent
(pattern) -
assertTextPresent
(pattern) -
assertVisible
(locator) -
waitForAllLinks
(equalTo) -
waitForAttribute
(attributeLocator - equalTo) -
waitForBodyText
(equalTo) -
waitForElementPresent
(locator) -
waitForHtmlSource
(equalTo) -
waitForNotAllLinks
(equalTo) -
waitForNotAttribute
(attributeLocator - equalTo) -
waitForNotBodyText
(equalTo) -
waitForElementNotPresent
(locator) -
waitForElementNotVisible
(locator) -
waitForElementVisible
(locator) -
waitForNotHtmlSource
(equalTo) -
waitForNotOrdered
(locator1 - locator2) -
waitForNotTable
(tableCellAddress - equalTo) -
waitForNotText
(locator - equalTo) -
waitForNotVisible
(locator) -
waitForOrdered
(locator1 - locator2) -
waitForTable
(tableCellAddress - equalTo) -
waitForText
(locator - equalTo) -
waitForTextNotPresent
(pattern) -
waitForTextPresent
(pattern) -
waitForVisible
(locator) -
storeAllLinks
-
storeAttribute
(attributeLocator - variable) -
storeBodyText
-
storeElementPresent
(locator - variable) -
storeHtmlSource
-
storeTable
(tableCellAddress - variable) -
storeText
(locator - variable) -
storeTextPresent
(pattern - variable) -
storeVisible
(locator - variable)
Page Positioning
-
verifyElementHeight
(locator - equalTo) -
verifyElementIndex
(locator - equalTo) -
verifyElementPositionLeft
(locator - equalTo) -
verifyElementPositionTop
(locator - equalTo) -
verifyElementWidth
(locator - equalTo) -
verifyNotElementHeight
(locator - equalTo) -
verifyNotElementIndex
(locator - equalTo) -
verifyNotElementPositionLeft
(locator - equalTo) -
verifyNotElementPositionTop
(locator - equalTo) -
verifyNotElementWidth
(locator - equalTo) -
assertElementHeight
(locator - equalTo) -
assertElementIndex
(locator - equalTo) -
assertElementPositionLeft
(locator - equalTo) -
assertElementPositionTop
(locator - equalTo) -
assertElementWidth
(locator - equalTo) -
assertNotElementHeight
(locator - equalTo) -
assertNotElementIndex
(locator - equalTo) -
assertNotElementPositionLeft
(locator - equalTo) -
assertNotElementPositionTop
(locator - equalTo) -
assertNotElementWidth
-
storeElementHeight
(locator - variable) -
storeElementIndex
(locator - variable) -
storeElementPositionLeft
(locator - variable) -
storeElementPositionTop
(locator - variable) -
storeElementWidth
(locator - variable)
Popups
-
verifyAlert
(equalTo) -
verifyAlertNotPresent
-
verifyAlertPresent
-
isAlertPresent
Has an alert occurred?
This function never throws an exception
-
verifyConfirmation
(equalTo) -
verifyConfirmationNotPresent
-
verifyConfirmationPresent
-
isConfirmationPresent
Has confirm() been called?
This function never throws an exception
-
verifyNotAlert
(equalTo) -
verifyNotConfirmation
(equalTo) -
verifyNotPrompt
(equalTo) -
verifyPrompt
(equalTo) -
verifyPromptNotPresent
-
verifyPromptPresent
-
isPromptPresent
Has a prompt occurred?
This function never throws an exception
-
assertAlert
(equalTo) -
assertAlertNotPresent
-
assertAlertPresent
-
assertConfirmation
(equalTo) -
assertConfirmationNotPresent
-
assertConfirmationPresent
-
assertNotAlert
(equalTo) -
assertNotConfirmation
(equalTo) -
assertNotPrompt
(equalTo) -
assertPrompt
(equalTo) -
assertPromptNotPresent
-
assertPromptPresent
-
waitForElementHeight
(locator - equalTo) -
waitForElementIndex
(locator - equalTo) -
waitForElementPositionLeft
(locator - equalTo) -
waitForElementPositionTop
(locator - equalTo) -
waitForElementWidth
(locator - equalTo) -
waitForNotElementHeight
(locator - equalTo) -
waitForNotElementIndex
(locator - equalTo) -
waitForNotElementPositionLeft
(locator - equalTo) -
waitForNotElementPositionTop
(locator - equalTo) -
waitForNotElementWidth
(locator - equalTo) -
waitForPopUp
(windowID - timeout)Waits for a popup window to appear and load up.
-
storeAlert
-
storeAlertPresent
-
storeConfirmation
-
storeConfirmationPresent
-
storePrompt
-
storePromptPresent
Selenium
-
verifyEval
(script - equalTo) -
verifyExpression
(expression - equalTo) -
verifyMouseSpeed
-
verifyNotEval
(script - equalTo) -
verifyNotExpression
(expression - equalTo) -
verifyNotMouseSpeed
-
verifyNotSpeed
-
verifyNotXpathCount
(xpath - equalTo) -
verifySpeed
-
verifyXpathCount
(xpath - equalTo) -
assertEval
(script - equalTo) -
assertExpression
(expression - equalTo) -
assertMouseSpeed
(equalTo) -
assertNotEval
(script - equalTo) -
assertNotExpression
(expression - equalTo) -
assertNotMouseSpeed
(equalTo) -
assertNotSpeed
(equalTo) -
assertNotXpathCount
(xpath - equalTo) -
assertSpeed
(equalTo) -
assertXpathCount
(xpath - equalTo) -
waitForAllButtons
(equalTo) -
waitForAllFields
(equalTo) -
waitForChecked
(locator) -
waitForCursorPosition
(locator - equalTo) -
waitForCondition
(script - timeout)Runs the specified JavaScript 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 JavaScript snippet
selenium.browserbot.getCurrentWindow()
, and then run your JavaScript in there -
waitForEditable
(locator) -
waitForEval
(script - equalTo) -
waitForExpression
(expression - equalTo) -
waitForMouseSpeed
(equalTo) -
waitForNotAllButtons
(equalTo) -
waitForNotAllFields
(equalTo) -
waitForNotChecked
(locator) -
waitForNotCursorPosition
(locator - equalTo) -
waitForNotEditable
(locator) -
waitForNotEval
(script - equalTo) -
waitForNotExpression
(expression - equalTo) -
waitForNotMouseSpeed
(equalTo) -
waitForNotSelectedIds
(selectLocator - equalTo) -
waitForNotSelectedIndexes
(selectLocator - equalTo) -
waitForNotSelectedLabels
(selectLocator - equalTo) -
waitForNotSelectedValues
(selectLocator - equalTo) -
waitForNotSelectOptions
(selectLocator - equalTo) -
waitForNotSomethingSelected
(selectLocator) -
waitForNotSpeed
(equalTo) -
waitForNotValue
(locator - equalTo) -
waitForNotXpathCount
(xpath - equalTo) -
waitForSelectedIds
(selectLocator - equalTo) -
waitForSelectedIndexes
(selectLocator - equalTo) -
waitForSelectedLabels
(selectLocator - equalTo) -
waitForSelectedValues
(selectLocator - equalTo) -
waitForSelectOptions
(selectLocator - equalTo) -
waitForSomethingSelected
(selectLocator) -
waitForSpeed
(equalTo) -
waitForValue
(locator - equalTo) -
waitForXpathCount
(xpath - equalTo) -
storeEval
(script - variable) -
storeExpression
(expression - variable) -
store
(expression - variable)This command is a synonym for storeExpression.
-
storeMouseSpeed
-
storeSpeed
-
storeXpathCount
(xpath - variable)
Screenshots
-
captureEntirePageScreenshot
(filename - kwargs)Saves the entire contents of the current window canvas to a PNG file. Contrast this with the captureScreenshot command, which captures the contents of the OS viewport (i.e. whatever is currently being displayed on the monitor), and is implemented in the RC only. Currently this only works in Firefox when running in chrome mode, and in IE non-HTA using the EXPERIMENTAL "Snapsie" utility. The Firefox implementation is mostly borrowed from the Screengrab! Firefox extension. Please see http://www.screengrab.org and http://snapsie.sourceforge.net/ for details.
Selenium Settings
-
waitForCookie
(equalTo) -
waitForCookieByName
(name - equalTo) -
waitForCookieNotPresent
(name) -
waitForCookiePresent
(name) -
waitForNotCookie
(equalTo) -
waitForNotCookieByName
(name - equalTo) -
addLocationStrategy
(strategyName - functionDefinition)Defines a new function for Selenium to locate elements on the page. For example, if you define the strategy "foo", and someone runs click("foo=blah"), we'll run your function, passing you the string "blah", and click on the element that your function returns, or throw an "Element not found" error if your function returns null. We'll pass three arguments to your function:
- locator: the string the user passed in
- inWindow: the currently selected window
- inDocument: the currently selected document The function must return null if the element can't be found.
-
allowNativeXpath
(allow)Specifies whether Selenium should use the native in-browser implementation of XPath (if any native version is available); if you pass "false" to this function, we will always use our pure-JavaScript xpath library. Using the pure-JS xpath library can improve the consistency of xpath element locators between different browser vendors, but the pure-JS version is much slower than the native implementations.
-
ignoreAttributesWithoutValue
(ignore)Specifies whether Selenium will ignore xpath attributes that have no value, i.e. are the empty string, when using the non-native xpath evaluation engine. You'd want to do this for performance reasons in IE. However, this could break certain xpaths, for example an xpath that looks for an attribute whose value is NOT the empty string. The hope is that such xpaths are relatively rare, but the user should have the option of using them. Note that this only influences xpath evaluation when using the ajaxslt engine (i.e. not "javascript-xpath").
-
setBrowserLogLevel
(logLevel)Sets the threshold for browser-side logging messages; log messages beneath this threshold will be discarded. Valid logLevel strings are: "debug", "info", "warn", "error" or "off". To see the browser logs, you need to either show the log window in GUI mode, or enable browser-side logging in Selenium RC.
-
setMouseSpeed
(pixels)Configure the number of pixels between "mousemove" events during dragAndDrop commands (default=10).
Setting this value to 0 means that we'll send a "mousemove" event to every single pixel in between the start location and the end location; that can be very slow, and may cause some browsers to force the JavaScript to timeout.
If the mouse speed is greater than the distance between the two dragged objects, we'll just send one "mousemove" at the start location and then one final one at the end location.
-
setSpeed
(value)Set execution speed (i.e., set the millisecond length of a delay which will follow each selenium operation). By default, there is no such delay, i.e., the delay is 0 milliseconds.
-
getSpeed
Get execution speed (i.e., get the millisecond length of the delay following each selenium operation). By default, there is no such delay, i.e., the delay is 0 milliseconds. See also setSpeed.
-
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. -
useXpathLibrary
(libraryName)Allows choice of one of the available libraries.
Special
-
addScript
(scriptContent - scriptTagId)Loads script content into a new script tag in the Selenium document. This differs from the runScript command in that runScript adds the script tag to the document of the AUT, not the Selenium document. The following entities in the script content are replaced by the characters they represent: < > & The corresponding remove command is removeScript.
-
assignId
(locator - identifier)Temporarily sets the "id" attribute of the specified element, so you can locate it in the future using its ID rather than a slow/complicated XPath. This ID will disappear once the page is reloaded.
-
echo
(message)Prints the specified message into the third table cell in your Selenese tables. Useful for debugging.
-
fireEvent
(locator - eventName)Explicitly simulate an event, to trigger the corresponding "onevent" handler.
-
highlight
(locator)Briefly changes the backgroundColor of the specified element yellow. Useful for debugging.
-
rollup
(rollupName - kwargs)Executes a command rollup, which is a series of commands with a unique name, and optionally arguments that control the generation of the set of commands. If any one of the rolled-up commands fails, the rollup is considered to have failed. Rollups may also contain nested rollups.
-
runScript
(script)Creates a new "script" tag in the body of the current test window, and adds the specified text into the body of the command. Scripts run in this way can often be debugged more easily than scripts executed using Selenium's "getEval" command. Beware that JS exceptions thrown in these script tags aren't managed by Selenium, so you should probably wrap your script in try/catch blocks if there is any chance that the script will throw an exception.
-
getEval
(command)Gets the result of evaluating the specified JavaScript 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, so
this
will refer to the Selenium object. Usewindow
to refer to the window of your application, e.g.window.document.getElementById('foo')
If you need to use a locator to refer to a single element in your application page, you can use
this.browserbot.findElement("id=foo")
where "id=foo" is your locator. -
getLocation
Gets the absolute URL of the current page.
-
getTitle
Gets the title of the current page.
-
getBodyText
Gets the entire text of the page.
-
getValue
(locator)Gets the (whitespace-trimmed) value of an input field (or anything else with a value parameter). For checkbox/radio elements, the value will be "on" or "off" depending on whether the element is checked or not.
-
getText
(locator)Gets the text of an element. This works for any element that contains text. This command uses either the textContent (Mozilla-like browsers) or the innerText (IE-like browsers) of the element, which is the rendered text shown to the user.
-
getTable
(tableCellAddress)Gets the text from a cell of a table. The cellAddress syntax tableLocator.row.column, where row and column start at 0.
-
pause
(time)Wait for the specified amount of time (in milliseconds)
-
comment
(text)Custom command by TestingBot. Add a comment between your test steps. This will show up in the test results.
-
getHtmlSource
Returns the entire HTML source between the opening and closing "html" tags.
-
stopTest
(condition)Custom command by TestingBot. Will stop the test if the supplied condition is met. Other steps, which resulted in an error, after a successful stopTest, will no longer indicate a test as failed.
Common
-
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.