Frame Object

Description

An HTML frame.

Operations

The sections below list the built-in methods and properties that you can use as operations for the Frame object.

Note: You can also view a list and descriptions of the Frame description properties, for use in object repository descriptions, programmatic descriptions, checkpoint and output value steps, and as argument values for the GetTOProperty and GetROProperty methods.

Methods

Common Method CaptureBitmap Saves a screen capture of the object as a .png or .bmp image using the specified file name.
Common Method Check Checks whether the actual value of an item matches the expected value.
Common Method CheckProperty Checks whether the actual value of the specified object property matches the specified expected value within the specified timeout.
Common Method ChildObjects Returns the collection of child objects contained within the object.
Common Method GetAllROProperties

Returns the collection of properties and current values from the object in the application.

Common Method GetROProperty Returns the current value of the description property from the object in the application.
Common Method GetTOProperties Returns the collection of properties and values used to identify the object.
Common Method GetTOProperty Returns the value of the specified description property from the test object description.
Common Method Highlight Highlights the object in the application.
Common Method Output Retrieves the current value of an item and stores it in a specified location.
Common Method RefreshObject Instructs UFT One to re-identify the object in the application the next time a step refers to this object.
Method RunScript Runs the specified JavaScript.
Method RunScriptFromFile Runs the JavaScript stored in the specified file.
Common Method SetTOProperty Sets the value of the specified description property in the test object description.
Common Method ToString Returns a string that represents the test object.
Common Method WaitProperty Waits until the specified object property achieves the specified value or exceeds the specified timeout before continuing to the next step.

Properties

Common Property Exist Checks whether the object currently exists in the open application.
Common Property Object Accesses the native methods and properties of the object.

Back to top

 

RunScript Method

Description

Runs the specified JavaScript.

Syntax

object.RunScript (Script)

Arguments

Parameter Description
Script Required. A String value.
The full content of the JavaScript to run.

Return Type

A Variant.

IMPORTANT

  • If the script you run returns a JavaScript array, you cannot use standard VBScript syntax to access the array index (for example, arr(0) ) nor can use use JavaScript syntax (for example arr[0]).
  • You can use JavaScript operations such as pop, push, shift or length to access JavaScript array items. Keep in mind, however, that most such JavaScript array operations also modify the content of the array. Therefore, you may want to consider cloning the array and using these operations on the cloned copy. (See example below.) Alternatively, you can run a JavaScript function that converts the returned array to a safearray. Then you can use standard VBScript syntax to iterate the array.
  • The entire script must be specified as the argument value (as a string or variable). To specify a JavaScript file as the argument value, use the RunScriptFromFile method.
  • To run this method, the security settings in your Web browser must be set to allow active scripting. Otherwise, steps using this method will fail. 
  • When working with Internet Explorer, using this method to run the Alert, Prompt, and Confirm JavaScript methods is not supported.
  • When running this method, you should use an eval() function or anonymous function to run the script entered for this method.
    For example, you can use functions like these:
    "eval(var remove = document.getElementsByTagName('a')[0]; var per = remove.parentNode; per.removeChild(remove););"
    OR
    "(function(){var remove = document.getElementsByTagName('a')[0]; var per = remove.parentNode; per.removeChild(remove);})();"  

Example

Back to top

 

RunScriptFromFile Method

Description

Runs the JavaScript stored in the specified file.

Syntax

object.RunScriptFromFile (FileName)

Arguments

Parameter Description
FileName Required. A String value.
The full path of the JavaScript file to run. The location can be an absolute or relative file system path or an ALM path.

Return Type

A Variant.

IMPORTANT

  • If the script you run returns a JavaScript array, you cannot use standard VBScript syntax to access the array index (for example, arr(0) ) nor can use use JavaScript syntax (for example arr[0]).
  • You can use JavaScript operations such as pop, push, shift or length to access JavaScript array items. Keep in mind, however, that most such JavaScript array operations also modify the content of the array. Therefore, you may want to consider cloning the array and using these operations on the cloned copy. (See example below.) Alternatively, you can run a JavaScript function that converts the returned array to a safearray. Then you can use standard VBScript syntax to iterate the array.
  • This method runs a JavaScript from a specified file. To run a script directly as the argument value, use the RunScript method.
  • To run this method, the security settings in your Web browser must be set to allow active scripting. Otherwise, steps using this method will fail.
  • When working with Internet Explorer, using this method to run the Alert, Prompt, and Confirm JavaScript methods is not supported.
  • When running this method, you should use an eval() function or anonymous function to run the script entered for this method.
    For example, you can use functions like these:
    "eval(var remove = document.getElementsByTagName('a')[0]; var per = remove.parentNode; per.removeChild(remove););"
    OR
    "(function(){var remove = document.getElementsByTagName('a')[0]; var per = remove.parentNode; per.removeChild(remove);})();"        

Example

Back to top

See also: