This appendix lists and describes the properties of ADF Desktop Integration components. It also describes the actions that certain components in this module expose.
This appendix includes the following sections:
Section A.1, "Frequently Used Properties in the ADF Desktop Integration"
Section A.7, "ModelDrivenColumnComponent Subcomponent Properties"
Section A.10, "ADF Read-only Table Component Properties and Actions"
Table A-1 lists alphabetically properties in ADF Desktop Integration that many components reference.
Table A-1 Frequently Used Properties in ADF Desktop Integration
Name | Type | EL | Description |
---|---|---|---|
|
N |
For information about action sets, see Section A.11, "Action Set Properties." |
|
|
String |
N |
Use this field to enter a comment about the component's use in the worksheet. Comments you enter have no effect on the behavior of the workbook. They are the equivalent of code comments. |
|
String |
N |
ADF Desktop Integration generates this string to uniquely identify each instance of an ADF component in an integrated Excel workbook. |
|
String |
Y |
Specify an EL expression that is evaluated at runtime. For information about EL expressions in ADF Desktop Integration, see Appendix B, "ADF Desktop Integration EL Expressions." For information about using labels, see Section 9.4, "Using Labels in an Integrated Excel Workbook." |
|
N |
This property defines the upper-left corner of the Oracle ADF component in the integrated Excel workbook. |
|
|
Boolean |
Y |
Set this property to
To avoid end user confusion, apply styles to the cells where you set |
|
This group of properties allows you configure the number of rows that the ADF Table component or ADF Read-only Table component download and display. For more information, see Section 7.17, "Limiting the Number of Rows Your Table-Type Component Downloads." |
||
|
Boolean |
N |
Set to A value for this property is required. |
|
Integer |
Y |
Specify an EL expression that evaluates to the maximum number of rows to download. The component evaluates the EL expression when it invokes its Note that setting the value of |
|
String |
Y |
Write an EL expression to generate a message to display to the end user if the number of rows available to download exceeds the number specified by The default value for
You can specify a string key from a custom resource bundle to use instead of the default value. Write a value similar to the following for a string key in your resource bundle if you want the warning message to let the end user know how many rows he or she can download:
where Write an EL expression similar to the following for
where If the value for this property is null, the |
|
String |
Y |
Specifies the style in the current Excel workbook to apply when the Oracle ADF component is rendered. For more information, see Section 9.2, "Working with Styles." |
|
Varies |
Y |
This property references an EL expression that is evaluated after the invocation of the ADF Table component's |
Table A-2 lists alphabetically the properties of the ADF Input Text component.
Table A-2 ADF Input Text Component Properties
Name | Description |
---|---|
|
For information about this property, see Table A-1. |
|
For information about this property, see Table A-1. |
|
Specifies the action set invoked when a user double-clicks the cell. For information about action sets, see Section A.11, "Action Set Properties." |
|
For information about this property, see Table A-1. |
|
For information about this property, see Table A-1. |
|
For information about this property, see Table A-1. |
|
For information about this property, see Table A-1. |
Table A-3 lists alphabetically the properties of the ADF Output Text component.
Table A-3 ADF Output Text Component Properties
Name | Description |
---|---|
|
For information about this property, see Table A-1. |
|
For information about this property, see Table A-1. |
|
Specifies the action set invoked when a user double-clicks the cell. For information about action sets, see Section A.11, "Action Set Properties." |
|
For information about this property, see Table A-1. |
|
For information about this property, see Table A-1. |
|
For information about this property, see Table A-1. |
The ADF Label component displays a static string value at runtime. ADF Desktop Integration generates the value when the EL expression that the Label
property references is evaluated. For information about using labels, see Section 9.4, "Using Labels in an Integrated Excel Workbook."
Table A-4 lists alphabetically the properties that the ADF Label component references.
Table A-4 ADF Label Component Properties
Name | Description |
---|---|
|
For information about this property, see Table A-1. |
|
For information about this property, see Table A-1. |
|
For information about this property, see Table A-1. |
|
For information about this property, see Table A-1. |
|
For information about this property, see Table A-1. |
Table A-5 lists the properties of the ADF List of Values component. For information about creating an ADF List of Values component, see Section 6.6, "Inserting an ADF List of Values Component."
Table A-5 ADF List of Values Component Properties
Name | Type | EL | Description |
---|---|---|---|
|
For information about this property, see Table A-1. |
||
|
For information about this property, see Table A-1. |
||
|
List binding |
N |
Select the list binding whose value at runtime determines the choices available in the dependent list of values at runtime. The list binding that you select can be a model-driven list. For more information about dependent list of values, see Section 8.8, "Creating Dependent Lists of Values in an Integrated Excel Workbook." |
|
List binding |
N |
Select the list binding that defines the values available in the list of values. The list binding that you select can be a model-driven list. |
|
Boolean |
N |
For information about this property, see Table A-1. |
|
For information about this property, see Table A-1. |
||
|
For information about this property, see Table A-1. |
The TreeNodeList is an ADF Table subcomponent that renders dropdown menus in columns of the ADF Table component at runtime. It provides the same functionality to end users as the ADF List of Values component.
The TreeNodeList subcomponent does not appear in the components palette of the ADF Desktop Integration task pane. Instead, you configure properties for this subcomponent when you specify TreeNodeList
as the subcomponent to invoke for the ADF Table component's UpdateComponent
or InsertComponent
table column properties described in Section A.9.2, "ADF Table Component Column Properties."
Table A-6 describes the properties that you configure for the TreeNodeList subcomponent.
Table A-6 TreeNodeList Subcomponent Properties
Name | Type | EL | Description |
---|---|---|---|
|
Tree binding attribute or List binding |
Y |
Specify the tree binding attribute or list binding that serves as the parent list of values in a dependent list of values. Note that the tree binding attribute you specify must be associated with a model-driven list. For more information about dependent list of values, see Section 8.8, "Creating Dependent Lists of Values in an Integrated Excel Workbook." |
|
Tree binding attribute |
Y |
Specify the tree binding attribute associated with a model-driven list that defines the values available in the runtime dropdown menu to appear in the ADF Table component's column. |
|
Boolean |
Y |
For information about this property, see Table A-1. |
The ModelDrivenColumnComponent subcomponent, like the TreeNodeList subcomponent, does not appear in the components palette of the ADF Desktop Integration task pane. Instead, you configure properties for this subcomponent when you specify ModelDrivenColumnComponent
as the subcomponent to invoke for the ADF Table component's UpdateComponent
or InsertComponent
table column properties described in Section A.9.2, "ADF Table Component Column Properties."
Table A-7 describes the properties that you configure for the ModelDrivenColumnComponent subcomponent.
Table A-7 ModelDrivenColumnComponent Subcomponent Properties
Name | Type | EL | Description |
---|---|---|---|
|
Specifies the action set invoked when a user double-clicks the cell. For information about action sets, see Section A.11, "Action Set Properties." |
||
|
Boolean |
Y |
For information about this property, see Table A-1. |
|
Varies |
Y |
For information about this property, see Table A-1. |
Table A-8 lists alphabetically the properties of the ADF Button component.
Table A-8 ADF Button Component Properties
Name | Description |
---|---|
|
For information about this property, see Table A-1. |
|
Specify the action set to invoke when a user clicks the button. For information about action sets, see Section A.11, "Action Set Properties." |
|
For information about this property, see Table A-1. |
|
For information about this property, see Table A-1. |
|
This property is an Excel cell reference. Used with |
|
For information about this property, see Table A-1. |
The ADF Table component uses the properties and component actions listed here.
Table A-9 lists alphabetically the properties the ADF Table component uses.
Table A-9 ADF Table Component Properties
Name | Type | EL | Description |
---|---|---|---|
|
For information about this property, see Table A-1. |
||
|
This group of properties enables you to configure batch options for the ADF Table component. For more information about how you use these properties, see Section 7.10, "Batch Processing in an ADF Table Component." |
||
|
Integer |
N |
Specifies how many rows to process before an ADF Table component action ( A value for this property is required. |
|
Action binding |
N |
Specify an action binding to invoke when the number of rows specified by |
|
Boolean |
N |
Set this property to |
|
Action binding |
N |
Specify an action binding to invoke at the beginning of each batch. For example, this property might be used for an operation like "start transaction", if required by a particular database. A value for this property is optional. |
|
An array of columns. For information about the properties that each column in the array supports, see Section A.9.2, "ADF Table Component Column Properties." |
||
|
For information about this property, see Table A-1. |
||
|
For information about this property, see Table A-1. |
||
|
This group of properties allows you specify which actions are enabled and can be invoked. |
||
|
Action binding |
N |
Specify an action binding to invoke for each row flagged for deletion. A value for this property is optional. |
|
Boolean |
N |
Set to A value for this property is required. |
|
Action binding |
N |
Specify an action binding to invoke if failures occur during the processing of rows. A value for this property is optional. |
|
Action binding |
N |
Specify an action binding to invoke for each row inserted using the ADF Table component A value for this property is optional. |
|
Action binding |
N |
Specify an action binding to invoke for each row inserted using the A value for this property is optional. |
|
Boolean |
N |
Set to If you set this property to
Which property ( For more information about inserting rows in an ADF Table component, see Section 7.5, "Configuring an ADF Table Component to Insert Data." |
|
Boolean |
N |
Set to The property is ignored if |
|
Action binding |
N |
Specify an action binding to invoke for each row updated. A value for this property is optional. |
|
Boolean |
N |
Set to A value for this property is required. |
|
Set values for the Set a value for the |
||
|
Array |
N |
Specify values for the properties in this array to determine the attributes for which data is cached. Each
Do not configure a component (for example, an ADF Table component's column or an ADF Input Text component) so the end user can view or edit an attribute binding that you have also specified for an element in the For information about using the |
|
Binding |
N |
Specify the row-specific attribute of the tree binding used to determine if a row has been modified by another user since the row was last downloaded by to your integrated Excel workbook. For more information, see Section 12.7, "Handling Data Conflicts When Uploading Data from a Workbook." |
|
For information about this group of properties, see Table A-1. |
||
|
Binding |
N |
Specify a tree binding from the current worksheet's page definition file. You must specify a value for this property so that row downloads and uploads function properly. For more information about the page definition requirements for an integrated Excel workbook, see Table 4-1. |
|
Attribute binding |
Y |
Write an EL expression to specify an attribute of the tree binding that you specified as the value for A value for this property is optional if the:
A value is required if the tree binding's iterator does not expose a |
Table A-10 describes the properties that a column in the TableColumn array can use.
Table A-10 ADF Table Component Column Properties
Name | Type | EL | Description |
---|---|---|---|
|
For information about this property, see Table A-1. |
||
|
String |
Y |
Write an EL expression that resolves to an Excel style name that is applied to each cell in the column. |
|
Boolean |
N |
Set to |
|
String |
Y |
Write an EL expression that, when evaluated at runtime, displays a label in the column header. |
|
String |
Y |
Write an EL expression that resolves to an Excel style name that is applied to each cell in the column header. |
|
String |
N |
Assign a name to the column to identify it and its purpose. The value that you assign for this property has no functional impact. However, you must specify a value and the value that you specify must be unique within the list of columns. It serves to help you keep track of columns in the ADF Table component. The following IDs are reserved to the three default columns in the ADF Table component:
For more information about these columns, see Section 7.11, "Special Columns in the ADF Table Component." |
|
ADF component |
N |
Specifies the properties of the component that represents the binding for insert operations. This component can be one of the following:
When |
|
Boolean |
N |
Set to The default value is |
|
ADF component |
N |
Specifies the properties of the component that represents the binding for update and download operations. This component can be one of the following:
|
|
Boolean |
Y |
Write an EL expression that resolves to If you make a column dynamic, the ADF Table component ignores the value of the |
Table A-11 describes the component actions available for use with the ADF Table component.
Table A-11 ADF Table Component Actions
Component Action | Description |
---|---|
|
Clears the values of cached attributes for the current row of the ADF Table component. Only a |
|
Invokes a specified action on each of a set of flagged rows in the ADF Table component and then removes these rows from the ADF Table component. For more information, see Section 7.9, "Configuring an ADF Table Component to Delete Rows in the Fusion Web Application." |
|
Displays error details for the current row in the ADF Table component if error details are available. This action should only be invoked from a column's action set in an ADF Table component. By default, the |
|
Displays a detailed list of errors in a message dialog for the ADF Table component if any errors are available. Do not invoke this action from a column's action set in an ADF Table component. Instead configure an action set for an ADF Button, ADF Output Text component, or worksheet ribbon button to invoke this action. |
|
Download the rows corresponding to the current state of |
|
Downloads the flagged rows corresponding to the current set of items available within |
|
Invoke this action to download rows to the ADF Table component from the Fusion web application and treat each row as a pending insert. Do not specify Specify the The For more information, see Section 7.7, "Configuring a Worksheet to Download Pre-Insert Data to an ADF Table Component" and Section 15.2, "Restore Server Data Context Between Sessions." |
|
Sets the flag for all rows. Invoke this action to set a flag character in all rows of the
It appears as a solid circle. For more information about the |
|
This action performs the following actions:
If the ADF Table component contains pending changes that have not been saved in the integrated Excel workbook, a dialog appears to the end user that allows cancellation of invocation of this action. |
|
After an action set invokes a |
|
Specify this component action to clear all flags from the |
|
Synchronizes data from the row in the ADF Table component's iterator in the Fusion web application that corresponds to the current worksheet row to the worksheet. As this action acts upon the current worksheet row, only a The ADF Table component does not evaluate or apply the value of a column's |
|
Synchronizes any pending changes in the current worksheet row that the ADF Table component references to the Fusion web application. |
|
Removes flags from cells in the For more information about the |
|
Uploads pending changes to the Fusion web application. For more information, see Section 7.8, "Configuring an ADF Component to Upload Changes from an ADF Table Component." For more information about resolving data conflict between the Excel workbook and the Fusion web application, see Section 12.7, "Handling Data Conflicts When Uploading Data from a Workbook". |
The ADF Read-only Table component exposes one action, Download
. This action downloads the current rows in the table identified by the ADF Read-only Table property, TreeID
. Table A-12 describes TreeID
and the other properties that the ADF Read-only Table component supports.
Table A-12 ADF Read-only Table Component Properties
Name | Type | EL | Description |
---|---|---|---|
|
For information about this property, see Table A-1. |
||
|
Array |
N |
References an array of read-only columns. For information about the properties that a column in this array can support, see Table A-13. |
|
For information about this property, see Table A-1. |
||
|
For information about this property, see Table A-1. |
||
|
For information about this group of properties, see Table A-1. |
||
|
Tree binding |
N |
References a tree binding ID from the page definition file associated with the current worksheet if the ADF Read-only Table component was created by inserting a tree binding into the worksheet. |
Table A-13 lists alphabetically the properties that a column in the ReadOnlyColumn
array can use.
Table A-13 ADF Read-only Table Component Column Properties
Name | Type | EL | Description |
---|---|---|---|
|
For information about this property, see Table A-1. |
||
|
String |
Y |
Write an EL expression that resolves to an Excel style name that is applied to each cell in the column. |
|
String |
Y |
Write an EL expression that resolves to a label for the column header. |
|
String |
Y |
Write an EL expression that resolves to an Excel style name that is applied to each cell in the column header. |
|
String |
N |
Assign a name to the column to identify it and its purpose. The value that you assign for this property has no functional impact. However, you must specify a value and the value that you specify must be unique within the list of columns. It serves to help you keep track of columns in the ADF Read-only Table component. |
|
ADF Component |
For information about the properties that this component supports, see Section A.3, "ADF Output Text Component Properties." |
Table A-14 lists alphabetically the properties that you can configure for an action set.
Table A-14 Action Set Properties
Name | Type | EL | Description |
---|---|---|---|
|
This group of properties specifies options for invoking local and remote actions. |
||
|
Boolean |
N |
When set to |
|
Action binding |
N |
Specify the action binding to invoke if an action set does not complete successfully. For example, you could specify an action binding that rolls back changes made during the unsuccessful invocation of the action set. |
|
Action binding |
N |
Specify an action binding to invoke if an action set completes successfully. For example, you could specify an action binding that executes a |
|
Array |
N |
Specifies an ordered array of actions. An action can be one of the following:
|
|
This group of properties determines if and how an alert-style dialog appears to the user to indicate that the requested action is complete. The dialog that appears contains one button that allows the user to acknowledge the message and dismiss the dialog. For information about how to display an alert message, see Section 8.2.7, "How to Provide an Alert After the Invocation of an Action Set." Many properties in this group make use of EL expressions to retrieve string values from resource bundles. For more information about using EL expressions, see Section 10.2, "Using Resource Bundles in an Integrated Excel Workbook." |
||
|
Boolean |
N |
Set to For more information, see Section 8.2.7, "How to Provide an Alert After the Invocation of an Action Set." |
|
String |
Y |
Specify an EL expression that evaluates to a message to appear in the dialog if errors occur during execution of the action set. The default EL expression is: #{_ADFDIres['DIALOGS_ACTION_ALERT_FAILURE_PROMPT']} |
|
String |
Y |
Specify an EL expression that evaluates to a message to appear in the OK button of the dialog. The default EL expression is: #{_ADFDIres['DIALOGS_OK_BUTTON_LABEL']} |
|
String |
Y |
Specify an EL expression that evaluates to a message to appear in the dialog if no errors occur during the execution of the action set. The default EL expression is: #{_ADFDIres['DIALOGS_ACTION_ALERT_SUCCESS_PROMPT']} |
|
String |
Y |
Specify an EL expression that evaluates to a message to appear in the title area of the dialog. The default EL expression is: #{_ADFDIres['DIALOGS_ACTION_TITLE']} |
|
For information about |
||
|
This group of properties determines if and how a status message appears during the execution of an action set. For information about how to display a status message, see Section 8.2.5, "How to Display a Status Message While an Action Set Executes." Many properties in this group make use of EL expressions that reference string keys defined in resource bundles. For more information, see Section 10.2, "Using Resource Bundles in an Integrated Excel Workbook." |
||
|
Boolean |
N |
If |
|
String |
Y |
Specify an EL expression to evaluate and display in the status window while the action set executes. The default value is: #{_ADFDIres['STATUS_MESSAGE_PROMPT']} |
|
String |
Y |
Specify an EL expression to evaluate and display in the title area of the status window while the action set executes. The default value is: #{_ADFDIres['DIALOGS_ACTION_TITLE']} |
Table A-15 lists alphabetically the properties that the Confirmation
action in the array of Actions
of an action set supports. For information about the other properties the array of Actions
and action sets use, see Table A-14.
Table A-15 Confirmation Action Properties
Name | Type | EL | Description |
---|---|---|---|
|
For information about |
||
|
String |
Y |
An EL expression that is evaluated and displayed in the Cancel button at runtime. The default value is: #{_ADFDIres['DIALOGS_CANCEL_BUTTON_LABEL']} |
|
String |
Y |
An EL expression that is evaluated and displayed in the OK button at runtime. The default value is: #{_ADFDIres['DIALOGS_OK_BUTTON_LABEL']} |
|
String |
Y |
An EL expression that is evaluated and displayed in the main area of the confirmation dialog at runtime. The default value is: #{_ADFDIres['DIALOGS_ACTION_CONFIRM_PROMPT']} |
|
String |
Y |
An EL expression that is evaluated and displayed in the title area of the confirmation dialog at runtime. The default value is: #{_ADFDIres['DIALOGS_ACTION_TITLE']} |
Table A-16 describes the properties that the Dialog
action in the array of Actions
of an action set supports. For information about the other properties the array of Actions
and action sets use, see Table A-14.
For information about how to use the properties in Table A-16 to invoke a web page from a Fusion web application, see Section 8.4, "Displaying Web Pages from a Fusion Web Application."
Table A-16 Dialog Action Properties
Name | Type | EL | Description |
---|---|---|---|
|
String |
N |
For information about this property, see Table A-1. |
|
String |
N |
Specify the web page that the action invokes. Relative and absolute URLs are valid values. |
|
Boolean |
N |
Set to |
|
List |
N |
Specifies how the web page the action invokes is rendered. Select:
|
|
String |
Y |
Write an EL expression that resolves to the title of the |
|
Integer |
N |
Specify the initial size in pixels of the dialog that appears to the user. Valid values range from |
Table A-17 describes the actions that a workbook can invoke. For information about configuring ribbon buttons to invoke these actions, see Section 8.3.1, "How to Define a Workbook Command Button for the Runtime Ribbon Tab."
Action | Description |
---|---|
|
When invoked, this action creates a new session between the integrated Excel workbook and the Fusion web application. If invoked when a session has already been established, it first invokes the |
|
When invoked, ADF Desktop Integration sends a request to the Fusion web application to invalidate the session between the integrated Excel workbook and the Fusion web application. After invoking this action, the end user must be authenticated the next time the Excel workbook accesses the Fusion web application. |
|
When invoked, this action clears all data entered by the user from cells that reference Oracle ADF bindings. Tables, such as those created by the ADF Table and ADF Read-only Table components, will be truncated so that they only display header rows with labels cleared. Values in cells that reference the Input Text or Output Text components are cleared. Column headers and labels are cleared as well. References to all resource bundles that the integrated Excel workbook uses are cleared. Worksheets that do not contain bindings or reference a page definition file remain unchanged. A dialog prompts the end user to confirm invocation of this action. Once the end user confirms invocation, ADF Desktop Integration executes the following events after invocation of the action:
Invocation of the
|
|
When invoked, this action launches a dialog that shows the current value of the If the end user chooses to change the value of
|
|
When invoked, this action launches a dialog called About that displays information defined in the |
Table A-18 lists alphabetically the ADF Desktop Integration properties that an Excel workbook can use.
Table A-18 Workbook Properties
Name | Type | EL | Description |
---|---|---|---|
|
String |
N |
Specify the absolute path to the directory that is the root for the JDeveloper application workspace ( For example, the value of this property in a workbook integrated with the Master Price List module could be something similar to the following: C:\FusionOrderDemo\MasterPriceList ADF Desktop Integration prompts you to specify a value for this property the first time that you open an integrated Excel workbook. For more information, see Section 4.2.2, "How to Configure a New Integrated Excel Workbook." |
|
Array |
N |
An array of name-value pairs that resolve to resource bundle references (for example, For information about branding your integrated Excel workbook, see Section 9.6, "Branding Your Integrated Excel Workbook." |
|
Integer |
N |
Specify the initial size in pixels of the login dialog that appears to the user. Valid values range from |
|
Array |
N |
An array of workbook initialization parameters that you configure to pass the parameters from a page in a Fusion web application to an integrated Excel workbook. You can define multiple workbook initialization parameters in the Fusion web application's page. Each workbook initialization parameter (parameter that references a URL argument) that you define in a page must be specified in a Each element in the array supports the following properties:
For information about using this property, see Section 14.5, "Passing Parameter Values from a Fusion Web Application Page to a Workbook." |
|
String |
N |
Specify the name of a JDeveloper project in the current JDeveloper workspace. ADF Desktop Integration attempts to load the When you open an integrated Excel workbook for the first time in design mode, ADF Desktop Integration searches for a ADF Desktop Integration loads the names of the available projects from the application_name.jws file specified by |
|
String |
N |
Specify the path to the ADF Desktop Integration remote servlet. This path must be relative to the value specified for
|
|
Array |
N |
Specifies an array of resource bundles to register with the workbook. Each element in the array supports the following properties:
For more information, see Section 10.2, "Using Resource Bundles in an Integrated Excel Workbook." |
|
- |
- |
This group of properties defines whether and how a Ribbon tab appears in Excel at runtime. The following entries in this table describe the properties in the |
|
String |
N |
For information about this property, see Section A.1, "Frequently Used Properties in the ADF Desktop Integration." |
|
Boolean |
N |
If |
|
String |
Y |
Specify an EL expression that evaluates to the title that appears for the Ribbon tab in the title area. Excel imposes a maximum limit of 1024 characters for Ribbon tab titles. Ensure that the runtime value of the EL expression you specify does not exceed 1024 characters as ADF Desktop Integration truncates the value so that Excel does not generate an error message. |
|
Array |
N |
Each element in this array corresponds to a workbook command at runtime. Each element in the array uses the following properties:
|
|
String |
N |
A fully qualified URL to the Fusion web application's root. |
|
String |
N |
Specify the path to the directory that contains the web pages that you intend to use with your integrated Excel workbooks. The value that you specify for the path most be relative to the value of |
|
String |
N |
A unique identifier for the integrated Excel workbook. ADF Desktop Integration generates the unique identifier when you open the workbook for the first time in design mode. The value cannot be modified. However, ADF Desktop Integration can generate a new value if you use the Reset WorkbookID link in the Edit Workbook Properties dialog. The value of this property is used during tamper check, as described in Section 11.3, "Checking the Integrity of an Integrated Excel Workbook's Metadata." |
An Excel worksheet with ADF Desktop Integration can invoke the following actions:
UpSync
Synchronizes any pending changes from the ADF Input Text and ADF List of Values components in the worksheet to the Fusion web application.
DownSync
Downloads any changes from the Fusion web application to the ADF Input Text, ADF Output Text, and ADF List of Values components in the worksheet.
DisplayWorksheetErrors
Displays a detailed list of errors in a message dialog for the integrated Excel worksheet if any errors are available. Invoke this action in an action set that is invoked by an ADF component (other than the ADF Table-type components) or a worksheet ribbon button.
When you configure an ADF Button component to invoke an action binding or method action binding, the action set to invoke when a user clicks the ADF Button component at runtime is populated as follows by default:
UpSync
Action or method action binding that you specify for the ADF Button component
DownSync
If the first action that you invoke on a worksheet with an empty form is the UpSync
worksheet action, you may encounter errors. For this reason, ensure that the first action invoked is the DownSync
worksheet action. You can configure the ADF Button component's action set or one of the worksheet events (Startup
or Activate
) described in Table A-19 to invoke the DownSync
worksheet action first.
Table A-19 describes the ADF Desktop Integration properties that an Excel worksheet can use.
Table A-19 Worksheet Properties
Name | Type | EL | Description |
---|---|---|---|
|
String |
N |
For information about this property, see Table A-1. |
|
Array |
N |
Each element in this array specifies an action set to invoke if the associated worksheet event occurs. For information about action sets, see Section A.11, "Action Set Properties." For information about worksheet events, see the entry in this table for The following entries in this table prefaced by Events.n describe the properties that an element in this array supports where n refers to a specific element in the array. |
|
ActionSet |
N |
For more information about the properties of action sets, see Section A.11, "Action Set Properties." |
|
Boolean |
N |
The default value of this property is When set to |
|
String |
N |
For information about the annotation property, see Table A-1. |
|
List |
N |
The worksheet supports the following events that you can configure to invoke an action set:
Note that the worksheet events complete execution even if the action sets that it invokes fails. For more information about worksheet events and action sets, see Section 8.2.4, "How to Invoke an Action Set from a Worksheet Event." |
|
List |
N |
The worksheet provides two options:
The default value for this property is |
|
String |
N |
Specify a password to prevent end-users from turning off sheet protection at runtime. The maximum password length allowed by Excel is 255 characters. |
|
Array |
N |
Specify one or more workbook actions that appear as commands at runtime. Each command is an element in the
For more information about the If you want the |
|
String |
N |
Specify the page definition file to associate with the worksheet. For information about page definition files, see Section 4.3, "Working with Page Definition Files for an Integrated Excel Workbook." |
|
Array |
N |
An array of worksheet parameters that you configure to pass the parameters from a workbook
For information about using this property, see Section 14.5, "Passing Parameter Values from a Fusion Web Application Page to a Workbook." |
|
Set values for the Set a value for the |
||
|
Array |
N |
Specify values for the properties in this array to determine the attributes for which data is cached. Each
For more information about clearing the values of cached attributes, see Section 7.18, "Clearing the Values of Cached Attributes in an ADF Table Component." |
|
Binding |
N |
Specify the row-specific attribute of the tree binding used to determine if a row has been modified by another user since the row was last downloaded by to your integrated Excel workbook. For more information, see Section 12.7, "Handling Data Conflicts When Uploading Data from a Workbook." |
|
This group of properties references the attribute bindings that uniquely identify the row displayed in the current worksheet so that you can reestablish server data context across multiple sessions. For more information, see Section 15.2, "Restore Server Data Context Between Sessions." |
||
|
Array |
N |
Add elements to the
|
|
Binding |
N |
Specifies an attribute binding that uniquely identifies the row displayed in the current worksheet. This property is used at runtime to determine whether the server context has been reestablished properly for non-table type components in the worksheet. |
|
Boolean |
N |
The default value of this property is When set to |
|
String |
Y |
Specifies an EL expression that resolves to a string and sets the name of the worksheet. At design time, the EL expression can be of any length and can include the following special characters:
At runtime, the evaluated string can display a maximum of 31 characters and ignores the above special characters. If the length of the evaluated string exceeds 31 characters, the extra characters are truncated and are not displayed. Ensure that the EL expressions you write for the |