Reference:

WebReplay_FindAnchorWithHref

• Source Code: 
  File 

• Description: 
  Return an HTML hyperlink (tag <a href=... ></a>) containing the given text.
  This function is a shortcut for WebReplay_FindHTMLControl("a", "href", strURL).

• Synopsis: 

  function WebReplay_FindAnchorWithHref(strURL)

• Parameters: 
  • strURL  (type String)  : Searched URL (value of attribute href)

• Return value: objHTMLControl: HTML Control found (or null is control has not been found)

• Example: 

  var objHTMLControl = WebReplay_FindAnchorWithHref("mypage.asp");

WebReplay_FindAnchorWithText

• Source Code: 
  File 

• Description: 
  Return an HTML hyperlink (tag <a ... ></a>) containing the given text.
  This function is a shortcut for WebReplay_FindHTMLControl("a", "innerText", ...).

• Synopsis: 

  function WebReplay_FindAnchorWithText(strText)

• Parameters: 
  • strText  (type String)  : Searched text (value of attribute innerText)

• Return value: objHTMLControl: HTML Control found (or null is control has not been found)

• Example: 

  var objHTMLControl = WebReplay_FindAnchorWithText("click here");

WebReplay_FindButtonWithText

• Source Code: 
  File 

• Description: 
  Return an HTML button (tag <input type=button ... >) containing the given text.
  This function is a shortcut for WebReplay_FindHTMLControl("input", "value", strText).

• Synopsis: 

  function WebReplay_FindButtonWithText(strText)

• Parameters: 
  • strText  (type String)  : Searched text (value of attribute innerText)

• Return value: objHTMLControl: HTML Control found (or null is control has not been found)

• Example: 

  var objHTMLControl = WebReplay_FindButtonWithText("OK");

WebReplay_FindHTMLControl

• Source Code: 
  File 

• Description: 
  Return an HTML control (any) having the given tag name and attribute value.

• Synopsis: 

  function WebReplay_FindHTMLControl(strTagName, strAttributeName, strAttributeValue)

• Parameters: 
  • strTagName  (type String)  : Searched tag
  • strAttributeName  (type String)  : Name of the searched attribute
  • strAttributeValue  (type String)  : Value of the searched attribute

• Return value: objHTMLControl: HTML Control found (or null is control has not been found)

• Example: 

  var objHTMLControl = WebReplay_FindHTMLControl("a", "innerText", "click here");

WebReplay_FindHTMLControlFromText

• Source Code: 
  File 

• Description: 
  Return an HTML control with the given tag name and containing the given text.
  This function is a shortcut for WebReplay_FindHTMLControl(strTagName, "innerText", strText).

• Synopsis: 

  function WebReplay_FindHTMLControlFromText(strTagName, strText)

• Parameters: 
  • strTagName  (type String)  : Searched tag
  • strText  (type String)  : Searched text (value of attribute innerText)

• Return value: objHTMLControl: HTML Control found (or null is control has not been found)

• Example: 

  var objHTMLControl = WebReplay_FindHTMLControlFromText("a", "click here");

WebReplay_FindHTMLControlWithName

• Source Code: 
  File 

• Description: 
  Return an HTML control with the given name or id.

• Synopsis: 

  function WebReplay_FindHTMLControlWithName(strHTMLControl)

• Parameters: 
  • strHTMLControl  (type String)  : Name of the HTML control (or id)

• Return value: objHTMLControl: HTML Control found (or null is control has not been found)

• Example: 

  var objHTMLControl = WebReplay_FindHTMLControlWithName("Text1");

WebReplay_FindTags

• Source Code: 
  File 

• Description: 
  Return a collection of HTML controls with the given tag name.

• Synopsis: 

  function WebReplay_FindTags(strTagName)

• Parameters: 
  • strTagName  (type String)  : Searched tag

• Return value: arrHTMLTags: collection of HTML Controls found

• Example: 

    // Get all hyperlinks in page
    var arrHTMLTags = WebReplay_FindTags("a");
    // Loop on found links
    if (arrHTMLTags != null)
    {
      for (var intTag = 0; intTag < arrHTMLTags.length; intTag++)
      {
        var objHTMLControl = arrHTMLTags[intTag];
  
        // Do something with this objHTMLControl...
  
      }
    }
  

WebReplay_GetHTMLControl

• Source Code: 
  File 

• Description: 
  Return an HTML control with the given name or id.
  Please note that if the document is not loaded or not ready yet, this function returns null.

• Synopsis: 

  function WebReplay_GetHTMLControl(strHTMLControlId, objHTMLDocument)

• Parameters: 
  • strHTMLControlId  (type String)  : Name of the HTML control (or id)
  • objHTMLDocument  (type object)  : (optional) document where the control is to be located/found

