Adding Interactivity to Your Integrated Excel Workbook 8-11
8.2.8 What Happens at Runtime When an Action Set Provides an Alert
Figure 8–8 shows the alert message that appears at runtime when the action set
invoked by the ADF Button component labeled Upload to Server successfully completes execution.
Figure 8–8 Runtime View of an Alert Message
8.2.9 How to Configure Error Handling for an Action Set
You specify values for an action set’s ActionOptions properties to determine what an action set does if one of the following events occurs:
■
An action in the action set fails
■
All actions in the action set complete successfully For information about how to invoke these editors, or about an ADF component’s
property inspector, see Chapter 5, Getting Started with the Development Tools.
More information about action set properties can be found in
Table A.11 .
To configure error handling for an action set: 1.
Open the integrated Excel workbook.
2. Open the appropriate editor or property inspector and configure values for the
action set’s ActionOptions properties as described in the following table.
Table 8–3 ActionOptions Properties
Set this property... To...
AbortOnFailure True default value so that the action set does not any execute
any further actions if the current action fails. When set to False, the action set executes all actions regardless of the success or
failure of previous actions.
FailureActionID Specify an ADF Model action to invoke if an action set does not
complete successfully. For example, you could specify an ADF Model action that rolls back changes made during the
unsuccessful invocation of the action set.
Note that calling an action set that changes a record set’s currency during the execution of FailureActionID methods
is not supported. The Rollback method also should not be specified as the FailureActionID in an action set.
8-12 Desktop Integration Developers Guide for Oracle Application Development Framework
3. Click OK.
8.2.10 How to Invoke a Confirmation Action in an Action Set
The Confirmation action presents the end user with a simple message dialog that displays the title and prompt message specified in the Confirmation action properties.
The execution of the action set pauses until the end user clicks one of the two buttons provided. If the user clicks OK, the action sets proceed with the remaining actions in
the Action Set. If the user clicks Cancel, the action set is aborted at that point and the remaining actions are not invoked. As there is no error or success, the
FailureActionID or SuccessActionID action is not invoked.
To invoke a Confirmation action from a component 1.
Open the integrated Excel workbook.
2. Open the Action Collection Editor and click the down arrow in the Add button to
open a dropdown list, as illustrated here.
3. Select Confirmation and configure its Data properties as described in the
following list:
■
CancelButtonLabel Specify an EL expression or string that evaluates to a message to appear in the
Cancel
button of the dialog. The default EL expression is: {_ADFDIres[DIALOGS_CANCEL_BUTTON_LABEL]}
■
OKButtonLabel Specify an EL expression or string that evaluates to a message to appear in the
OK
button of the dialog. The default EL expression is: {_ADFDIres[DIALOGS_OK_BUTTON_LABEL]}
■
Prompt Specify an EL expression or string that evaluates to a message to appear as the
prompt of the dialog. The default EL expression is: {_ADFDIres[DIALOGS_ACTION_CONFIRM_PROMPT]}
■
Title SuccessActionID
Specify an ADF Model action to invoke if an action set completes successfully. For example, you could specify an action
binding that executes a commit action. A value for this property is optional and you can specify a final action, such as an action
binding that executes a commit action, in the action set itself.
Note that calling an action set that changes a record set’s currency during the execution of SuccessActionID methods
is not supported.
Table 8–3 Cont. ActionOptions Properties
Set this property... To...
Adding Interactivity to Your Integrated Excel Workbook 8-13
Specify an EL expression or string that evaluates to a title of the confirmation dialog to display at runtime. The default EL expression is:
{_ADFDIres[DIALOGS_ACTION_TITLE]}
4.
Optionally, enter a comment in the Annotation property about the purpose of the action that you are configuring. The value you set for this property has no
functional impact.
5. Click OK.
Figure 8–9 shows the Action Collection Editor with default attribute values for a
Delete button.
Figure 8–9 Confirmation Action Attributes
8.2.11 What Happens at Runtime When an Action Set Provides a Confirmation
Once the action set is invoked, the user is prompted with a confirmation dialog. If the user clicks OK, the next action operation is performed; and if the user clicks Cancel,
the Action Set execution terminates without an error.
Figure 8–10 shows a default Confirmation dialog with OK and Cancel buttons.
Figure 8–10 Confirmation Dialog
Note: If the user cancels a Confirmation action, the
FailureActionID binding does not run.
8-14 Desktop Integration Developers Guide for Oracle Application Development Framework
8.3 Configuring the Runtime Ribbon Tab
You can configure the runtime ribbon tab in the Excel Ribbon with items that invoke Oracle ADF functionality in your integrated Excel workbook. In the Runtime Ribbon
Tab group, setting the Visible workbook property to True makes this tab appear at runtime. The Title property determines the title of the tab that the end user sees at
runtime. By default, the title is MyWorkbook, as illustrated in
Figure 8–11 .
Figure 8–11 Workbook Properties for Runtime Ribbon Tab
At runtime, the tab appears as the last tab in the Ribbon and all your configured commands appear in various groups of the tab, as illustrated by
Figure 8–12 .
Figure 8–12 Runtime View of the Ribbon Tab
Figure 8–13 illustrates the runtime ribbon tab in EditPriceList.xlsx with two
commands configured for worksheet. At runtime, the commands are divided into four groups: items that invoke commands on the workbook, items that invoke commands
on the current worksheet, a command group to clear all data, and a command workgroup to display ADF Desktop Integration version information.
Figure 8–13 Runtime View of Ribbon Tab in EditPriceList.xlsx
You configure the Workbook Commands property in the properties of the workbook so that the runtime ribbon tab contains commands that allow the end user to invoke
