Adding Interactivity to Your Integrated Excel Workbook 8-5
To invoke a component action from an action set: 1.
Open the integrated Excel workbook.
2. Open the Action Collection Editor and invoke the dropdown list from the Add
button illustrated here.
3. Select ComponentAction and configure its properties as described in the
following list:
■
ComponentID
Click the ellipsis button ... beside the input field for ComponentID to invoke the Choose Component Method dialog and select the component action that
the action set invokes at runtime. This populates the ComponentID and Method input fields.
■
Action The component’s action that the action set invokes at runtime.
■
Annotation Optionally, enter a comment about the purpose of the action that you are
configuring. The value you set for this property has no functional impact.
4. Click OK.
8.2.3 What You May Need to Know About an Action Set Invoking a Component Action
Note the following pieces of information about the behavior of action sets in integrated Excel workbooks.
Verifying an Action Set Invokes the Correct Component Action When creating an action set, ensure that you invoke the component action from the
correct instance of a component when a worksheet includes multiple instances of an ADF Read-only Table or ADF Table component.
Figure 8–3 shows the Choose
Component Action dialog displaying two instances of the ADF Read-only Table component. Use the value of the ComponentID property described in
Table A–1 to
correctly identify the instance of a component on which you want to invoke a component action.
8-6 Desktop Integration Developers Guide for Oracle Application Development Framework
Figure 8–3 Choose Component Method Dialog
Invoking Action Sets in a Disconnected Workbook End users can use integrated Excel workbooks while disconnected from a
Fusion web application
, as described in Chapter 15, Using an Integrated Excel Workbook Across
Multiple Web Sessions and in Disconnected Mode. Some component actions, such as
the Download action of the ADF Table component, require a connection to the Fusion web application to complete successfully. If the end user invokes an action set that
includes such a component action, the integrated Excel workbook attempts to connect to the Fusion web application and, if necessary, invokes the authentication process
described in
Section 11.2, Authenticating the Excel Workbook User.
8.2.4 How to Invoke an Action Set from a Worksheet Event
ADF Desktop Integration provides several worksheet events that, when triggered, can invoke an action set. The following worksheet events can invoke an action set:
■
Startup
■
Shutdown Do not invoke a Dialog action from this event if the Dialog action’s Target
property is set to TaskPane.
■
Activate
■
Deactivate You add an element to the array of events WorksheetEvent[] Array referenced
by the Events worksheet property. You specify an event and the action set that it invokes in the element that you add. For more information about the Events
worksheet property and the worksheet events that can invoke an action set, see
Table A–19 . See
Table A–14 for more information about action sets.
Use the WorkSheetEvent Collection Editor to specify an action set to be invoked by a worksheet event.
To invoke an action set from a worksheet event: 1.
Open the integrated Excel workbook.
2. In the ADF Desktop Integration task pane, click Worksheet Properties to display
the Edit Worksheet Properties dialog.
Adding Interactivity to Your Integrated Excel Workbook 8-7
3. Click the ellipsis button ... beside the input field for the Events property to
display the WorksheetEvent Collection Editor.
4. Click Add to add a new element that specifies an event and a corresponding
action set that the event invokes. Figure 8–4
shows an example from the EditPriceList-DT.xlsx file in the Master Price List module where the worksheet event, Startup, invokes an action
set that invokes the ADF Table component’s Download action.
Figure 8–4 Worksheet Startup Event Invokes an Action Set
5. Click OK.
8.2.5 How to Display a Status Message While an Action Set Executes
You can display a status message to end users while an action set executes by specifying values for the Status properties in an action set.
Some of the default values for properties in the ActionSet.Status group are EL expressions that resolve to strings defined in the reserved resource bundle at runtime.
You can replace these default values with EL expressions that refer to your custom resource bundles. For more information, see
Section 10.2, Using Resource Bundles in an Integrated Excel Workbook.
You use the Action Collection Editor to configure values for the ActionSet.Status properties.
To display a status message: 1.
Open the integrated Excel workbook.
2.
Open the Action Collection Editor.
3.
Set values for the properties in the ActionSet.Status group of properties as described in the following table.
8-8 Desktop Integration Developers Guide for Oracle Application Development Framework
Figure 8–5 shows the values configured for the ActionSet.Status group of
properties of the Search ADF Button component in the EditPriceList-DT.xlsx workbook of the Master Price List module that is
labeled Search at runtime.
Figure 8–5 Status Message Properties in an Action Set
For more information about the ActionSet.Status group of properties, see the entry for Status in
Table A–14 .
4. Click OK.
8.2.6 What Happens at Runtime When an Action Set Displays a Status Message
Once an action set is invoked, a status message appears if the ActionSet.Status properties are configured to display a status message.
Figure 8–6 shows the status
message that appears at runtime when the action set configured for the Search button in the EditPriceList-DT.xlsx workbook executes.
Table 8–1 ActionSet.Status Group of Properties
For this property... Enter or select this value...
Enabled True to display a status message. True is the default value.
Message An EL expression or string that resolves to the status message to
display at runtime. For example, the Search button in the Master Price List module’s EditPriceList-DT.xlsx file has the
following value configured for the Message property:
Searching and downloading... Title
An EL expression or string that resolves to the title of the status message to display at runtime. For example, the Search button
in the Master Price List module’s EditPriceList-DT.xlsx file has the following value configured for the Title property:
Query Products For this property...
Enter or select this value...
Adding Interactivity to Your Integrated Excel Workbook 8-9
Figure 8–6 Runtime View of Status Message
8.2.7 How to Provide an Alert After the Invocation of an Action Set
