Description

An HTML page.

Operations

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

Note: You can also view a list and descriptions of the Page 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

CaptureBitmap	Saves a screen capture of the object as a .png or .bmp image using the specified file name.
Check	Checks whether the actual value of an item matches the expected value.
CheckProperty	Checks whether the actual value of the specified object property matches the specified expected value within the specified timeout.
ChildObjects	Returns the collection of child objects contained within the object.
GetAllROProperties	Returns the collection of properties and current values from the object in the application.
GetROProperty	Returns the current value of the description property from the object in the application.
GetTOProperties	Returns the collection of properties and values used to identify the object.
GetTOProperty	Returns the value of the specified description property from the test object description.
Highlight	Highlights the object in the application.
Output	Retrieves the current value of an item and stores it in a specified location.
RefreshObject	Instructs UFT One to re-identify the object in the application the next time a step refers to this object.
RunScript	Runs the specified JavaScript.
RunScriptFromFile	Runs the JavaScript stored in the specified file.
SetTOProperty	Sets the value of the specified description property in the test object description.
Sync	Waits for the browser to complete the current navigation.
ToString	Returns a string that represents the test object.
WaitProperty	Waits until the specified object property achieves the specified value or exceeds the specified timeout before continuing to the next step.

Properties

Exist	Checks whether the object currently exists in the open application.
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

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

Run a Script on a Page (VBScript)

                        
                            'This example runs a JavaScript function that removes specified web elements from the HTML page.
                        
                        
Browser(
                        "MyBrowser"
                        ).Page(
                        "MyPage"
                        ).RunScript(
                        "(function(){var remove = document.getElementsByTagName('a')[0]; 
var per = remove.parentNode; per.removeChild(remove);})();"
                         )
                    

Clone a Returned JavaScript Array (VBScript)

                    'This example provides a JavaScript function that uses a Push operation to clone
'the array that is returned by the RunScript method. The cloneArray function is then saved as a .js file in the file system.
'The example then uses the EmbedScriptFromFile method to embed the function in the specified browser,
'and the RunScript method to run the embedded cloneArray() function on the script that returned the array.

'Adapt the following function and save it as CloneArray.js on your C: drive:
'     function cloneArray(arr) {
'           var ret = [];
'           for (var i = 0; i < arr.length; ++i)
'                 ret.push(arr[i]);
'           return ret;
'     }

'In UFT One, embed the function 
Browser("MyBrowser").EmbedScriptFromFile "C:\CloneArray.js"
'Call the function and run the script that returns the array
Set cloned = Browser("MyBrowser").Page("MyPage").RunScript("cloneArray( /* JavaScript code that returns an array */ )")

Back to top

RunScriptFromFile Method

Description

Runs the JavaScript stored in the specified file.

Syntax

object.RunScriptFromFile (FileName)

Arguments

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

Run a Script from a Specified File on a Page (VBScript)

                    'This example uses the RunScriptFromFile method to remove a DOM element from a Web page.
'Then it that the page still behaves correctly when the DOM element is removed.

Browser("Google").Page("Google").RunScriptFromFile "c:\remove_logo.js"
'Check that the Web page behaves correctly
If Browser("Google").Page("Google").Image("Google").Exist Then
    Reporter.ReportEvent micFail, "Failed to remove Google logo"
End If

Clone a Returned JavaScript Array (VBScript)

                    'This example provides a JavaScript function that uses a Push operation to clone
'the array that is returned by the RunScriptFromFile method. The cloneArray function is then saved as a .js file in the file system.
'The example then uses the EmbedScriptFromFile method to embed the function in the specified browser,
'and the RunScriptFromFile method to run the embedded cloneArray() function on the script that returned the array.

'Adapt the following function and save it as CloneArray.js on your C: drive:
'     function cloneArray(arr) {
'           var ret = [];
'           for (var i = 0; i < arr.length; ++i)
'                 ret.push(arr[i]);
'           return ret;
'     }

'In UFT One, embed the function 
Browser("MyBrowser").EmbedScriptFromFile "C:\CloneArray.js"
'Call the function and run the script that returns the array
Set cloned = Browser("MyBrowser").Page("MyPage").RunScriptFromFile("cloneArray( /* JavaScript file path that returns an array */ )")

Back to top

Sync Method

Description

Waits for the browser to complete the current navigation.

Syntax

object.Sync

Return Type

None

IMPORTANT

This method is not supported on Firefox or Chrome browsers.

Example

Synchronize the Navigation to a Web Page (VBScript)

                    'The following example uses the Sync method to complete the navigation to the specified page.

SystemUtil.Run "iexplore.exe", "http://www.google.com"
Browser("Google").Page("Google").Sync
Browser("Google").Navigate "http://www.cnn.com"
Browser("Google").Page("CNN.com - Breaking News,").Sync
Wait 10 ' we can read the latest news
Browser("Google").Back

Back to top

See also:

• Browser
• Frame
• Image
• Link
• Page
• ViewLink
• WebAgGrid
• WebArea
• WebAudio
• WebButton
• WebCheckBox
• WebEdit
• WebElement
• WebFile
• WebList
• WebMenu
• WebNumber
• WebRadioGroup
• WebRange
• WebTable
• WebTabStrip
• WebTree
• WebUIGrid
• WebVideo
• WebXML