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

Method ActivateActivates the form.
Common Method CaptureBitmapSaves a screen capture of the object as a .png or .bmp image using the specified file name.
Common Method CheckChecks whether the actual value of an item matches the expected value.
Common Method CheckPropertyChecks whether the actual value of the specified object property matches the specified expected value within the specified timeout.
Common Method ChildObjectsReturns 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.

Method ClickClicks the specified location with the specified mouse button.
Method CloseFormCloses the form using the Exit softkey.
Method CloseWindowCloses the form using the X button in the form window title bar.
Method GetMenuItemPropertyReturns the value of the specified property of a selected menu item.
Method GetMenuSubItemsReturns the string (with fulls paths) of all submenus (separated by a vbLf) for the specified menu item.
Common Method GetROPropertyReturns the current value of the description property from the object in the application.
Common Method GetTOPropertiesReturns the collection of properties and values used to identify the object.
Common Method GetTOPropertyReturns the value of the specified description property from the test object description.
Common Method HighlightHighlights the object in the application.
Method InvokeSoftkeyInvokes the specified Oracle softkey.
Common Method OutputRetrieves the current value of an item and stores it in a specified location.
Method PressToolbarButtonPresses a toolbar button.
Common Method RefreshObjectInstructs UFT One to re-identify the object in the application the next time a step refers to this object.
Method SavePerforms a Save operation using the Commit softkey.
Method SelectMenuSelects a menu option.
Method SelectPopupMenuInvoke context menu and select the specified menu option.
Common Method SetTOPropertySets the value of the specified description property in the test object description.
Common Method ToStringReturns a string that represents the test object.
Common Method WaitPropertyWaits until the specified object property achieves the specified value or exceeds the specified timeout before continuing to the next step.

Properties

Common Property ExistChecks whether the object currently exists in the open application.

Back to top

 

Activate Method

Description

Activates the form.

Syntax

object.Activate

Return Type

None.

Example

                    'The following example uses the Activate method to bring the "Journal Categories" form
'into focus (make it the active window).
OracleNavigator("OracleNavigator").SelectFunction "Setup:Journal:Categories"
OracleFormWindow("Journal Categories").Activate

Back to top

 

Click Method

Description

Clicks the specified location with the specified mouse button.

Syntax

object.Click ([x], [y], [BUTTON])

Arguments

ParameterDescription
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 = micNoCoordinate (center of the object).

Tip: You can enter micNoCoordinate for the x and y argument values if you want to enter a value for the button argument without specifying x- and y- coordinates for the click. micNoCoordinate indicates the center 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

                    'The following example uses the Click method to click the "Attribute Groups" button in
'the "Master Item" form.
OracleFormWindow("Master Item").OracleTable("ORG_ASSIGN").EnterField 2, "Assigned", True
OracleFormWindow("Master Item").OracleButton("Attribute Groups").Click
OracleFormWindow("Master Item").OracleTabRegion("Work In Process").OracleList("Type").Select "Push"
OracleFormWindow("Master Item").Save
OracleFormWindow("Master Item").CloseForm
                    'The following example uses the Click method to perform a left mouse-button click at
'coordinates (5,5) inside the "Item" text field.
OracleFlexWindow("Parameters").OracleTextField("Range").OpenDialog
OracleListOfValues("Range").Select "Specific item"
OracleFlexWindow("Parameters").OracleTextField("Specific Item").SetFocus
OracleFlexWindow("Parameters").OracleTextField("Engineering Bills").Enter "NO"
OracleFlexWindow("Parameters").OracleTextField("Engineering Bills").CaptureBitmap "c:\temp\capture.bmp", True
OracleFlexWindow("Parameters").OracleTextField("Engineering Bills").Check CheckPoint("Engineering Bills")
OracleFlexWindow("Parameters").OracleTextField("Engineering Bills").InvokeSoftkey "NEXT FIELD"
OracleFlexWindow("System Items").OracleTextField("Item").Click 5, 5, 0
OracleFlexWindow("System Items").OracleTextField("Item").Enter "AT23808"
If (OracleFlexWindow("System Items").OracleTextField("Item").GetROProperty("Value") = "AT23808") Then
OracleFlexWindow("System Items").OracleTextField("Item").Enter "AT23809"
End If
OracleFlexWindow("System Items").OracleTextField("Item").Output CheckPoint("Item")

Back to top

 

CloseForm Method

Description

Closes the form using the Exit softkey.

Syntax

object.CloseForm

Return Type

None.

Example

                    'The following example uses the CloseForm method to close the "Master Item" form
