Scripting Framework URI Specification

OpenOffice.org Developer's Guide

Scripting Framework

< Previous Section

Next Section >

• Using the Scripting Framework

• Running Macros
• Editing, Creating and Managing Macros

• The Organizer dialogs for BeanShell and JavaScript
• BeanShell Editor
• JavaScript Editor
• Basic and Dialogs
• Macro Recording

• Writing Macros
• How the Scripting Framework Works
• Writing a LanguageScriptProvider UNO Component using the Java Helper Classes

• The ScriptProvider Abstract Base Class
• Implementing the XScript Interface
• Implementing the ScriptEditor Interface
• Building and Registering Your ScriptProvider

• Writing a LanguageScriptProvider UNO Component From Scratch

• Scripting Framework URI Specification
• Storage of Scripts
• Implementation
• Integration with Extension Manager

< Previous Page

Next Page >

vnd.sun.star.script:MACROREF?language=Language&location=[user|share|document]

where:

• MACROREF is a name that identifies the macro and the naming convention for MACROREF identifiers is LanguageScriptProvider specific. It allows the LanguageScriptProvider to associate MACROREF with a macro. In the case of the LanguageScriptProviders for the Java based languages supported by OpenOffice.org e.g. (Java, JavaScript & Beanshell) the convention is Library.functionname where Library is the subdirectory under the language specific directory and functionname is the function name from the parcel-descriptor.xml in the Library directory. See Scripting Framework URI Specification.
• Language specifies the LanguageScriptProvider needed to execute the macro as described.

Example 1 – URI for a JavaScript macro Library1.myMacro.js located in the share directory of a OpenOffice.org installation.

 vnd.sun.star.script:Library1.myMacro.js?language=JavaScript&location=share

In general macros contained in extensions have the format

 vnd.sun.star.script:MACROREF?language=TheLanguage&location=[user:uno_packages/packageName|share:uno_packages/packageName]

Example 2 - URI for a JavaScript macro Library1.myMacro.js located in an extension called myUnoPkg.oxt located in share directory of a OpenOffice.org installation.

 vnd.sun.star.script:Library1.myMacro.js?language=JavaScript&location=share:uno_packages/myUnoPkg.oxt

Content on this page is licensed under the Public Documentation License (PDL).