• Return value: objHTMLControl: HTML Control found (or null is control has not been found)

• Example: 

  var objHTMLControl = WebReplay_GetHTMLControl("Text1");

WebReplay_IsControlReady

• Source Code: 
  File 

• Description: 
  Return true if an HTML control is ready, i.e.:
  • Not null (objHTMLControl != null)
  • Not disabled (objHTMLControl.disabled == false)
  • Not hidden (objHTMLControl.style.display != "none")
  • Document and Body containing the HTML control are ready/not disabled

• Synopsis: 

  function WebReplay_IsControlReady(objHTMLControl)

• Parameters: 
  • objHTMLControl  (type object)  : HTML Control object

• Return value: blnReady: true if HTML Control is ready, false otherwise

• Example: 

    var blnDone = false;
  
    var objHTMLControl = WebReplay_FindHTMLControlWithName(strHTMLControl);
    if (WebReplay_IsControlReady(objHTMLControl))
    {
      blnDone = WebReplay_SimulateInput(objHTMLControl, strHTMLValue, true, intNewState);
    }
  

WebReplay_Log

• Source Code: 
  File 

• Description: 
  Log a message in Web Replay's top frame.

• Synopsis: 

  function WebReplay_Log(strHTMLMessage)

• Parameters: 
  • strHTMLMessage  (type String)  : Message text (HTML format allowed)

• Return value: none

• Example: 

  WebReplay_Log("been here");

WebReplay_Navigate

• Source Code: 
  File 

• Description: 
  Navigate to a given URL (containing parameters if needed).

• Synopsis: 

  function WebReplay_Navigate(strURL, intNewState)

• Parameters: 
  • strURL  (type String)  : Uniform Resource Location (URL) to navigate to

• Return value: blnDone: boolean; true if navigation is successful, false otherwise

• Example: 

  var blnDone = WebReplay_Navigate("http://localhost");

WebReplay_SetStateNext

• Source Code: 
  File 

• Description: 
  Switch to given state (or next state if not defined)

• Synopsis: 

  function WebReplay_SetStateNext(intNewState, blnLog, blnDisplay)

• Parameters: 
  • intNewState  (type Integer)  : State to switch to (optional - if null, the scenario automatically switches to next state)
  • blnLog  (type Boolean)  : Boolean flag - true means that the state change is logged in Web Replay's top frame (true by default)
  • blnDisplay  (type Boolean)  : Boolean flag - true means that the state change is displayed in Web Replay's top frame (true by default)

• Return value: none

• Example: 

  WebReplay_SetStateNext();

WebReplay_SimulateCheckboxInput

• Source Code: 
  File 

• Description: 
  Simulate a user checking or unchecking a checkbox HTML control (<input type=checkbox ... >).

• Synopsis: 

  function WebReplay_SimulateCheckboxInput(strHTMLControl, blnChecked, intNewState)

• Parameters: 
  • strHTMLControl  (type String)  : Name of the HTML control (or id)
  • blnChecked  (type Boolean)  : Boolean flag: true means that the box will be checked, false means that the box will be unchecked
  • intNewState  (type Integer)  : State to switch to once the user interaction is done (null by default: switch to next state)

• Return value: blnDone: boolean; true means that the box has successfully been checked or unchecked

• Example: 

  WebReplay_SimulateCheckboxInput("Check1");

WebReplay_SimulateHTMLElementClick

• Source Code: 
  File 

• Description: 
  Simulate a user clicking on an HTML control (any type).

• Synopsis: 

  function WebReplay_SimulateHTMLElementClick(strHTMLControl, intNewState, blnRaiseEvents)

• Parameters: 
  • strHTMLControl  (type String)  : Name of the HTML control (or id)
  • intNewState  (type Integer)  : State to switch to once the user interaction is done (null by default: switch to next state)
  • blnRaiseEvents  (type Boolean)  : Boolean flag: true means that standard events will be raised (true by default): onmousedown, onfocus, onmouseup, onblur

• Return value: blnDone: boolean; true means that the control has successfully been clicked

• Example: 

  WebReplay_SimulateHTMLElementClick("OK");

WebReplay_SimulateTextInput

• Source Code: 
  File 

• Description: 
  Simulate a user typing text in an HTML control (<input type=text ... >)

• Synopsis: 

  function WebReplay_SimulateTextInput(strHTMLControl, strHTMLValue, intNewState)

• Parameters: 
  • strHTMLControl  (type String)  : Name of the HTML control (or id)
  • strHTMLValue  (type String)  : Value to type into the control
  • intNewState  (type Integer)  : State to switch to once the text input is done (null by default: switch to next state)

• Return value: blnDone: boolean; true means that the text input has successfully been done

• Example: 

  WebReplay_SimulateTextInput("Text1", "NewValue1");

WebReplay_URLEncode

• Source Code: 
  File 

• Description: 
  Applies URL encoding rules, including escape characters, to a specified string

• Synopsis: 

  function WebReplay_URLEncode(strRaw)

• Parameters: 
  • strRaw  (type String)  : Raw string value

• Return value: strURLEncoded: URL-encoded string value

• Example: 

  var strURLEncoded = WebReplay_URLEncode("http://www.google.com");

WebReplay_WaitForHTMLControl

• Source Code: 
  File 

• Description: 
  Wait for an HTML Control to appear/be loaded/be generated.
  This function does not interact in any way with the control (it can be any HTML control, even non-interactive stuff).
  This function relies on WebReplay_IsControlReady() to check if the control is ready.

• Synopsis: 

  function WebReplay_WaitForHTMLControl(strTagName, strAttributeName, strAttributeValue, intNewState)

• Parameters: 
  • strTagName  (type String)  : Searched tag
  • strAttributeName  (type String)  : Name of the searched attribute
  • strAttributeValue  (type String)  : Value of the searched attribute
  • intNewState  (type Integer)  : State to switch to once the HTML control is available (null by default: switch to next state)

• Return value: blnDone: boolean; true means that the control has successfully been found

• Example: 

  WebReplay_WaitForHTMLControl("h2", "innerText", "Form Submit Debugger", -1);

WebReplay_WaitForHTMLControlWithName

• Source Code: 
  File 

• Description: 
  Wait for an HTML Control to appear/be loaded/be generated.
  This function does not interact in any way with the control (it can be any HTML control, even non-interactive stuff).
  This function relies on WebReplay_IsControlReady() to check if the control is ready.

• Synopsis: 

  function WebReplay_WaitForHTMLControlWithName(strHTMLControlId, intNewState)

• Parameters: 
  • strHTMLControlId  (type String)  : Name of the HTML control (or id)
  • intNewState  (type Integer)  : State to switch to once the HTML control is available (null by default: switch to next state)

• Return value: blnDone: boolean; true means that the control has successfully been found

• Example: 

  WebReplay_WaitForHTMLControl("OK");

WebReplay_WaitForWindowStatus

• Source Code: 
  File 

• Description: 
  Wait for the window status (text displayed in the status bar) to be equal to a given value.
  

• Synopsis: 

  function WebReplay_WaitForWindowStatus(strExpectedStatus, intNewState)

• Parameters: 
  • strHTMLControlId  (type String)  : Name of the HTML control (or id)
  • intNewState  (type Integer)  : State to switch to once the window status is found (null by default: switch to next state)

• Return value: blnDone: boolean; true means that the control has successfully been found

• Example: 

  WebReplay_WaitForWindowStatus("Done");

WebReplayScenarioAuto

• Source Code: 
  File 

• Description: 
  Replay a scenario, based on an array of states. Every element in the array describes one state to reach; it consists in a sub-array of 1 or 2 elements:
  • First element is the name (or id) of an HTML control
  • Second element is the action to take on the given control
  Action can be:
  • null (or missing): Web Replay will simulate a user clicking on the HTML Control
  • true or false: Web Replay will simulate a user checking (if true) or unchecking the HTML Control (it must be a checkbox control)
  • any string: Web Replay will simulate a user typing the string into the HTML Control (it must be a text input control)
  • any Javascript function: Web Replay will execute this function with no parameters

• Synopsis: 

  function WebReplayScenarioAuto(arrStates)

• Parameters: 
  • arrStates  (type Array)  : Array of states composing the scenario to replay

• Return value: none

• Example: 

  function WebReplayScenario()
  {
     WebReplayScenarioAuto(
       [
         // State 1: Navigate to the test Page (uses an anonymous function definition)
         [ null, function () { WebReplay_Navigate("http://localhost/WebReplay2/WebReplay2Scenario1_step1.asp") } ], 
  
         // State 2: Type in some text in a form field named Text1
         [ "Text1", "NewValue1" ], 
  
         // State 3: Submit form by clicking on a submit button named "OK"
         [ "OK" ], 
  
         // State 4: Type in some text in a form field named Text21
         [ "Text1", "NewValue2" ], 
  
         // State 5: Submit form by clicking on a submit button named "OK"
         [ "OK" ], 
  
         // State 6: Wait for next page's title: <h2>Form Submit Debugger</h2>
         // Set state to -1 (end) when the control is found.
         [ null, function () { WebReplay_WaitForHTMLControl("h2", "innerText", "Form Submit Debugger", -1) } ]
  
       ]
     );
  }