'using the Exit softkey.
OracleFormWindow("Master Item").OracleTable("ORG_ASSIGN").EnterField 2, "Assigned", True
OracleFormWindow("Master Item").OracleButton("Attribute Groups").Click
OracleFormWindow("Master Item").OracleTabbedRegion("Work In Process").OracleList("Type").Select "Push"
OracleFormWindow("Master Item").Save
OracleFormWindow("Master Item").CloseForm

Back to top

 

CloseWindow Method

Description

Closes the form using the X button in the form window title bar.

Syntax

object.CloseWindow

Return Type

None.

Example

                    'The following example uses the CloseWindow method to close the "Master Item" form
'using the X in the form window title bar.
OracleNavigator("OracleNavigator").SelectMenu "Tools->Organization Assignment"
OracleFormWindow("Master Item").OracleTable("ORG_ASSIGN").EnterField 1, "Assigned", True
OracleFormWindow("Master Item").OracleTable("ORG_ASSIGN").EnterField 2, 4, True
OracleNavigator("OracleNavigator").SelectMenu "File->Save"
OracleFormWindow("Master Item").CloseWindow

Back to top

 

GetMenuItemProperty Method

Description

Returns the value of the specified property of a selected menu item.

Syntax

object.GetMenuItemProperty (MenuPath, PropertyName)

Arguments

ParameterDescription
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:

  • enabled
  • disabled
  • visible
  • showing
  • checked

Return Type

A Boolean value.

Example

                    'The following example retrieves the state of a menu item from a OracleFormWindow object.

OracleFormWindow("WINDOW1").GetMenuItemProperty (“TEST1->Enabled”, “enabled”)

Back to top

 

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

ParameterDescription
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

                    'The following example returns the list of sub-menu items for an OracleFormWindow object.

OracleFormWindow("WINDOW1").GetMenuSubItems (“TEST1->Enabled”)

Back to top

 

InvokeSoftkey Method

Description

Invokes the specified Oracle softkey.

Syntax

object.InvokeSoftkey (Softkey)

Arguments

ParameterDescription
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:

NEXT FIELDCLEAR RECORDDISPLAY ERROR
PREVIOUS FIELDDELETE RECORDPRINT
CLEAR FIELDDUPLICATE RECORDCOUNT QUERY
UPINSERT RECORDUPDATE RECORD
DOWNNEXT SET OF RECORDSFUNCTION 0 
SCROLL UPNEXT RECORDFUNCTION 1 
SCROLL DOWNPREVIOUS RECORDFUNCTION 2 
EDITCLEAR BLOCKFUNCTION 3 
RETURNBLOCK MENUFUNCTION 4 
LIST OF VALUESNEXT BLOCKFUNCTION 5 
HELPPREVIOUS BLOCKFUNCTION 6 
EXITDUPLICATE FIELDFUNCTION 7 
SHOW KEYSCLEAR FORMFUNCTION 8 
COMMITENTER QUERYFUNCTION 9
NEXT PRIMARY KEYEXECUTE QUERYLIST TAB PAGES

Return Type

None.

Example

                    'The following example uses the InvokeSoftkey method to close the "Navigator" tree.
OracleFormWindow("Navigator").OracleTree("Navigator").Check CheckPoint("Navigator")
Reporter.ReportEvent micDone, "OracleTree CheckPoint", "Indicates if all captured properties are correct. "
OracleFormWindow("Navigator").OracleTree("Navigator").Select "Personal Shortcuts"
OracleFormWindow("Navigator").OracleTree("Navigator").Expand "Public Shortcuts"
OracleFormWindow("Navigator").OracleTree("Navigator").Collapse "Profiles"
OracleFormWindow("Navigator").OracleTree("Navigator").InvokeSoftkey "EXIT"
OracleNavigator("OracleNavigator").SelectMenu "File->Switch Responsibility..."
                    'The following example uses the InvokeSoftkey method to exit the "Item Costs_2" form
'after modifying the value in the "Rate or Amount" field.
OracleFormWindow("Item Costs_2").OracleTabbedRegion("Cost Information").OracleTextField("Rate or Amount").Enter "100"
OracleNavigator("OracleNavigator").SelectMenu "File->Save"
OracleStatusLine("OracleStatusLine").Check CheckPoint("OracleStatusLine")
OracleFormWindow("Item Costs_2").OracleTabbedRegion("Cost Information").OracleTextField("Rate or Amount").InvokeSoftkey "EXIT"
                    'The following example uses the InvokeSoftkey method to move to the next field in the
