OracleForms¶
OracleForms Global Helper Object.
Action Summary¶
| Action | Description |
|---|---|
| DoLOVSelect | Select LOV (List of Values) Value. |
| DoMenu | Performs click on the menu item. |
| DoPressNotificationButton | Press button in the notification prompt (Accept, OK, Cancel, etc). |
| GetLOVTitle | Get title of currently displayed LOV selection window. |
| GetNotificationMessage | Get message of currently displayed notification window. |
| GetNotificationTitle | Get title of currently displayed notification window. |
| GetStatusMessage | Get status bar message. |
| GetVisibleDialogInfo | Get information about any visible dialog window (ChoiceBox or FWindow). |
| GetVisibleDialogMessage | Get the message of any visible dialog window (ChoiceBox or FWindow). |
| GetVisibleDialogTitle | Get the title of any visible dialog window (ChoiceBox or FWindow). |
| HasVisibleErrorDialog | Quickly check if an error dialog (ChoiceBox with title "Error") is currently visible. |
Action Detail¶
DoLOVSelect¶
Select LOV (List of Values) Value.
OracleForms.DoLOVSelect(txtOrInd, lovFilterText, timeout)
Parameters:
| Name | Type | Description |
|---|---|---|
| txtOrInd | string | number | LOV item text or Index. |
| lovFilterText | string | Default filter value. Optional, Default: "%". |
| timeout | number | Maximum time to wait (milliseconds). Optional, Default: "3000". |
Returns:
popup window title.
DoMenu¶
Performs click on the menu item.
OracleForms.DoMenu(menuPath, sep)
Parameters:
| Name | Type | Description |
|---|---|---|
| menuPath | string | Path from the menu root to a leaf item with components delimited by separator parameter. |
| sep | string | Separator character. Possible values: ";", ",", "\", "/" Optional, Default: ";". |
Returns:
'true' if successfull.
DoPressNotificationButton¶
Press button in the notification prompt (Accept, OK, Cancel, etc).
OracleForms.DoPressNotificationButton(label)
Parameters:
| Name | Type | Description |
|---|---|---|
| label | string | Button label (i.e. 'OK') |
Returns:
'true' if succeeded.
GetLOVTitle¶
Get title of currently displayed LOV selection window.
OracleForms.GetLOVTitle()
Returns:
popup window title.
GetNotificationMessage¶
Get message of currently displayed notification window.
OracleForms.GetNotificationMessage()
Returns:
popup window message.
GetNotificationTitle¶
Get title of currently displayed notification window.
OracleForms.GetNotificationTitle(timeout)
Parameters:
| Name | Type | Description |
|---|---|---|
| timeout | number | Maximum time to wait (milliseconds). Optional, Default: "10000". |
Returns:
popup window title.
GetStatusMessage¶
Get status bar message.
OracleForms.GetStatusMessage()
Returns:
status bar message text.
GetVisibleDialogInfo¶
Get information about any visible dialog window (ChoiceBox or FWindow). Returns an object with type, title, and message properties, or null if no dialog. This is much faster than searching through the component tree.
OracleForms.GetVisibleDialogInfo()
Returns:
Object |
null: Dialog info object {type, title, message} or null.
GetVisibleDialogMessage¶
Get the message of any visible dialog window (ChoiceBox or FWindow). This is much faster than searching through the component tree.
OracleForms.GetVisibleDialogMessage()
Returns:
string |
null: Dialog message or null if no dialog visible.
GetVisibleDialogTitle¶
Get the title of any visible dialog window (ChoiceBox or FWindow). This is much faster than searching through the component tree.
OracleForms.GetVisibleDialogTitle()
Returns:
string |
null: Dialog title or null if no dialog visible.
HasVisibleErrorDialog¶
Quickly check if an error dialog (ChoiceBox with title "Error") is currently visible. This is much faster than searching through the component tree.
OracleForms.HasVisibleErrorDialog()
Returns:
true if an error dialog is visible, false otherwise.