Scripting Framework

From Apache OpenOffice Wiki
< Documentation‎ | DevGuide
Revision as of 12:17, 24 May 2010 by BMarcelly (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search



PDF Icon.gif Download as a PDF or ODT


A OpenOffice.org macro is a short program used to automate a number of steps. The Scripting Framework is a new feature in OpenOffice.org. It allows users to write and run macros for OpenOffice.org in a number of programming and scripting languages including:

The framework is designed so that developers can add support for new languages.

Documentation note.png In this chapter, the terms macro and script are interchangeable.

Structure of this Chapter

This chapter is organized into the following sections:

  • Section Using the Scripting Framework describes the user interface features of the Scripting Framework
    • Describes how to run a macro using the Run Macro dialog.
    • Describes how to use the Organizer dialogs to create, edit and manage macros.
  • Section Writing Macros provides a guide on how to get started with writing Scripting Framework macros
    • Describes how to write a simple HelloWorld macro.
    • Describes how Scripting Framework macros interact with OpenOffice.org and the OpenOffice.org API.
    • Describes how to create a dialog from a Scripting Framework macro.
    • Describes how to compile and deploy a Java macro.
  • Section How the Scripting Framework Works describes how the plug-able architecture of the Scripting Framework allows support for new scripting languages to be added easily.
  • Section Writing a LanguageScriptProvider UNO Component using the Java Helper Classes describes how to use the Scripting Framework Java helper classes to add support for a new scripting language
    • Describes how to use the ScriptProvider abstract base class.
    • Describes how to add editor and management support.
    • Describes how to build and register a ScriptProvider.
  • Section Writing a LanguageScriptProvider UNO Component From Scratch describes how to write a LanguageScriptProvider UNO component.

Who Should Read this Chapter

If you are interested in automating OpenOffice.org using BeanShell, JavaScript, Java, Python or OpenOffice.org Basic then you should read sections Using the Scripting Framework and Writing Macros.

If you are interested in adding support to run and write macros in a language with a Java based interpreter then you should read section Writing a LanguageScriptProvider UNO Component using the Java Helper Classes.

If you are interested in adding support for a scripting language from scratch then you should read section Writing a LanguageScriptProvider UNO Component From Scratch.

Content on this page is licensed under the Public Documentation License (PDL).
Personal tools
In other languages