Classes and Modules

Constants

REVISION_STRING	=	'$Revision: 1263 $'	The revision number (according to Subversion)
REVISION	=	$1 or 'unknown'
VERSION_SHORT	=	'1.5.5'	The Release number
VERSION	=	VERSION_SHORT + '.' + REVISION
READYSTATE_COMPLETE	=	4	Used internally to determine when IE has finished loading a page
HIGHLIGHT_COLOR	=	'yellow'	The default color for highlighting objects as they are accessed.
EMPTY_TAG_NAME	=	"DUMMY"	IE inserts some element whose tagName is empty and just acts as block level element Probably some IE method of cleaning things To pass the same to REXML we need to give some name to empty tagName

Attributes

down_load_time	[R]	The time, in seconds, it took for the new page to load after executing the the last command
hwnd	[W]
ie	[RW]	the OLE Internet Explorer object
logger	[RW]	access to the logger object
process_id	[W]
speed	[R]	Whether the speed is :fast or :slow
url_list	[R]	this contains the list of unique urls that have been visited

Public Class methods

_find(how, what)

attach(how, what)

Return a Watir::IE object for an existing IE window. Window can be referenced by url, title, or window handle. Second argument can be either a string or a regular expression in the case of of :url or :title. IE.attach(:url, ‘www.google.com’) IE.attach(:title, ‘Google’) IE.attach(:hwnd, 528140) This method will not work when Watir/Ruby is run under a service (instead of a user).

attach_timeout()

attach_timeout=(timeout)

bind(window)

Return an IE object that wraps the given window, typically obtained from Shell.Application.windows.

close_all()

close all ie browser windows

defaults()

defaults=(options)

each() {|ie| ...}

Yields successively to each IE window on the current desktop. Takes a block. This method will not work when Watir/Ruby is run under a service (instead of a user). Yields to the window and its hwnd.

find(how, what)

return internet explorer instance as specified. if none is found, return nil. arguments:

  :url, url -- the URL of the IE browser window
  :title, title -- the title of the browser page
  :hwnd, hwnd -- the window handle of the browser window.

This method will not work when Watir/Ruby is run under a service (instead of a user).

new(suppress_new_window=nil)

Create an IE browser.

new_process()

Create a new IE window in a new process. This method will not work when Watir/Ruby is run under a service (instead of a user).

new_window()

Create a new IE window. Works just like IE.new in Watir 1.4.

process_count()

Returns the number of IEXPLORE processes currently running.

quit()

reset_attach_timeout()

Maximum number of seconds to wait when attaching to a window

speed()

speed=(x)

start(url=nil)

Create a new IE Window, starting at the specified url. If no url is given, start empty.

start_process(url=nil)

Create a new IE window in a new process, starting at the specified URL. Same as IE.start.

start_window(url=nil)

Create a new IE window, starting at the specified url. If no url is given, start empty. Works like IE.start in Watir 1.4.

visible()

visible=(x)

Public Instance methods

_attach_init(how, what)

this method is used internally to attach to an existing window

_new_process_init()

_new_window_init()

add_checker(checker)

this method is used to add an error checker that gets executed on every page load

checker Proc Object, that contains the code to be run

attach_command()

back()

Go to the previous page - the same as clicking the browsers back button an WIN32OLERuntimeError exception is raised if the browser cant go back

bring_to_front()

Make the window come to the front

clear_url_list()

clear the list of urls that we have visited

close()

Closes the Browser

close_modal()

close modal dialog. unlike IE#modal_dialog.close, does not wait for dialog to appear and does not raise exception if no window is found. returns true if modal was found and close, otherwise false

close_others()

find other ie browser windows and close them

dir()

disable_checker(checker)

this allows a checker to be disabled

checker Proc Object, the checker that is to be disabled

document()

Return the current document

element_by_xpath(xpath)

return the first element that matches the xpath

elements_by_xpath(xpath)

execute xpath and return an array of elements

exist?()

Alias for exists?

exists?()

Are we attached to an open browser?

focus()

Gives focus to the frame

forward()

Go to the next page - the same as clicking the browsers forward button an WIN32OLERuntimeError exception is raised if the browser cant go forward

front?()

goto(url)

Navigate to the specified URL.

 * url - string - the URL to navigate to

hwnd()

Return the current window handle

initialize_options()

kill()

log(what)

maximize()

Maximize the window (expands to fill the screen)

minimize()

Minimize the window (appears as icon on taskbar)

process_id()

refresh()

Refresh the current page - the same as clicking the browsers refresh button an WIN32OLERuntimeError exception is raised if the browser cant refresh

restore()

Restore the window (after minimizing or maximizing)

rexml_document_object()

Get the Rexml object.

run_error_checks()

this method runs the predefined error checks

send_keys(key_string)

Send key events to IE window. See www.autoitscript.com/autoit3/docs/appendix/SendKeys.htm for complete documentation on keys supported and syntax.

set_fast_speed()

deprecated: use speed = :fast instead

set_logger(logger)

deprecated: use logger= instead

set_slow_speed()

deprecated: use speed = :slow instead

show_active()

this method shows the name, id etc of the object that is currently active - ie the element that has focus its mostly used in irb when creating a script

show_divs()

this method shows all the divs availble in the document

show_forms()

Show all forms displays all the forms that are on a web page.

show_images()

this method shows all the images availble in the document

show_labels()

show_links()

this method shows all the links availble in the document

show_pres()

show_spans()

this method shows all the spans availble in the document