Page Handlers
Page Handlers are used when attempting to use either a BrowserInterface object or a Browser control object to determine whether or not a specific page is loaded. Each time a new page is loaded, a page watcher ticks, or the CheckHandlerQueue method is called for either the BrowserInterface object or the Browser control object, the current page handler in the page handler queue is checked to see if the current page matches the required conditions for that handler. If so, the Lua method attached to that handler is executed. There are currently four types of page handlers, each of which uses a different method when checking for page matches. The four types are described below.
Name | Id Type | Description |
---|---|---|
Form Exists | formExists | This page handler checks the page to see if a given form exists by attempting to match forms against a provided form name/id. When using this handler, the id represents the form name or id to search for. |
Frame Exists | frameExists | This page handler checks the page to see if a given frame exists by attempting to match frames against a provided frame name/id. When using this handler, the id represents the frame name or id to search for. |
Title | title | This page handler checks the page title to see if it matches the value provided. When using this handler, the id represents the page title to look for. |
Custom | custom | This page handler calls a user-provided Lua method which should check whatever custom conditions are necessary and return a true or false representing whether or not the page matches the conditions being checked. When using this handler, the id represents the name of the Lua method that should be called. |