WebDriverBackedSelenium ClassWebDriver
Provides a Selenium instance that processes its commands via an IWebDriver instance.
Inheritance Hierarchy

SystemObject
  SeleniumDefaultSelenium
    SeleniumWebDriverBackedSelenium

Namespace: Selenium
Assembly: Selenium.WebDriverBackedSelenium (in Selenium.WebDriverBackedSelenium.dll) Version: 3.1.0
Syntax

public class WebDriverBackedSelenium : DefaultSelenium

The WebDriverBackedSelenium type exposes the following members.

Constructors

  NameDescription
Public methodWebDriverBackedSelenium(IWebDriver, String)
Initializes a new instance of the WebDriverBackedSelenium class using the specified WebDriver driver and base URL.
Public methodWebDriverBackedSelenium(IWebDriver, Uri)
Initializes a new instance of the WebDriverBackedSelenium class using the specified WebDriver driver and base URL.
Top
Properties

  NameDescription
Public propertyProcessor
The command processor that handles all of our Selenium commands
(Inherited from DefaultSelenium.)
Public propertyUnderlyingWebDriver
Gets the underlying IWebDriver object used to drive the browser for this instance of Selenium.
Top
Methods

  NameDescription
Public methodAddLocationStrategy
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.
(Inherited from DefaultSelenium.)
Public methodAddScript
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.
(Inherited from DefaultSelenium.)
Public methodAddSelection
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
(Inherited from DefaultSelenium.)
Public methodAllowNativeXpath
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.
(Inherited from DefaultSelenium.)
Public methodAltKeyDown
Press the alt key and hold it down until doAltUp() is called or a new page is loaded.
(Inherited from DefaultSelenium.)
Public methodAltKeyUp
Release the alt key.
(Inherited from DefaultSelenium.)
Public methodAnswerOnNextPrompt
Instructs Selenium to return the specified answer string in response to the next JavaScript prompt [window.prompt()].
(Inherited from DefaultSelenium.)
Public methodAssignId
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.
(Inherited from DefaultSelenium.)
Public methodAttachFile
Sets a file input (upload) field to the file listed in fileLocator
(Inherited from DefaultSelenium.)
Public methodCaptureEntirePageScreenshot
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.
(Inherited from DefaultSelenium.)
Public methodCaptureEntirePageScreenshotToString
Downloads a screenshot of the browser current window canvas to a based 64 encoded PNG file. The entire windows canvas is captured, including parts rendered outside of the current view port. Currently this only works in Mozilla and when running in chrome mode.
(Inherited from DefaultSelenium.)
Public methodCaptureNetworkTraffic
Captures the Network Traffic that is passing through Selenium Server
(Inherited from DefaultSelenium.)
Public methodCaptureScreenshot
Captures a PNG screenshot to the specified file.
(Inherited from DefaultSelenium.)
Public methodCaptureScreenshotToString
Capture a PNG screenshot. It then returns the file as a base 64 encoded string.
(Inherited from DefaultSelenium.)
Public methodCheck
Check a toggle-button (checkbox/radio)
(Inherited from DefaultSelenium.)
Public methodChooseCancelOnNextConfirmation

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.

(Inherited from DefaultSelenium.)
Public methodChooseOkOnNextConfirmation

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.

(Inherited from DefaultSelenium.)
Public methodClick
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.
(Inherited from DefaultSelenium.)
Public methodClickAt
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.
(Inherited from DefaultSelenium.)
Public methodClose
Simulates the user clicking the "close" button in the titlebar of a popup window or tab.
(Inherited from DefaultSelenium.)
Public methodContextMenu
Simulates opening the context menu for the specified element (as might happen if the user "right-clicked" on the element).
(Inherited from DefaultSelenium.)
Public methodContextMenuAt
Simulates opening the context menu for the specified element (as might happen if the user "right-clicked" on the element).
(Inherited from DefaultSelenium.)
Public methodControlKeyDown
Press the control key and hold it down until doControlUp() is called or a new page is loaded.
(Inherited from DefaultSelenium.)
Public methodControlKeyUp
Release the control key.
(Inherited from DefaultSelenium.)
Public methodCreateCookie
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.
(Inherited from DefaultSelenium.)
Public methodDeleteAllVisibleCookies
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.
(Inherited from DefaultSelenium.)
Public methodDeleteCookie
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.
(Inherited from DefaultSelenium.)
Public methodDeselectPopUp
Selects the main window. Functionally equivalent to using
selectWindow()
and specifying no value for
windowID
.
(Inherited from DefaultSelenium.)
Public methodDoubleClick
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.
(Inherited from DefaultSelenium.)
Public methodDoubleClickAt
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.
(Inherited from DefaultSelenium.)
Public methodDragAndDrop
Drags an element a certain distance and then drops it
(Inherited from DefaultSelenium.)
Public methodDragAndDropToObject
Drags an element and drops it on another element
(Inherited from DefaultSelenium.)
Public methodDragdrop
deprecated - use dragAndDrop instead
(Inherited from DefaultSelenium.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFireEvent
Explicitly simulate an event, to trigger the corresponding "onevent" handler.
(Inherited from DefaultSelenium.)
Public methodFocus
Move the focus to the specified element; for example, if the element is an input field, move the cursor to that field.
(Inherited from DefaultSelenium.)
Public methodGetAlert
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.

(Inherited from DefaultSelenium.)
Public methodGetAllButtons
Returns the IDs of all buttons on the page.

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

(Inherited from DefaultSelenium.)
Public methodGetAllFields
Returns the IDs of all input fields on the page.

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

(Inherited from DefaultSelenium.)
Public methodGetAllLinks
Returns the IDs of all links on the page.

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

(Inherited from DefaultSelenium.)
Public methodGetAllWindowIds
Returns the IDs of all windows that the browser knows about in an array.
(Inherited from DefaultSelenium.)
Public methodGetAllWindowNames
Returns the names of all windows that the browser knows about in an array.
(Inherited from DefaultSelenium.)
Public methodGetAllWindowTitles
Returns the titles of all windows that the browser knows about in an array.
(Inherited from DefaultSelenium.)
Public methodGetAttribute
Gets the value of an element attribute. The value of the attribute may differ across browsers (this is the case for the "style" attribute, for example).
(Inherited from DefaultSelenium.)
Public methodGetAttributeFromAllWindows
Returns an array of JavaScript property values from all known windows having one.
(Inherited from DefaultSelenium.)
Public methodGetBodyText
Gets the entire text of the page.
(Inherited from DefaultSelenium.)
Public methodGetConfirmation
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.

(Inherited from DefaultSelenium.)
Public methodGetCookie
Return all cookies of the current page under test.
(Inherited from DefaultSelenium.)
Public methodGetCookieByName
Returns the value of the cookie with the specified name, or throws an error if the cookie is not present.
(Inherited from DefaultSelenium.)
Public methodGetCSSCount
Returns the number of nodes that match the specified css, eg. "css=table" would give the number of tables.
(Inherited from DefaultSelenium.)
Public methodGetCursorPosition
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 JavaScript, 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 as SEL-243.

This method will fail if the specified element isn't an input element or textarea, or there is no cursor in the element.
(Inherited from DefaultSelenium.)
Public methodGetElementHeight
Retrieves the height of an element
(Inherited from DefaultSelenium.)
Public methodGetElementIndex
Get the relative index of an element to its parent (starting from 0). The comment node and empty text node will be ignored.
(Inherited from DefaultSelenium.)
Public methodGetElementPositionLeft
Retrieves the horizontal position of an element
(Inherited from DefaultSelenium.)
Public methodGetElementPositionTop
Retrieves the vertical position of an element
(Inherited from DefaultSelenium.)
Public methodGetElementWidth
Retrieves the width of an element
(Inherited from DefaultSelenium.)
Public methodGetEval
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. Use
window
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.

(Inherited from DefaultSelenium.)
Public methodGetExpression
Returns the specified expression.

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

(Inherited from DefaultSelenium.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetHtmlSource
Returns the entire HTML source between the opening and closing "html" tags.
(Inherited from DefaultSelenium.)
Public methodGetLocation
Gets the absolute URL of the current page.
(Inherited from DefaultSelenium.)
Public methodGetMouseSpeed
Returns the number of pixels between "mousemove" events during dragAndDrop commands (default=10).
(Inherited from DefaultSelenium.)
Public methodGetPrompt
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.

(Inherited from DefaultSelenium.)
Public methodGetSelectedId
Gets option element ID for selected option in the specified select element.
(Inherited from DefaultSelenium.)
Public methodGetSelectedIds
Gets all option element IDs for selected options in the specified select or multi-select element.
(Inherited from DefaultSelenium.)
Public methodGetSelectedIndex
Gets option index (option number, starting at 0) for selected option in the specified select element.
(Inherited from DefaultSelenium.)
Public methodGetSelectedIndexes
Gets all option indexes (option number, starting at 0) for selected options in the specified select or multi-select element.
(Inherited from DefaultSelenium.)
Public methodGetSelectedLabel
Gets option label (visible text) for selected option in the specified select element.
(Inherited from DefaultSelenium.)
Public methodGetSelectedLabels
Gets all option labels (visible text) for selected options in the specified select or multi-select element.
(Inherited from DefaultSelenium.)
Public methodGetSelectedValue
Gets option value (value attribute) for selected option in the specified select element.
(Inherited from DefaultSelenium.)
Public methodGetSelectedValues
Gets all option values (value attributes) for selected options in the specified select or multi-select element.
(Inherited from DefaultSelenium.)
Public methodGetSelectOptions
Gets all option labels in the specified select drop-down.
(Inherited from DefaultSelenium.)
Public methodGetSpeed
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.
(Inherited from DefaultSelenium.)
Public methodGetTable
Gets the text from a cell of a table. The cellAddress syntax tableLocator.row.column, where row and column start at 0.
(Inherited from DefaultSelenium.)
Public methodGetText
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.
(Inherited from DefaultSelenium.)
Public methodGetTitle
Gets the title of the current page.
(Inherited from DefaultSelenium.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetValue
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.
(Inherited from DefaultSelenium.)
Public methodGetWhetherThisFrameMatchFrameExpression
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.

(Inherited from DefaultSelenium.)
Public methodGetWhetherThisWindowMatchWindowExpression
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.

(Inherited from DefaultSelenium.)
Public methodGetXpathCount
Returns the number of nodes that match the specified xpath, eg. "//table" would give the number of tables.
(Inherited from DefaultSelenium.)
Public methodGoBack
Simulates the user clicking the "back" button on their browser.
(Inherited from DefaultSelenium.)
Public methodHighlight
Briefly changes the backgroundColor of the specified element yellow. Useful for debugging.
(Inherited from DefaultSelenium.)
Public methodIgnoreAttributesWithoutValue
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").
(Inherited from DefaultSelenium.)
Public methodIsAlertPresent
Has an alert occurred?

This function never throws an exception

(Inherited from DefaultSelenium.)
Public methodIsChecked
Gets whether a toggle-button (checkbox/radio) is checked. Fails if the specified element doesn't exist or isn't a toggle-button.
(Inherited from DefaultSelenium.)
Public methodIsConfirmationPresent
Has confirm() been called?

This function never throws an exception

(Inherited from DefaultSelenium.)
Public methodIsCookiePresent
Returns true if a cookie with the specified name is present, or false otherwise.
(Inherited from DefaultSelenium.)
Public methodIsEditable
Determines whether the specified input element is editable, ie hasn't been disabled. This method will fail if the specified element isn't an input element.
(Inherited from DefaultSelenium.)
Public methodIsElementPresent
Verifies that the specified element is somewhere on the page.
(Inherited from DefaultSelenium.)
Public methodIsOrdered
Check if these two elements have same parent and are ordered siblings in the DOM. Two same elements will not be considered ordered.
(Inherited from DefaultSelenium.)
Public methodIsPromptPresent
Has a prompt occurred?

This function never throws an exception

(Inherited from DefaultSelenium.)
Public methodIsSomethingSelected
Determines whether some option in a drop-down menu is selected.
(Inherited from DefaultSelenium.)
Public methodIsTextPresent
Verifies that the specified text pattern appears somewhere on the rendered page shown to the user.
(Inherited from DefaultSelenium.)
Public methodIsVisible
Determines if the specified element is visible. An element can be rendered invisible by setting the CSS "visibility" property to "hidden", or the "display" property to "none", either for the element itself or one if its ancestors. This method will fail if the element is not present.
(Inherited from DefaultSelenium.)
Public methodKeyDown
Simulates a user pressing a key (without releasing it yet).
(Inherited from DefaultSelenium.)
Public methodKeyDownNative
Simulates a user pressing a key (without releasing it yet) by sending a native operating system keystroke. This function uses the java.awt.Robot class to send a keystroke; this more accurately simulates typing a key on the keyboard. It does not honor settings from the shiftKeyDown, controlKeyDown, altKeyDown and metaKeyDown commands, and does not target any particular HTML element. To send a keystroke to a particular element, focus on the element first before running this command.
(Inherited from DefaultSelenium.)
Public methodKeyPress
Simulates a user pressing and releasing a key.
(Inherited from DefaultSelenium.)
Public methodKeyPressNative
Simulates a user pressing and releasing a key by sending a native operating system keystroke. This function uses the java.awt.Robot class to send a keystroke; this more accurately simulates typing a key on the keyboard. It does not honor settings from the shiftKeyDown, controlKeyDown, altKeyDown and metaKeyDown commands, and does not target any particular HTML element. To send a keystroke to a particular element, focus on the element first before running this command.
(Inherited from DefaultSelenium.)
Public methodKeyUp
Simulates a user releasing a key.
(Inherited from DefaultSelenium.)
Public methodKeyUpNative
Simulates a user releasing a key by sending a native operating system keystroke. This function uses the java.awt.Robot class to send a keystroke; this more accurately simulates typing a key on the keyboard. It does not honor settings from the shiftKeyDown, controlKeyDown, altKeyDown and metaKeyDown commands, and does not target any particular HTML element. To send a keystroke to a particular element, focus on the element first before running this command.
(Inherited from DefaultSelenium.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodMetaKeyDown
Press the meta key and hold it down until doMetaUp() is called or a new page is loaded.
(Inherited from DefaultSelenium.)
Public methodMetaKeyUp
Release the meta key.
(Inherited from DefaultSelenium.)
Public methodMouseDown
Simulates a user pressing the left mouse button (without releasing it yet) on the specified element.
(Inherited from DefaultSelenium.)
Public methodMouseDownAt
Simulates a user pressing the left mouse button (without releasing it yet) at the specified location.
(Inherited from DefaultSelenium.)
Public methodMouseDownRight
Simulates a user pressing the right mouse button (without releasing it yet) on the specified element.
(Inherited from DefaultSelenium.)
Public methodMouseDownRightAt
Simulates a user pressing the right mouse button (without releasing it yet) at the specified location.
(Inherited from DefaultSelenium.)
Public methodMouseMove
Simulates a user pressing the mouse button (without releasing it yet) on the specified element.
(Inherited from DefaultSelenium.)
Public methodMouseMoveAt
Simulates a user pressing the mouse button (without releasing it yet) on the specified element.
(Inherited from DefaultSelenium.)
Public methodMouseOut
Simulates a user moving the mouse pointer away from the specified element.
(Inherited from DefaultSelenium.)
Public methodMouseOver
Simulates a user hovering a mouse over the specified element.
(Inherited from DefaultSelenium.)
Public methodMouseUp
Simulates the event that occurs when the user releases the mouse button (i.e., stops holding the button down) on the specified element.
(Inherited from DefaultSelenium.)
Public methodMouseUpAt
Simulates the event that occurs when the user releases the mouse button (i.e., stops holding the button down) at the specified location.
(Inherited from DefaultSelenium.)
Public methodMouseUpRight
Simulates the event that occurs when the user releases the right mouse button (i.e., stops holding the button down) on the specified element.
(Inherited from DefaultSelenium.)
Public methodMouseUpRightAt
Simulates the event that occurs when the user releases the right mouse button (i.e., stops holding the button down) at the specified location.
(Inherited from DefaultSelenium.)
Public methodOpen
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.
(Inherited from DefaultSelenium.)
Public methodOpenWindow
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").

(Inherited from DefaultSelenium.)
Public methodRefresh
Simulates the user clicking the "Refresh" button on their browser.
(Inherited from DefaultSelenium.)
Public methodRemoveAllSelections
Unselects all of the selected options in a multi-select element.
(Inherited from DefaultSelenium.)
Public methodRemoveScript
Removes a script tag from the Selenium document identified by the given id. Does nothing if the referenced tag doesn't exist.
(Inherited from DefaultSelenium.)
Public methodRemoveSelection
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
(Inherited from DefaultSelenium.)
Public methodRetrieveLastRemoteControlLogs
Retrieve the last messages logged on a specific remote control. Useful for error reports, especially when running multiple remote controls in a distributed environment. The maximum number of log messages that can be retrieve is configured on remote control startup.
(Inherited from DefaultSelenium.)
Public methodRollup
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.
(Inherited from DefaultSelenium.)
Public methodRunScript
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.
(Inherited from DefaultSelenium.)
Public methodSelect
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 on label.

(Inherited from DefaultSelenium.)
Public methodSelectFrame
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"]

(Inherited from DefaultSelenium.)
Public methodSelectPopUp
Simplifies the process of selecting a popup window (and does not offer functionality beyond what
selectWindow()
already provides).
  • If
    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.
  • Otherwise, the window will be looked up considering
    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
    .
(Inherited from DefaultSelenium.)
Public methodSelectWindow
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").

(Inherited from DefaultSelenium.)
Public methodSetBrowserLogLevel
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.
(Inherited from DefaultSelenium.)
Public methodSetContext
Writes a message to the status bar and adds a note to the browser-side log.
(Inherited from DefaultSelenium.)
Public methodSetCursorPosition
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.
(Inherited from DefaultSelenium.)
Public methodSetExtensionJs
Sets the extension Javascript for the session
(Inherited from DefaultSelenium.)
Public methodSetMouseSpeed
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.

(Inherited from DefaultSelenium.)
Public methodSetSpeed
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.
(Inherited from DefaultSelenium.)
Public methodSetTimeout
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.
(Inherited from DefaultSelenium.)
Public methodShiftKeyDown
Press the shift key and hold it down until doShiftUp() is called or a new page is loaded.
(Inherited from DefaultSelenium.)
Public methodShiftKeyUp
Release the shift key.
(Inherited from DefaultSelenium.)
Public methodShutDownSeleniumServer
Kills the running Selenium Server and all browser sessions. After you run this command, you will no longer be able to send commands to the server; you can't remotely start the server once it has been stopped. Normally you should prefer to run the "stop" command, which terminates the current browser session, rather than shutting down the entire server.
(Inherited from DefaultSelenium.)
Public methodStart
Starts a new Selenium testing session
(Inherited from DefaultSelenium.)
Public methodStart(String)
Starts a new Selenium testing session
(Inherited from DefaultSelenium.)
Public methodStop
Ends the current Selenium testing session (normally killing the browser)
(Inherited from DefaultSelenium.)
Public methodSubmit
Submit the specified form. This is particularly useful for forms without submit buttons, e.g. single-input "Search" forms.
(Inherited from DefaultSelenium.)
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Public methodType
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.

(Inherited from DefaultSelenium.)
Public methodTypeKeys
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.

(Inherited from DefaultSelenium.)
Public methodUncheck
Uncheck a toggle-button (checkbox/radio)
(Inherited from DefaultSelenium.)
Public methodUseXpathLibrary
Allows choice of one of the available libraries.
(Inherited from DefaultSelenium.)
Public methodWaitForCondition
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

(Inherited from DefaultSelenium.)
Public methodWaitForFrameToLoad
Waits for a new frame to load.

Selenium constantly keeps track of new pages and frames loading, and sets a "newPageLoaded" flag when it first notices a page load.

See waitForPageToLoad for more information.
(Inherited from DefaultSelenium.)
Public methodWaitForPageToLoad
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.

(Inherited from DefaultSelenium.)
Public methodWaitForPopUp
Waits for a popup window to appear and load up.
(Inherited from DefaultSelenium.)
Public methodWindowFocus
Gives focus to the currently selected window
(Inherited from DefaultSelenium.)
Public methodWindowMaximize
Resize currently selected window to take up the entire screen
(Inherited from DefaultSelenium.)
Top
Fields

  NameDescription
Protected fieldcommandProcessor
An ICommandProcessor object used to process the commands.
(Inherited from DefaultSelenium.)
Top
See Also

Reference