Share this page
OracleFormWindow Object
Description
An Oracle Form window.
Operations
The sections below list the built-in methods and properties that you can use as operations for the OracleFormWindow object.
Note: You can also view a list and descriptions of the OracleFormWindow 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
 Activate | Activates the form. |
 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. |
| Click | Clicks the specified location with the specified mouse button. |
| CloseForm | Closes the form using the Exit softkey. |
| CloseWindow | Closes the form using the X button in the form window title bar. |
| GetMenuItemProperty | Returns the value of the specified property of a selected menu item. |
| GetMenuSubItems | Returns the string (with fulls paths) of all submenus (separated by a vbLf) for the specified menu item. |
| 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. |
| InvokeSoftkey | Invokes the specified Oracle softkey. |
| Output | Retrieves the current value of an item and stores it in a specified location. |
| PressToolbarButton | Presses a toolbar button. |
| RefreshObject | Instructs UFT One to re-identify the object in the application the next time a step refers to this object. |
| Save | Performs a Save operation using the Commit softkey. |
| SelectMenu | Selects a menu option. |
| SelectPopupMenu | Invoke context menu and select the specified menu option. |
| SetTOProperty | Sets the value of the specified description property in the test object description. |
| 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. |
Activate Method
Description
Activates the form.
Syntax
object.Activate
Return Type
None.
Example
Bring a Form into Focus (VBScript)
Click Method
Description
Clicks the specified location with the specified mouse button.
Syntax
object.Click ([x], [y], [BUTTON])
Arguments
| Parameter | Description |
|---|---|
| x |
Optional. An integer value. The x-coordinate of the click. Note that the specified coordinates are relative to the upper left corner of the object. Default = micNoCoordinate (center of the object). Default value = -1 |
| y |
Optional. An integer value. The y-coordinate of the click. Note that the specified coordinates are relative to the upper left corner of the object. Default value = -1 |
| BUTTON |
Optional. A predefined constant or number. The mouse button used to click the object. Default value = micLeftBtn |
Return Type
None.
Example
CloseForm Method
Description
Closes the form using the Exit softkey.
Syntax
object.CloseForm
Return Type
None.
Example
CloseWindow Method
Description
Closes the form using the X button in the form window title bar.
Syntax
object.CloseWindow
Return Type
None.
Example
GetMenuItemProperty Method
Description
Returns the value of the specified property of a selected menu item.
Syntax
object.GetMenuItemProperty (MenuPath, PropertyName)
Arguments
| Parameter | Description |
|---|---|
| MenuPath |
Required. A String value. The path to the item inside the menu. You must specify the full path to the menu item, using "->" as the separator between menu options. For example, you would specify the Switch Responsibility menu option as follows: "File->Switch Responsibility...". |
| PropertyName |
Required. A String value. The property values. Possible values:
|
Return Type
A Boolean value.
Example
GetMenuSubItems Method
Description
Returns the string (with fulls paths) of all submenus (separated by a vbLf) for the specified menu item.
Syntax
object.GetMenuSubItems (MenuPath)
Arguments
| Parameter | Description |
|---|---|
| MenuPath |
Required. A String value. The path to the item inside the menu. You must specify the full path to the menu item, using "->" as the separator between menu options. For example, you would specify the Switch Responsibility menu option as follows: "File->Switch Responsibility...". |
Return Type
A String value.
IMPORTANT
To use the GetMenuSubItems method with dynamically created Oracle menu subitems, you must first expand the target menu using the SelectMenu method. For example:
OracleFormWindow("Distribution Lists").SelectMenu "Window"
OracleFormWindow("Distribution Lists").GetMenuSubItems("Window")
Example
InvokeSoftkey Method
Description
Invokes the specified Oracle softkey.
Syntax
object.InvokeSoftkey (Softkey)
Arguments
| Parameter | Description | |||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Softkey |
Required. A String value. The softkey function to perform. You can view the functions available in a specific form by pressing Ctrl+K in an Oracle Applications session. Softkey functions are not case sensitive. The following functions can be specified:
|
Return Type
None.
Example
PressToolbarButton Method
Description
Presses a toolbar button.
Syntax
object.PressToolbarButton (ButtonName)
Arguments
| Parameter | Description |
|---|---|
| ButtonName |
Required. A String value. The button name. |
Return Type
None.
Save Method
Description
Performs a Save operation using the Commit softkey.
Syntax
object.Save
Return Type
None.
IMPORTANT
Note: This method is not recorded. To add this method to your test, use the Step Generator or enter it manually in the Keyword View or Editor. For more information, refer to the UFT One User Guide.
Example
SelectMenu Method
Description
Selects a menu option.
Syntax
object.SelectMenu (Item)
Arguments
| Parameter | Description |
|---|---|
| Item |
Required. A String value. The name of the menu item. You must specify the full path to the menu item, using "->" as the separator between menu options. For example, you would specify the Switch Responsibility menu option as follows: "File->Switch Responsibility...". |
Return Type
None.
Example
SelectPopupMenu Method
Description
Invoke context menu and select the specified menu option.
Syntax
object.SelectPopupMenu (Path)
Arguments
| Parameter | Description |
|---|---|
| Path |
Required. A String value. The path of the menu to open. |
Return Type
None.
Example
See also:
