An NDoc Documented Class Library

DefaultSelenium Members

DefaultSelenium overview

Public Instance Constructors

DefaultSelenium Overloaded. Initializes a new instance of the DefaultSelenium class.

Public Instance Properties

Processor The command processor that handles all of our Selenium commands

Public Instance Methods

AddSelectionAdd a selection to the set of selected options in a multi-select element using an option locator. @see #doSelect for details of option locators
AnswerOnNextPromptInstructs Selenium to return the specified answer string in response to the next JavaScript prompt [window.prompt()].
CheckCheck a toggle-button (checkbox/radio)
ChooseCancelOnNextConfirmationBy 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.
ClickClicks 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.
CloseSimulates the user clicking the "close" button in the titlebar of a popup window or tab.
Equals (inherited from Object) Determines whether the specified Object is equal to the current Object.
FireEventExplicitly simulate an event, to trigger the corresponding "onevent" handler.
GetAlertRetrieves 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.
GetAllButtonsReturns the IDs of all buttons on the page. If a given button has no ID, it will appear as "" in this array.
GetAllFieldsReturns the IDs of all input fields on the page. If a given field has no ID, it will appear as "" in this array.
GetAllLinksReturns the IDs of all links on the page. If a given link has no ID, it will appear as "" in this array.
GetAttributeGets the value of an element attribute.
GetBodyTextGets the entire text of the page.
GetConfirmationRetrieves 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.
GetCursorPositionRetrieves 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.
GetEvalGets 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.
GetExpressionReturns the specified expression. This is useful because of JavaScript preprocessing. It is used to generate commands like assertExpression and waitForExpression.
GetHashCode (inherited from Object) Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetHtmlSourceReturns the entire HTML source between the opening and closing "html" tags.
GetLocationGets the absolute URL of the current page.
GetPromptRetrieves 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.
GetSelectedIdGets option element ID for selected option in the specified select element.
GetSelectedIdsGets all option element IDs for selected options in the specified select or multi-select element.
GetSelectedIndexGets option index (option number, starting at 0) for selected option in the specified select element.
GetSelectedIndexesGets all option indexes (option number, starting at 0) for selected options in the specified select or multi-select element.
GetSelectedLabelGets option label (visible text) for selected option in the specified select element.
GetSelectedLabelsGets all option labels (visible text) for selected options in the specified select or multi-select element.
GetSelectedValueGets option value (value attribute) for selected option in the specified select element.
GetSelectedValuesGets all option values (value attributes) for selected options in the specified select or multi-select element.
GetSelectOptionsGets all option labels in the specified select drop-down.
GetTableGets the text from a cell of a table. The cellAddress syntax tableLocator.row.column, where row and column start at 0.
GetTextGets 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.
GetTitleGets the title of the current page.
GetType (inherited from Object) Gets the Type of the current instance.
GetValueGets 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.
GoBackSimulates the user clicking the "back" button on their browser.
IsAlertPresentHas an alert occurred? This function never throws an exception
IsCheckedGets whether a toggle-button (checkbox/radio) is checked. Fails if the specified element doesn't exist or isn't a toggle-button.
IsConfirmationPresentHas confirm() been called? This function never throws an exception
IsEditableDetermines 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.
IsElementPresentVerifies that the specified element is somewhere on the page.
IsPromptPresentHas a prompt occurred? This function never throws an exception
IsSomethingSelectedDetermines whether some option in a drop-down menu is selected.
IsTextPresentVerifies that the specified text pattern appears somewhere on the rendered page shown to the user.
IsVisibleDetermines 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.
KeyDownSimulates a user pressing a key (without releasing it yet).
KeyPressSimulates a user pressing and releasing a key.
KeyUpSimulates a user releasing a key.
MouseDownSimulates a user pressing the mouse button (without releasing it yet) on the specified element.
MouseOverSimulates a user hovering a mouse over the specified element.
OpenOpens 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.
RefreshSimulates the user clicking the "Refresh" button on their browser.
RemoveSelectionRemove a selection from the set of selected options in a multi-select element using an option locator. @see #doSelect for details of option locators
SelectSelect 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.
SelectWindowSelects 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.
SetContextWrites 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.)
SetCursorPositionMoves 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.
SetTimeoutSpecifies 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.
Start Starts a new Selenium testing session
Stop Ends the current Selenium testing session (normally killing the browser)
SubmitSubmit the specified form. This is particularly useful for forms without submit buttons, e.g. single-input "Search" forms.
ToString (inherited from Object) Returns a String that represents the current Object.
TypeSets 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.
UncheckUncheck a toggle-button (checkbox/radio)
WaitForConditionRuns 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
WaitForPageToLoadWaits 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.
WaitForPopUpWaits for a popup window to appear and load up.

Protected Instance Fields

commandProcessor 

Protected Instance Methods

Finalize (inherited from Object) Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object) Creates a shallow copy of the current Object.

See Also

DefaultSelenium Class | Selenium Namespace