Before you install the Scripting Framework, be aware of the following:
This is an Early Developer Release of the OpenOffice.org Scripting Framework provided for users and developers of OpenOffice.org to try out and provide feedback. Future releases of the Framework may change.
The Scripting Framework is currently available in English only.
As the Scripting Framework project is still in development, display
of OpenOffice.org scripts is switched off by default in your OpenOffice.org
installation. To enable the Scripting Framework download one of the following UNO packages:
The execution of OpenOffice.org scripts can be assigned to menu and
key items
and also to application, document, object and dialog events.
To assign a script to a new menu item:
There are three example scripts supplied with the Scripting
Framework, Highlight, MemoryUsage, and ExportSheetsToHTML.
Highlight is a BeanShell application level script for Writer that allows the user to search for a word or phrase. It will highlight all instances in red and give a count of the number of instances.
The second example, MemoryUsage, is a Java script stored in a Calc spreadsheet that checks the current memory usage in the Java Virtual Machine and updates cells in the spreadsheet with the usage values. The spreadsheet also contains a graph which will update when the cell values are changed.
The ExportSheetsToHTML example is a JavaScript application level script for Calc which will save each individual sheet in a Calc spreadsheet as a separate html file.
Running the Highlight example
To run this example you first need to create a menu item from which you can execute the script.
Start OpenOffice.org and open an existing Writer document or create a new one.
Follow the steps for creating a menu
item in the Assigning OpenOffice.org Scripts section. The Highlight
example is available at OpenOffice.org Scripts/share/BeanShell/Highlight
Your new menu item will now be available and clicking on it will invoke the script.
You should see a Highlight Text dialog appear which you can use to highlight various text strings you are looking for in the document.
Running the MemoryUsage example
The Java version of the MemoryUsage example is already deployed inside an OpenOffice.org document, ExampleSpreadSheet.sxc. To run the Java example, just open:
<OpenOffice.org Installation>/user/Scripts/java/ExampleSpreadSheet.sxc.
You can then execute the MemoryUsage script by pressing CTRL+Shift+M
with the ExampleSpreadSheet.sxc window focused. You should see the
memory usage values being updated, and the graph should change to
reflect the new values. You can also find the MemoryUsage example under
OpenOffice.org Scripts/share/Java/MemoryUsage in the Tools/Configure
dialog.
Running the ExportSheetsToHTML
example
To run this example you first need to create or open an existing
spreadsheet document. If you have created a new document save it (eg.
c:\temp\mycalcdoc.sxc)
Follow the instructions in the Assigning OpenOffice.org Scripts section to create a key assignment for the script. You can find the ExportSheetsToHTML example at OpenOffice.org Scripts/share/JavaScript/ExportSheetsToHTML.
The Scripting Framework currently uses the same Security settings as OpenOffice.org Basic. The settings allow the user to control the execution of macros present in OpenOffice.org documents. Found in the Tools->Options dialog under OpenOffice.org->Security, these settings allow the user to specify the conditions under which it is permissable to execute document based OpenOffice.org Basic macros and OpenOffice.org scripts.
A full description of how these settings
work can be found by clicking
the "Help" button in the dialog, and then clicking "OpenOffice.org",
and
"Security" in the left-hand pane of the Help dialog. The possible
scenarios associated with the security settings are summarised in the
table below.
"Run Macro" |
"Confirm in the case of other document sources" |
"Show Warning before Running" |
Document path in "Path List" |
Behaviour |
---|---|---|---|---|
Never |
N/A |
N/A |
N/A |
Macros/Scripts never run. No warning displayed. |
According to path list |
No |
No |
No |
Macros/Scripts never run. No warning displayed. |
According to path list |
No |
No |
Yes |
Macros/Scripts run. No warning displayed. |
According to path list |
No |
Yes |
No |
Macros/Scripts never run. No warning displayed. |
According to path list |
No |
Yes |
Yes |
Warning displayed on document load. If "Run" button clicked macros will run, otherwise they will not. |
According to path list |
Yes |
No |
No |
Warning with checkbox to add path to path list is displayed on document load. If "Run" button clicked macros/scripts will run, otherwise they will not. Regardless of which button is clicked, if checkbox is ticked document path is added to "Path List". |
According to path list |
Yes |
No |
Yes |
Macros/Scripts run. No warning displayed. |
According to path list |
Yes |
Yes |
No |
Warning with checkbox to add path to path list is displayed on document load. If "Run" button clicked macros/scripts will run, otherwise they will not. Regardless of which button is clicked, if checkbox is ticked document path is added to "Path List". |
According to path list |
Yes |
Yes |
Yes |
Warning displayed on document load. If "Run" button clicked macros/scripts will run, otherwise they will not. |
Always |
N/A |
No |
N/A |
Macros/Scripts run. No warning displayed. |
Always |
N/A |
Yes |
N/A |
Warning displayed on document load. If "Run" button clicked macros/scripts will run, otherwise they will not |