'"Parameters" flexfield window.
OracleFlexWindow("Parameters").OracleTextField("Range").OpenDialog
OracleListOfValues("Range").Select "Specific item"
OracleFlexWindow("Parameters").OracleTextField("Specific Item").SetFocus
OracleFlexWindow("Parameters").OracleTextField("Engineering Bills").Enter "NO"
OracleFlexWindow("Parameters").OracleTextField("Engineering Bills").CaptureBitmap "c:\temp\capture.bmp", True
OracleFlexWindow("Parameters").OracleTextField("Engineering Bills").Check CheckPoint("Engineering Bills")
OracleFlexWindow("Parameters").OracleTextField("Engineering Bills").InvokeSoftkey "NEXT FIELD"
OracleFlexWindow("System Items").OracleTextField("Item").Click 5, 5, 0
OracleFlexWindow("System Items").OracleTextField("Item").Enter "AT23808"
If (OracleFlexWindow("System Items").OracleTextField("Item").GetROProperty("Value") = "AT23808") Then
OracleFlexWindow("System Items").OracleTextField("Item").Enter "AT23809"
End If
OracleFlexWindow("System Items").OracleTextField("Item").Output CheckPoint("Item")
                    'The following example uses the InvokeSoftkey method to clear all the fields in the
'"HEADERS_SUMMARY" table.
OracleNavigator("OracleNavigator").SelectFunction "Cash Forecasting:Forecasts"
OracleFormWindow("Find Cash Forecasts").OracleButton("Find").Click
OracleFormWindow("Cash Forecasts").OracleTable("HEADERS_SUMMARY").SetFocus 1, "Template Name"
OracleFormWindow("Cash Forecasts").OracleTable("HEADERS_SUMMARY").InvokeSoftkey "CLEAR BLOCK"
                    'The following example uses the InvokeSoftkey method to close the "Service Request" form.
OracleFormWindow("Service Request").InvokeSoftkey ("EXIT")
If OracleNotification("Forms").Exist Then
    OracleNotification("Forms").Choose ("Yes")
End If

Back to top

 

PressToolbarButton Method

Description

Presses a toolbar button.

Syntax

object.PressToolbarButton (ButtonName)

Arguments

ParameterDescription
ButtonName Required. A String value.
The button name.

Return Type

None.

Back to top

 

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

                    'The following example uses the Save method to save the values entered in the
'"Master Item" form.
OracleFormWindow("Master Item").OracleTable("ORG_ASSIGN").EnterField 2, "Assigned", True
OracleFormWindow("Master Item").OracleButton("Attribute Groups").Click
OracleFormWindow("Master Item").OracleTabbedRegion("Work In Process").OracleList("Type").Select "Push"
OracleFormWindow("Master Item").Save
OracleFormWindow("Master Item").CloseForm

Back to top

 

SelectMenu Method

Description

Selects a menu option.

Syntax

object.SelectMenu (Item)

Arguments

ParameterDescription
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

                    'The following example uses the SelectMenu method to save entries made in the
'"Master Item" form, using the Save command in the File menu.
OracleFormWindow("Master Item").OracleTabbedRegion("Service").OracleTextField("Starting Delay (Days)").Enter "0 "
OracleFormWindow("Master Item").SelectMenu "File->Save"
OracleStatusLine("OracleStatusLine").VerifyMessage "FRM-40400: Transaction complete: 1 records applied and saved."
OracleStatusLine("OracleStatusLine").VerifyErrorCode "FRM-40400"

Back to top

 

SelectPopupMenu Method

Description

Invoke context menu and select the specified menu option.

Syntax

object.SelectPopupMenu (Path)

Arguments

ParameterDescription
Path Required. A String value.
The path of the menu to open.

Return Type

None.

Example

                    'This example uses the SelectFunction method to select a function containing a tree, and navigates to the "Default - Enhancement [40]" node.
'It then uses the SelectPopupMenu method to open the pop-up menu and select the "Find..." option, and enters a search query.

OracleNavigator("OracleNavigator").SelectFunction "Territory Management:Territory Administration"
'Expand the nodes to navigate to an item with a pop-up menu.
OracleFormWindow("Navigator").OracleTree("Navigator").Expand "Territories->Catch All->Oracle Defect Management"
OracleFormWindow("Navigator").OracleTree("Navigator").Expand "Territories->Catch All->Oracle Defect Management->Default - Enhancement [40]"
'Open the pop-up menu and select the Find option.
OracleFormWindow("Navigator").OracleTree("Navigator").SelectPopupMenu "Find..."
'Enter a search query.
OracleFormWindow("Territory Search").OracleTextField("Usage").OpenDialog

Back to top

See also: