An NDoc Documented Class Library

ISelenium Members

ISelenium overview

Public Instance Methods

AddSelection 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
AltKeyDown Press the alt key and hold it down until doAltUp() is called or a new page is loaded.
AltKeyUp Release the alt key.
AnswerOnNextPrompt Instructs Selenium to return the specified answer string in response to the next JavaScript prompt [window.prompt()].
Check Check a toggle-button (checkbox/radio)
ChooseCancelOnNextConfirmation By default, Selenium's overridden window.confirm() function will return true, as if the user had manually clicked OK. After running this command, the next call to confirm() will return false, as if the user had clicked Cancel.
Click 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 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.
Close Simulates the user clicking the "close" button in the titlebar of a popup window or tab.
ControlKeyDown Press the control key and hold it down until doControlUp() is called or a new page is loaded.
ControlKeyUp Release the control key.
CreateCookie 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.
DeleteCookie Delete a named cookie with specified path.
DoubleClick 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 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 Drags an element a certain distance and then drops it
DragAndDropToObject Drags an element and drops it on another element
Dragdrop deprecated - use dragAndDrop instead
FireEvent Explicitly simulate an event, to trigger the corresponding "onevent" handler.
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 get/verify it, the next Selenium action will fail.NOTE: under Selenium, JavaScript alerts will NOT pop up a visible alert dialog.NOTE: 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.
GetAllButtons Returns the IDs of all buttons on the page. If a given button has no ID, it will appear as "" in this array.
GetAllFields Returns the IDs of all input fields on the page. If a given field has no ID, it will appear as "" in this array.
GetAllLinks Returns the IDs of all links on the page. If a given link has no ID, it will appear as "" in this array.
GetAllWindowIds Returns the IDs of all windows that the browser knows about.
GetAllWindowNames Returns the names of all windows that the browser knows about.
GetAllWindowTitles Returns the titles of all windows that the browser knows about.
GetAttribute Gets the value of an element attribute.
GetAttributeFromAllWindows Returns every instance of some attribute from all known windows.
GetBodyText Gets the entire text of the page.
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 get/verify it, 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.
GetCookie Return all cookies of the current page under test.
GetCursorPosition 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.
GetElementHeight Retrieves the height of an element
GetElementIndex Get the relative index of an element to its parent (starting from 0). The comment node and empty text node will be ignored.
GetElementPositionLeft Retrieves the horizontal position of an element
GetElementPositionTop Retrieves the vertical position of an element
GetElementWidth Retrieves the width of an element
GetEval 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, and 
window
will refer to the top-level runner test window, not the window of your application.If you need a reference to the window of your application, you can refer to 
this.browserbot.getCurrentWindow()
and if you need to use a locator to refer to a single element in your application page, you can use 
this.page().findElement("foo")
where "foo" is your locator.
GetExpression Returns the specified expression. This is useful because of JavaScript preprocessing. It is used to generate commands like assertExpression and waitForExpression.
GetHtmlSource Returns the entire HTML source between the opening and closing "html" tags.
GetLocation Gets the absolute URL of the current page.
GetLogMessages Return the contents of the log. This is a placeholder intended to make the code generator make this API available to clients. The selenium server will intercept this call, however, and return its recordkeeping of log messages since the last call to this API. Thus this code in JavaScript will never be called.The reason I opted for a servercentric solution is to be able to support multiple frames served from different domains, which would break a centralized JavaScript logging mechanism under some conditions.
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.
GetSelectedId Gets option element ID for selected option in the specified select element.
GetSelectedIds Gets all option element IDs for selected options in the specified select or multi-select element.
GetSelectedIndex Gets option index (option number, starting at 0) for selected option in the specified select element.
GetSelectedIndexes Gets all option indexes (option number, starting at 0) for selected options in the specified select or multi-select element.
GetSelectedLabel Gets option label (visible text) for selected option in the specified select element.
GetSelectedLabels Gets all option labels (visible text) for selected options in the specified select or multi-select element.
GetSelectedValue Gets option value (value attribute) for selected option in the specified select element.
GetSelectedValues Gets all option values (value attributes) for selected options in the specified select or multi-select element.
GetSelectOptions Gets all option labels in the specified select drop-down.
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.
GetTable Gets the text from a cell of a table. The cellAddress syntax tableLocator.row.column, where row and column start at 0.
GetText 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.
GetTitle Gets the title of the current page.
GetValue 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.
GetWhetherThisFrameMatchFrameExpression 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 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.
GoBack Simulates the user clicking the "back" button on their browser.
IsAlertPresent Has an alert occurred? This function never throws an exception
IsChecked Gets whether a toggle-button (checkbox/radio) is checked. Fails if the specified element doesn't exist or isn't a toggle-button.
IsConfirmationPresent Has confirm() been called? This function never throws an exception
IsEditable 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.
IsElementPresent Verifies that the specified element is somewhere on the page.
IsOrdered Check if these two elements have same parent and are ordered. Two same elements will not be considered ordered.
IsPromptPresent Has a prompt occurred? This function never throws an exception
IsSomethingSelected Determines whether some option in a drop-down menu is selected.
IsTextPresent Verifies that the specified text pattern appears somewhere on the rendered page shown to the user.
IsVisible 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.
KeyDown Simulates a user pressing a key (without releasing it yet).
KeyPress Simulates a user pressing and releasing a key.
KeyUp Simulates a user releasing a 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.
MouseDown Simulates a user pressing the mouse button (without releasing it yet) on the specified element.
MouseDownAt Simulates a user pressing the mouse button (without releasing it yet) on the specified element.
MouseMove Simulates a user pressing the mouse button (without releasing it yet) on the specified element.
MouseMoveAt Simulates a user pressing the mouse button (without releasing it yet) on the specified element.
MouseOut Simulates a user moving the mouse pointer away from the specified element.
MouseOver Simulates a user hovering a mouse over the specified element.
MouseUp Simulates a user pressing the mouse button (without releasing it yet) on the specified element.
MouseUpAt Simulates a user pressing the mouse button (without releasing it yet) on the specified element.
Open 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 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.
RemoveSelection 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 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.
SelectFrame Selects a frame within the current window. (You may invoke this command multiple times to select nested frames.) To select the parent frame, use "relative=parent" as a locator; to select the top frame, use "relative=top". You may also use a DOM expression to identify the frame you want directly, like this: 
dom=frames["main"].frames["subframe"]
SelectWindow Selects a popup window; once a popup window has been selected, all commands go to that window. To select the main window again, use null as the target. Selenium has several strategies for finding the window object referred to by the "windowID" parameter.1.) if windowID is 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 objects. Each of these string names matches the second parameter "windowName" past to the JavaScript method window.open(url, windowName, windowFeatures, replaceFlag) (which selenium intercepts).If you're having trouble figuring out what is 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").
SetContext Writes a message to the status bar and adds a note to the browser-side log. If logLevelThreshold is specified, set the threshold for logging to that level (debug, info, warn, error).(Note that the browser-side logs will not be sent back to the server, and are invisible to the Client Driver.)
SetCursorPosition 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.
SetSpeed 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.
SetTimeout 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.
ShiftKeyDown Press the shift key and hold it down until doShiftUp() is called or a new page is loaded.
ShiftKeyUp Release the shift key.
Start Launches the browser with a new Selenium session
Stop Ends the test session, killing the browser
Submit Submit the specified form. This is particularly useful for forms without submit buttons, e.g. single-input "Search" forms.
Type 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.
Uncheck Uncheck a toggle-button (checkbox/radio)
WaitForCondition 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
WaitForPageToLoad 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.
WaitForPopUp Waits for a popup window to appear and load up.
WindowFocus Gives focus to a window
WindowMaximize Resize window to take up the entire screen

See Also

ISelenium Interface | Selenium Namespace