Difference between revisions of "Documentation/OOo3 User Guides/Calc Guide/Write your own functions"

Revision as of 17:49, 16 January 2011

Calc can call macros as Calc functions. Use the following steps to create a simple macro:

1. Create a new Calc document named CalcTestMacros.ods.
2. Use Tools > Macros > Organize Macros > OpenOffice.org Basic to open the OpenOffice.org Basic Macros dialog. The Macro from box lists available macro library containers including currently open OOo documents. My Macros contains macros that you write or add to OOo. OpenOffice.org Macros contains macros included with OOo and should not be changed.
File:CG3Ch12F7.png
OpenOffice.org Basic Macros dialog.
3. Click Organizer to open the OpenOffice.org Basic Macro Organizer dialog. On the Libraries tab, select the document to contain the macro.
File:CG3Ch12F8.png
OpenOffice.org Basic Macro Organizer.
4. Click New to open the New Library dialog.
File:CG3Ch12F9.png
New Library dialog.
5. Enter a descriptive library name (such as AuthorsCalcMacros) and click OK to create the library. The new library name is shown the library list, but the dialog may show only a portion of the name.
File:CG3Ch12F10.png
The library is shown in the organizer.
6. Select AuthorsCalcMacros and click Edit to edit the library. OOo automatically creates a module named Module1 and a macro named Main.
File:CG3Ch12F11.png
Basic Integrated Development Environment (IDE).
7. Modify the code so that it is the same as that shown in Listing 2. The important addition is the creation of the NumberFive function, which returns the number five. The Option Explicit statement forces all variables to be declared before they are used. If Option Explicit is omitted, variables are automatically defined at first use as type Variant.
8. Save the modified Module 1.

Listing 2. Function that returns five.

 REM  *****  BASIC  *****
 Option Explicit

 Sub Main

 End Sub

 Function NumberFive()
   NumberFive = 5
 End Function