Getting Started Guide 24.8

Chapter 11,
Getting Started with Macros

Using the Macro Recorder … and Beyond

Introduction

A macro is a set of commands or keystrokes that are stored for later use. For example, a simple macro allows you to enter your address into an open document and a macro can automate both simple and complex tasks. Macros are very useful when you have to repeat the same task in the same way.

The simplest way to create a macro is to record a series of actions with LibreOffice’s user interface via the open source LibreOffice Basic scripting language (an implementation of the well-known BASIC programming language). These macros can be edited and enhanced after recording with the built-in LibreOffice Basic Integrated Development Environment (IDE).

The most powerful macros in LibreOffice can be created with one of the four supported scripting languages (LibreOffice Basic, Python, JavaScript, and BeanShell). This chapter provides an overview of LibreOffice’s macro facilities with an emphasis on its default macro scripting language, LibreOffice Basic. Though some introductory examples are included for the BeanShell, JavaScript, and Python scripting languages, an in-depth discussion on using these languages for scripting is beyond the scope of this chapter.

Your first macros

Adding a macro

To start with LibreOffice macros, we recommend that you find and use existing macros. We assumes that you have an existing macro that you want to use, which was originally found in a book or on the internet. In this example, the macro in Listing 1 is used. Once you have a macro, you create a library and module to contain your macro; the creation of a macro library is below, but see “Macro organization” below for more information.

Listing 1: Simple macro that says hello

Sub HelloMacro
 Print "Hello"
End Sub

Use the following steps to create a library that will contain your macro:

1. Open any LibreOffice application.

2. Go to Tools > Macros > Organize Macros > Basic to open the Basic Macros dialog (Figure 1).

1. Click Organizer to open the Basic Macro Organizer dialog (Figure 2) and select the Libraries tab.

1. Set the Location drop-down to My Macros & Dialogs, which is the default location.

2. Click New to open the New Library dialog (not shown here).

3. Enter a library name, for example TestLibrary, and click OK.

4. On the Basic Macro Organizer dialog, select the Modules tab (Figure 3).

1. In the Module list, expand My Macros and select your library (in the example, TestLibrary). A module named Module1 already exists and can contain your macro. If you wish, you can click New to create another module in the library.

2. Select Module1, or the new module that you created, and click Edit to open the Integrated Development Environment (IDE) (Figure 4). The IDE is a text editor and associated facilities that are built into LibreOffice and allow you to create, edit, run, and debug macros.

3. When a new module is created, it contains a comment and an empty macro named Main, which does nothing.

4. If you are ready, add the new macro either before Sub Main or after End Sub. Listing 2 shows the new macro added before Sub Main.

Listing 2: Module1 after adding the new macro

REM  *****  BASIC  *****

Sub HelloMacro
 Print "Hello"
End Sub

Sub Main

End Sub

• Tip

If you prefer, you can remove the Sub Main … End Sub code from the Module and leave only the HelloMacro subroutine.

1. (Optional) To check if the macro is written as expected by the LibreOffice Basic programming language, click the Compile icon on the Macro toolbar.

2. Double-click the HelloMacro subroutine in the Object Catalog window under TestLibrary > Module 1 and click the Run icon on the Macro toolbar, or press the F5 key, to run the HelloMacro subroutine in the module. A small dialog will open with the word “Hello” displayed (see below).

1. Click OK to close this small dialog.

2. If no subroutine or function is selected, a dialog like the one in Figure 6 will open. Then select the macro and click Run to execute it.

3. To select and run any macro in the module, click the Select Macro icon on the Standard toolbar or go to Tools > Macros > Organize Macros > Basic.

4. Select a macro and then click Run.

Recording a macro

When you record a macro in LibreOffice, you are actually  using programming language to record the steps needed to perform a certain task. For example, if you have to repeatedly enter the same information into a document, you can create a macro that automatically enters this piece of information without having to copy it every time you need it.

• Note

Sometimes, it might be better to create an AutoText that can repeatedly enter information into a document. See Chapter 2, Working with Text: Basics, in the Writer Guide for more information.

First enable macro recording in LibreOffice by going to Tools > Options > LibreOffice > Advanced and selecting the option Enable macro recording under Optional Features. By default, this feature is turned off in LibreOffice.

1. Go to Tools > Macros > Record Macro to start recording a macro. A small dialog with a Stop Recording button is displayed indicating that LibreOffice is recording a macro.

2. Type the desired text you want to be entered when this macro is run. As an example, type your name.

3. Click Stop Recording on the small dialog. This will cause Basic Macros dialog to open (similar to Figure 1 above, but with different action buttons).

4. Open the library container My Macros.

5. Find the library named Standard in My Macros. Note that every library container has a library named Standard.

6. Select the Standard library and then choose an existing module in which to save the macro. Alternatively you can click New Module to create a new module to contain the newly recorded macro.

7. In the Macro Name text box at the top left section of the dialog, type a name for the macro you have just recorded, for example EnterMyName.

8. Click Save to save the macro and close the Basic Macros dialog.

If you followed all of the above steps, a macro named EnterMyName will have been created inside the selected module.

• Note

Whenever you create a new module in LibreOffice, a subroutine named Main is automatically added to the module.

Running a macro

1. Go to Tools > Macros > Run Macro to open the Macro Selector dialog (Figure 7).

2. For example, select your newly created macro EnterMyName and click Run.

3. Alternatively, go to Tools > Macros > Organize Macros > Basic to open the Basic Macros dialog (Figure 1), select your macro and click Run.

Viewing and editing macros

To view and edit the macro that you created:

1. Go to Tools > Macros > Organize Macros > Basic to open the Basic Macros dialog.

2. Select your new macro EnterMyName and click Edit. The Basic IDE will open and the macro EnterMyName will be shown as in Listing 3.

This first macro is not complicated (see Listing 3):

Listing 3: Code recorded for the EnterMyname macro

sub EnterMyName
rem -------------------------------------------------------------
rem define variables
dim document   as object
dim dispatcher as object
rem -------------------------------------------------------------
rem get access to the document
document   = ThisComponent.CurrentController.Frame
dispatcher = createUnoService("com.sun.star.frame.DispatchHelper")
rem -------------------------------------------------------------
dim args1(0) as new com.sun.star.beans.PropertyValue
args1(0).Name = "Text"
args1(0).Value = "Your name"
dispatcher.executeDispatch(document, ".uno:InsertText", "", 0, args1())
end sub

Commenting with REM

All comments in Basic macro coding begin with REM, which stands for remark. All text on a line that begins with REM is ignored by the Basic interpreter when the macro is run.

• Tip

As a shortcut, you can use the single quote character (') to start a comment.

LibreOffice Basic is not case-sensitive for keywords, so REM, Rem, and rem can all start a comment. If you use symbolic constants defined by the Application Programming Interface (API), it is safer to assume that the names are case-sensitive. It is worth noting that symbolic constants are an advanced topic that is not covered by this user guide and they are not required when using the macro recorder in LibreOffice.

Defining subroutines with SUB

Individual macros are stored in subroutines and these subroutines begin with the keyword SUB. The end of a subroutine is indicated by the words END SUB. The code starts by defining the subroutine named Main, which is empty and does nothing. Note that the code in Listing 3 for the EnterMyName macro starts with the keyword SUB and ends with END SUB.

There are advanced topics that are beyond the scope of this user guide, but knowing about them might be of interest:

• You can write subroutines that accept input values to be used inside the macro. These values are called arguments. This can only be done when you create subroutines from scratch. Recorded macros in LibreOffice do not accept arguments.

• Another kind of subroutine is called a function, which is a subroutine that can return a value as a result of its work. Functions are defined by the keyword FUNCTION at the beginning. Recorded macros in LibreOffice create subroutines only.

Defining variables using DIM

When you are defining a variable (which contains data), you should use the DIM keyword, which was originally stood for Dimension and was used to define the dimensions of an array. The DIM statement used in the EnterMyName macro is similar to setting aside a piece of paper to be used to store a message or note.

In the EnterMyName macro, the variables document and dispatcher are defined as the type object. Other common variable types include string, integer, and date. A third variable, named args1, is an array of property values. A variable of type array allows a single variable to contain multiple values, similar to storing multiple pages in a single book. Values in an array usually begin at zero. The number in the parentheses indicates the highest usable number to access a storage location. In this example, there is only one value, and it is numbered zero.

Explaining macro code

The following is an explanation of the code used in the EnterMyName macro.

sub EnterMyName

Defines the start of the EnterMyName macro.

dim document as object

Defines document as an object variable. Objects are a specific variable type with multiple fields (sometimes they are called properties) and actions (also they are called methods). The fields can be perceived like variables (including an object) and actions like subroutines which allow us to operate with the object.

• Note

Sometimes the word service is used. A service is supplied by an object when a macro commands it via an object’s method.
dim dispatcher as object

Defines dispatcher as an object variable.

document = ThisComponent.CurrentController.Frame

ThisComponent is a runtime object created by LibreOffice that refers to the current document.

CurrentController is a property referring to a service that controls the document. For example, when you type, it is the current controller that takes note of what you type. CurrentController then dispatches the changes to the document frame.

Frame is a controller property that returns the main frame for a document. Therefore, the variable named document refers to a document’s frame, which receives dispatched commands.

dispatcher = createUnoService("com.sun.star.frame.DispatchHelper")

Most tasks in LibreOffice are accomplished by dispatching a command. LibreOffice includes a DispatchHelper service, which provides an easy way to dispatch a URL using one call instead of multiple ones and does most of the work when using dispatches in macros. The method CreateUnoService accepts the name of a service and it tries to create an instance of that service. On completion, the dispatcher variable contains a reference to a DispatchHelper.

dim args1(0) as new com.sun.star.beans.PropertyValue

Declares the args1 array of properties. Each property has a name and a value. In other words, it is a name/value pair. The created array has one property at index zero.

The com.sun.star.beans.PropertyValue expression is a Universal Network Objects (UNO) structure. Structures are special variable types that contain other variables united by logical basis. They can be convenient to operate with sets of heterogeneous information that should be treated as a single whole.

• NOTE

An explanation of UNO and user structures goes far beyond the scope of this book. For more information on creating and using structures, see the LibreOffice Help system and other Basic guides.
args1(0).Name = "Text"
args1(0).Value = "Your name"

Gives the property the name “Text” and the value “Your name”, which is the text that is inserted when the macro is run.

dispatcher.executeDispatch(document, ".uno:InsertText", "", 0, args1())

The dispatch helper sends a dispatch to the document frame (stored in the variable document) with the command .uno:InsertText. The next two arguments, frame name and search flags, are beyond the scope of this book. The last argument is the array of property values to be used while executing the command InsertText.

In other words, this line of code executes the UNO command .uno:InsertText passing the value “Your Name” as the “Text” parameter.

end sub

The last line of the code ends the subroutine.

Creating a macro

When creating a macro, it is important to ask two questions before recording:

1. Can the task be written as a simple set of commands?

2. Can the steps be arranged so that the macro’s final command leaves the cursor ready for the next command? Or does it allow the user to return to entering text or data into the target document?

A more complex example of a macro

One common macro task is to copy rows and columns of data from a website and format them as a table in a text document. Typically this macro works as follows:

1. Copy the data from the website to the clipboard.

2. To avoid strange formatting and fonts, paste the text into a Writer document as unformatted text.

3. Reformat the text with tabs between columns so that it can be converted into a table using Table > Convert > Text to Table.

With the two questions above in mind, inspect the text to see you can record a macro that formats the text. As an example of copied data, consider the text copied from the API website describing the FontWeight constants (Figure 8). The first column in this example indicates a constant name and each name is followed by a space and a tab, and each line has two trailing spaces.

In this example we will want the first column in the table to contain the numeric value of the font weight, the second column will contain the constant name, and the third column will hold the text description. This task can be accomplished easily for every row except for DONTKNOW and NORMAL, which do not contain a numeric value.

Below are the steps to record this macro using keystrokes and assuming that the cursor is at the beginning of the line with the text “THIN”.

1. Make sure macro recording is enabled by going to Tools > Options > LibreOffice > Advanced and selecting the option Enable macro recording. By default, this feature is turned off when LibreOffice is installed on your computer.

2. Go to Tools > Macros > Record Macro to start recording.

3. Press Ctrl+Right Arrow to move the cursor to the start of the word “specifies”.

4. Press Backspace twice to remove the tab and the space.

5. Press Tab to add the tab without the space after the constant name.

6. Press Delete to delete the lower case “s” and then press Shift+S to add an upper case “S”.

7. Press Ctrl+Right Arrow twice to move the cursor to the start of the number.

8. Press Ctrl+Shift+Right Arrow to select and move the cursor before the % sign.

9. Press Ctrl+C to copy the selected text to the clipboard.

10. Press End to move the cursor to the end of the line.

11. Press Backspace twice to remove the two trailing spaces.

12. Press Home to move the cursor to the start of the line.

13. Press Ctrl+V to paste the selected number to the start of the line.

14. Pasting the value also pasted an extra space, so press Backspace to remove the extra space.

15. Press Tab to insert a tab between the number and the name.

16. Press Home to move to the start of the line.

17. Press Down Arrow to move to the next line.

18. Stop recording the macro and save the macro, see “Recording a macro” above.

It takes much longer to read and write these steps than to actually record the macro. Work slowly and think about the steps as you do them. With practice you will learn how to organize the steps into macros that can be used to automate repetitive tasks.

The generated macro code in Listing 4 has been modified to contain the step numbers in the comments to match the steps discussed above.

Listing 4: Copying numeric value to start of the column

sub CopyNumToCol1
rem -------------------------------------------------------------
rem define variables
dim document   as object
dim dispatcher as object
rem -------------------------------------------------------------
rem get access to the document
document   = ThisComponent.CurrentController.Frame
dispatcher = createUnoService("com.sun.star.frame.DispatchHelper")

rem (3) Press Ctrl+Right Arrow to move the cursor to the start of “specifies”.
dispatcher.executeDispatch(document, ".uno:GoToNextWord", "", 0, Array())

rem (4) Press Backspace twice to remove the tab and the space.
dispatcher.executeDispatch(document, ".uno:SwBackspace", "", 0, Array())

rem -------------------------------------------------------------
dispatcher.executeDispatch(document, ".uno:SwBackspace", "", 0, Array())

rem (5) Press Tab to add the tab without the space after the constant name.
dim args4(0) as new com.sun.star.beans.PropertyValue
args4(0).Name = "Text"
args4(0).Value = CHR$(9)

dispatcher.executeDispatch(document, ".uno:InsertText", "", 0, args4())

rem (6) Press Delete to delete the lower case s ....
dispatcher.executeDispatch(document, ".uno:Delete", "", 0, Array())

rem (6) ... and then press Shift+S to add an upper case S.
dim args6(0) as new com.sun.star.beans.PropertyValue
args6(0).Name = "Text"
args6(0).Value = "S"

dispatcher.executeDispatch(document, ".uno:InsertText", "", 0, args6())

rem (7) Press Ctrl+Right Arrow twice to move the cursor to the number.
dispatcher.executeDispatch(document, ".uno:GoToNextWord", "", 0, Array())

rem -------------------------------------------------------------
dispatcher.executeDispatch(document, ".uno:GoToNextWord", "", 0, Array())

rem (8) Press Ctrl+Shift+Right Arrow to select the number.
dispatcher.executeDispatch(document, ".uno:WordRightSel", "", 0, Array())

rem (9) Press Ctrl+C to copy the selected text to the clipboard.
dispatcher.executeDispatch(document, ".uno:Copy", "", 0, Array())

rem (10) Press End to move the cursor to the end of the line.
dispatcher.executeDispatch(document, ".uno:GoToEndOfLine", "", 0, Array())

rem (11) Press Backspace twice to remove the two trailing spaces.
dispatcher.executeDispatch(document, ".uno:SwBackspace", "", 0, Array())

rem -------------------------------------------------------------
dispatcher.executeDispatch(document, ".uno:SwBackspace", "", 0, Array())

rem (12) Press Home to move the cursor to the start of the line.
dispatcher.executeDispatch(document, ".uno:GoToStartOfLine", "", 0, Array())

rem (13) Press Ctrl+V to paste the selected number to the start of the line.
dispatcher.executeDispatch(document, ".uno:Paste", "", 0, Array())

rem (14) Press Backspace to remove the extra space.
dispatcher.executeDispatch(document, ".uno:SwBackspace", "", 0, Array())

rem (15) Press Tab to insert a tab between the number and the name.
dim args17(0) as new com.sun.star.beans.PropertyValue
args17(0).Name = "Text"
args17(0).Value = CHR$(9)

dispatcher.executeDispatch(document, ".uno:InsertText", "", 0, args17())
rem (16) Press Home to move to the start of the line.
dispatcher.executeDispatch(document, ".uno:GoToStartOfLine", "", 0, Array())

rem (17) Press Down Arrow to move to the next line.
dim args19(1) as new com.sun.star.beans.PropertyValue
args19(0).Name = "Count"
args19(0).Value = 1
args19(1).Name = "Select"
args19(1).Value = false

dispatcher.executeDispatch(document, ".uno:GoDown", "", 0, args19())
end sub

To run this macro, place the cursor at the beginning of the line to which you want to apply the recorded steps. Then go to Tools > Macros > Run Macro, select the CopyNumToCol1 macro and click Run. Figure 9 shows the original line and the resulting line after applying the macro.

Keep in mind that the steps described above will only work properly if the first line follows the format we assumed while creating the macro. If you run this macro on the “DONTKNOW” and “NORMAL” lines the results will not be as expected because these two lines have different formats. Figure 10 shows the original line starting with “DONTKNOW”.

Running a macro quickly

Since it is not convenient to repeatedly run macros using Tools > Macros > Run Macro, you can assign a keyboard shortcut to quickly trigger it. To assign the shortcut Ctrl+K to the CopyNumToCol1 macro, do the following:

1. Go to Tools > Customize. This will open the Customize dialog.

2. Select the Keyboard tab. In the Shortcut Keys section, select the Ctrl+K shortcut.

3. In the Category section, select LibreOffice macros. Navigate this section and select the CopyNumToCol1 macro.

4. Now click the Assign button to assign the Ctrl+K shortcut to the CopyNumToCol1 macro.

5. Click OK to close the Customize dialog.

Now you can run the CopyNumToCol1 macro using the Ctrl+K shortcut. This is very fast and easy to configure after you get used to the macro workflow. Figure 11 illustrates the steps involved.

Limitations of the macro recorder

Unfortunately, the Macro Recorder cannot record some actions, and its limitations are related to LibreOffice’s dispatch framework and its relationship to the macro recorder.

Understanding the dispatch framework

The purpose of the dispatch framework is to provide uniform access to components (documents) for commands that generally correspond to menu items. It translates File > Save, the shortcut keys Ctrl+S, or clicking the Save icon on the Standard toolbar into the same “dispatch command.”

Also, the dispatch framework can send “commands” back to the user interface (UI). For example, after saving a new document, the framework makes sure that the list of recent files is updated.

A dispatch command is text, for example .uno:InsertObject or .uno:GoToStartOfLine. The command is sent to the document frame and the frame the command around the API until an object is found that can handle the command.

How the macro recorder uses the dispatch framework

The macro recorder can only register commands generated by the dispatch framework, but not all dispatched commands are complete. For example, inserting an object generates the following code:

dispatcher.executeDispatch(document, ".uno:InsertObject", "", 0, Array())

It is not possible to specify what kind of object to create or insert. If an object is inserted from a file, you cannot specify which file to insert.

If while recording a macro you use Tools > Options to open and modify configuration items, the generated macro does not record any configuration changes. In fact, the generated code is commented so it will not even be run.

rem dispatcher.executeDispatch(document, ".uno:OptionsTreeDialog", "", 0, Array())

Though a command is generated when you open a dialog, any work done inside the dialog is not usually recorded. This occurs in places like macro organization dialogs, when you are inserting special characters, and similar types of dialogs. Other possible problems using the macro recorder can occure when you insert a formula, set user data, create filters in Calc, do actions in database forms, and export a document to an encrypted PDF file. You never know for certain what the macro recorder can capture until you try it. For example, the actions from the search dialog are properly captured.

Other options

When the macro recorder is not able to solve a specific problem, normally the next steo is to write actual code using the LibreOffice objects. Unfortunately, there is a steep learning curve for these LibreOffice objects. It is usually best to start with simple examples and then increase the scope of macros as you learn more. Learning to read generated macros is a good place to start.

Macro organization

In LibreOffice, macros are grouped in modules, modules are grouped in libraries, and libraries are grouped in library containers. A library is usually used as a major grouping for either an entire category of macros, or for an entire application. Modules usually split functionality, such as user interaction and calculations. Individual macros are subroutines and functions. Figure 12 shows an example of the hierarchical structure of macro libraries in LibreOffice.

Go to Tools > Macros > Organize Macros > Basic to open the Basic Macros dialog (Figure 1 above). All available library containers are shown in the Macro From list and every document is a library container, capable of containing multiple libraries. The application itself acts as two library containers, one container for macros distributed with LibreOffice called LibreOffice Macros, and one container for personal macros called My Macros.

The LibreOffice Macros are stored with the application runtime code, which may not be editable to you unless you have administrator rights in LO. This helps protect these macros because they should not be changed and you should not store your own macros in the LibreOffice Macros container.

Unless your macros are only applicable to a single document, your macros will probably be stored in the My Macros container. The My Macros container is stored in your user area or home directory.

If a macro is contained in a document, then a recorded macro will attempt to work on that document, because it primarily uses ThisComponent for its actions.

Every library container contains a library named Standard. We strongly recommend that you  create your own libraries with meaningful names instead of using the Standard library. Libraries with meaningful names are easier to manage and unlike Standard, your own libraries can be imported into other library containers.

• Caution

While LibreOffice allows you to import libraries into a library container, it will not allow you to overwrite the library named Standard. Therefore, if you store your macros in the Standard library, you cannot import them into another library container.

Just as it makes good sense to give your libraries meaningful names, you should use meaningful names for your modules. By default, LibreOffice uses names such as Module1, Module2, and so on.

As you create your macros, you must decide where to store them. Macros stored in the application library container named My Macros are globally available to all documents and storing a macro in a document is useful if the document will be shared and you want the macro to be included with the document.

While the Standard and Template libraries are automatically loaded, other library macros are not available until the library that contains them is loaded.  A loaded library is displayed differently from a library that is not loaded. To load the library and the modules it contains, double-click on the library.

Where are macros stored?

LibreOffice stores user-specific data in a folder inside the user’s home directory. The location is operating system specific. To find out where configuration data is stored, go to Tools > Options > LibreOffice > Paths. User macros written in Basic are stored in LibreOffice\4\user\basic. Each library is stored in its own directory inside the basic directory.

For casual use, it is not necessary to understand where macros are stored. If you know where they are stored, however, you can create a backup, share your macros, or inspect them if there is an error.

Exporting macros

If you want to export macro libraries so that they can be reused and shared with other people, use the  LibreOffice Basic Macro Organizer. To export a macro library:

1. Go to Tools > Macros > Organize Macros > Basic and the click the Organizer button.

2. Click the Libraries tab and choose which library you want to export.

3. Click Export and then select Export as BASIC Library (note that you cannot export the Standard library).

4. Choose where you want to save the library and click Save.

When a library is exported, LibreOffice creates a folder containing all files related to the library. Figure 13 shows an example of how a library named TestLibrary with a single module called Module1 would be exported.

Importing macros

The LibreOffice Basic Macro Organizer dialog allows you to import macro libraries into your document as well as creating, deleting, and renaming libraries, modules, and dialogs.

1. On the Libraries tab, select the library container to use and then click Import to import macro libraries.

2. Navigate to the directory containing the library to import (Figure 14). Normally you can choose between dialog.xlb and script.xlb. It does not matter which of these two files you select; both will allow your macro to be imported. Macros can be stored in libraries inside LibreOffice documents. To import libraries contained in a document, select a document rather than a directory on disk.

1. Select a file and click Open to continue and open the Import Libraries dialog (Figure 15).

1. Select the following options for importing libraries:

• If no options are selected, the library is copied to your user macro directory. However, if the library you are importing has the same name and you are importing into the same location, it will not be copied.

• Select Insert as reference (read-only) if you want to use the library as reference, but not import that library into the document. When a library is used as a reference, it remains in its current location and is fully functional, but cannot be modified in the Basic IDE.

• Select Replace existing libraries if the library you want to import has the same name and you want to replace the existing library.

1. Click OK to import the macro library you selected.

• Note

You cannot export/import the library named Standard.

• Tip

On Linux, LibreOffice-specific files are stored in the user’s home directory inside the .config folder. Directories and files with names beginning with a dot may be hidden and not shown in a normal file selection dialog. When using LibreOffice dialogs, rather than the operating system’s specific dialogs, type the name of the desired directory in the Name field.

Downloading macros to import

You can find macros created by the LibreOffice community in the internet. Some macros are contained in documents, some as regular files that you need to import, and others are published as text and must be copied and pasted into the Basic IDE. See “Adding a macro” above on how to add macros to your macro library and “Viewing and editing macros” above on how to edit macros using the Basic IDE.

Some macros are available as free downloads on the Internet (see Table 1).

Table 1. Places to find macro examples

Location	Description
https://www.pitonyak.org/oo.php	Reference materials regarding macros.
https://www.pitonyak.org/database/	Reference materials regarding database macros.
https://wiki.documentfoundation.org/Macros	Lots of links to macros.
https://forum.openoffice.org/en/forum/	Forums, with many examples and help.

How to run a macro

You can run a macro with Tools > Macros > Run, but this will not be efficient when you use macros frequently. Fortunately LibreOffice has many other ways to run your macros.

While you can assign a shortcut to macros, as seen in “Running a macro” above, you can also link macros to a toolbar icon, menu item, event, or a button embedded in a document. When choosing a method, it is also good to ask questions such as:

• Should the macro be available for only one document or globally for all documents?

• Is the macro for a specific document type, such as a Calc document?

• How frequently will the macro be used?

The answers will determine where to store the macro and how to make it available. For example, you will probably not add a rarely used macro to a toolbar. To help determine your choices, see Table 2.

Table 2. Where to store a macro

Where to place the macro	For all LibreOffice applications	For a specific LO application	For a single document
Toolbar	No	Yes	Yes
Menu	No	Yes	Yes
Shortcut	Yes	Yes	No
Event	Yes	No	Yes

Toolbars, menu items, and keyboard shortcuts

To add a menu item, keyboard shortcut, or toolbar icon that calls a macro, use the Customize dialog, which allows you to configure menus, keyboard shortcuts, toolbars, and events. To open this dialog, go to Tools > Customize. Use of the Menus, Toolbars, Context Menus, and Keyboard tabs are covered in Chapter 13, Customizing LibreOffice.

Events

Whenever LibreOffice detects a user action, we call it an event. For example, opening a document, changing status of modified, or moving the mouse cursor are all events. LibreOffice allows events to trigger the execution of a macro; the macro is then called an event handler. Full coverage of event handlers is well beyond the scope of this chapter, but a little knowledge can accomplish much.

• Caution

Be careful when you configure an event handler. For example, if you write an event handler that is called every time that a document is modified but make a mistake so the event is not properly handled, problems can occur. One possible result is that your event handler will force you to kill LibreOffice.

1. Go to Tools > Customize to open the Customize dialog and select the Events tab (Figure 16). The events in the Customize dialog are related to the entire application and specific documents.

2. In the Save In drop-down, select LibreOffice, or a specific document from the menu to save your event.

3. A common use is to assign the Open Document event to call a specific macro. The macro then performs certain setup tasks for the document. Select the desired event and click Macro to open the Macro Selector dialog (similar to Figure 7 above but with different action buttons).

4. Select the desired macro and click OK to assign the macro to the event. The Events tab will show that the event has been assigned to a macro.

Many objects in a document can be set to call macros when events occur. The most common use is to add a control, such as a button, into a document. Even double-clicking on a graphic opens a dialog with a Macros tab that allows you to assign a macro to an event.

Using extensions

An extension is code that can be installed into LibreOffice to add new functionality. Extensions can be written in almost any programming language and may be simple or sophisticated. Extensions can be grouped into types, for example:

• Calc add-ins, which provide new functionality for Calc, including new functions that act like normal built-in functions.

• New components and functionality, which normally include some level of User Interface (UI) integration such as new menus or toolbars.

• Chart add-ins with new chart types.

• Linguistic components such as spelling checkers.

• Document templates and images.

Although individual extensions can be found in several places, there is currently an extension repository at: https://extensions.libreoffice.org/ and some documentation at https://libreplanet.org/wiki/Group:OpenOfficeExtensions/List.

For more about obtaining and installing extensions, see Chapter 13, Customizing LibreOffice.

Writing macros without the recorder

The examples covered so far in this chapter were created using the macro recorder and the dispatcher, but you can also write macros in code which directly access the objects that comprise LibreOffice. In other words, you can create a macro that directly manipulates a document using more advanced programming logic.

Directly manipulating LibreOffice internal objects is an advanced topic that is beyond the scope of this chapter. A simple example, however, demonstrates how this works.

An example of a macro in code for Writer

The sample code in Listing 5 is a simple example of a macro created without the recorder that adds the string “Hello” at the end of a Writer document.

To add this macro to a library, follow the steps below:

1. Go to Tools > Macros > Organize Macros > Basic.

2. In My Macros, navigate to the library where you want the macro to be created. In this example, consider the library TestLibrary.

3. Select one of the modules already available in the library, for example Module1. If you want to create a new module, click Organizer and then add the new module.

4. With the module selected, click Edit. This will open the Basic IDE window and show the code for the macros implemented in the selected module.

5. Enter the code in Listing 5 into the module.

Listing 5: Append the text “Hello” at the end of to the current document

Sub AppendHello
 Dim oDoc
 Dim sTextService$
 Dim oCurs
 
 REM ThisComponent refers to the currently active document.
 oDoc = ThisComponent

 REM Verify that this is a text document.
 sTextService = "com.sun.star.text.TextDocument"
 If NOT oDoc.supportsService(sTextService) Then
   MsgBox "This macro only works with a text document"
   Exit Sub
 End If
 REM Get the view cursor from the current controller.
 oCurs = oDoc.currentController.getViewCursor()
 
 REM Move the cursor to the end of the document.
 oCurs.gotoEnd(False)
 
 REM Insert text "Hello" at the end of the document.
 oCurs.Text.insertString(oCurs, "Hello", False)  
End Sub

An example of a macro in code for Calc

One powerful way to extend the functionalities of LibreOffice Calc is to write macros that automate repetitive tasks. You can use the Basic language to write macros that can do tasks ranging from simple cell handling and formatting to advanced data manipulation.

For example, Listing 6 below shows the Basic code for a macro that analyzes a range of cells to determine if all values are between 0 and 100. Values ranging from 50 to 100 should be marked in light green whereas cells with values that are greater than or equal to 0 and less then 50 should be marked in light red. If any values outside the allowed range of 0 to 100 are found, a warning message should be displayed and cells should be marked in light gray.

Listing 6: Calc macro to format ranges based on values

Sub FormatRangeBasedOnValue
 'Gets the current selection
 Dim oRange as Object, oCell as Object
 Set oRange = Thiscomponent.getCurrentSelection()
 'Checks if the selected range is a single range
 If Not oRange.supportsService("com.sun.star.sheet.SheetCellRange") Then
   MsgBox "This macro applies only to single ranges."
   Exit Sub
 End If
 ' Number of columns and rows in selection
 Dim nCols as Long : nCols = oRange.Columns.getCount()
 Dim nRows as Long : nRows = oRange.Rows.getCount()
 Dim col as Long, row as Long
 Dim cellValue as Long
 Dim isError as Boolean : isError = False
 ' Iterate over all cells in the range
 For col = 0 To nCols - 1
   For row = 0 to nRows - 1
     Set oCell = oRange.getCellByPosition(col, row)
     cellValue = oCell.getValue()
     If cellValue >= 50 and cellValue <= 100 Then
       ' Sets background to light green
       oCell.CellBackcolor = RGB(144, 238, 144)
     ElseIf cellValue >= 0 and cellValue < 50 Then
       ' Sets background to light red
       oCell.CellBackcolor = RGB(255, 127, 127)
     Else
       ' Sets background to light gray
       oCell.CellBackcolor = RGB(220, 220, 220)
       isError = True
     End If
   Next row
 Next col
 ' Displays a message indicating that there were errors
 If isError Then
   MsgBox "Some cells outside the range 0 to 100 were marked in light grey"
 End If
End Sub

To add this macro to a library, follow the steps described in “An example of a macro in code for Writer” above. To run this macro, first create a new Calc sheet and add some numeric values in a range of cells. Then, select the cells and use one of the methods described in “How to run a macro” above to execute it. Figure 17 shows an example of the macro being run on a set of cells. Because some of the cells have values that are not between 0 and 100, the message box in Figure 18 will also be displayed.

The ScriptForge library

Since macro programmers frequently need to perform tasks such as creating and opening files, accessing form controls, reading data from databases embedded in Base documents, and so forth, LibreOffice has provided them with the ScriptForge library. This library makes it easier to execute such commands without having to learn the required LibreOffice APIs (Application Programming Interfaces) and commands, which may be difficult for casual programmers.

ScriptForge is organized into a set of services, each of which provides methods and properties related to a specific topic. For example, the Dialog service provides access to dialogs available in script modules and the Database service allows to execute SQL commands in Base documents. The example in Listing 7 shows a macro written in Basic using the ScriptForge library that opens a Calc document, creates a new sheet named NewSheet, and inserts the string “Hello” into cell A1. The macro also saves and closes the document.

Listing 7: Macro using the ScriptForge library

Sub CreateSheetExample
 ' Loads the ScriptForge library
 GlobalScope.BasicLibraries.LoadLibrary("ScriptForge")
 ' Instantiates the UI service
 Dim ui as Object, myDoc as Object
 ui = CreateScriptService("UI")
 ' Opens the file "myfile.ods"
 Set myDoc = ui.OpenDocument("/home/user/Documents/myfile.ods")
 ' Inserts a new sheet named "NewSheet"
 myDoc.InsertSheet("NewSheet")
 ' Inserts the string "Hello" into cell "A1" of the new sheet
 myDoc.SetValue("NewSheet.A1", "Hello")
 ' Shows the sheet "NewSheet"
 myDoc.Activate("NewSheet")
 ' Saves the document
 myDoc.Save()
 ' Closes the document
 myDoc.CloseDocument()
End Sub

As seen in the example, the ScriptForge library provides straightforward commands to execute commands, and simplify the creation of macros.

• Tip

To learn more about the ScriptForge library, visit LibreOffice’s online Help at https://help.libreoffice.org/7.4/en-US/text/sbasic/shared/03/lib_ScriptForge.html?DbPAR=BASIC. Each of the 26 supported services have been extensively documented and examples are provided for both Basic and Python programming languages.

UNO Object Inspector

LibreOffice has an extensive API that can be used by macro programmers to automate almost any aspect of its applications. However, programmers often have problems discovering object types as well as their supported services, methods, and properties.

The component model used in LibreOffice is known as Universal Network Objects or UNO. LibreOffice macros in any scripting language use a UNO runtime application programming interface (API). The XSCRIPTCONTEXT interface is provided to macro scripts in all four available languages (LibreOffice Basic, Python, JavaScript, and BeanShell) which provides some means of access to the various interfaces which they might need to perform an action on a document.

The UNO Object Inspector can help macro developers inspect objects, learn how to access them, and use them in macros. This feature is available in Writer, Calc, Impress, and Draw. To enable it, go to Tools > Development Tools. The Object Inspector will be opened at the bottom of the user interface, as shown in Figure 19.

The left portion of the Object Inspector consists of the Document Object Model (DOM) navigator, which allows the user to navigate through all the objects in the document. When an object is selected, information about the object are shown in the right portion of the Object Inspector window:

• The names of all implemented interfaces.

• The names of all services supported by the object.

• The names and types of all properties available in the object.

• The names, arguments and return types of all methods that can be called by the object.

Instead of inspecting objects using the DOM navigator, it is possible to directly inspect the currently selected object in the document by toggling the Current Selection button.

For example, suppose you want to change the background color of the text selected in a Writer document. You can select a portion of text, open the Object Inspector, toggle the Current Selection button, then inspect the object properties in search of a property that matches the desired effect. Figure 20 shows the CharBackColor property selected, which is the property used to set text background color.

Now it is possible to write a macro using this property to change the background color of the selected text. Listing 8 shows the code for this macro.

Listing 8: Macro that changes the background color of a text range

Sub ChangeTextBGColor
 Dim oSel as Object
 Set oSel = ThisComponent.getCurrentSelection()
 oSel(0).CharBackColor = RGB(255, 127, 127)
End Sub

Note that in Writer it is possible to have multiple ranges selected at once, hence oSel(0) accesses the first range of text.

Overview of Python, BeanShell, and JavaScript macros

Many programmers may not be familiar with LibreOffice Basic, so LibreOffice supports macros written in three other familiar languages: Python, BeanShell, and JavaScript.

Macros are organized in the same way for all four scripting languages. The LibreOffice Macros container holds all the macros that are supplied in the LibreOffice installation. The My Macros library container holds those macros that you made available to any of your LibreOffice documents. Each document can also contain your macros that are not available to any other document.

When you use the recording facility, the macros are created in LibreOffice Basic. To use the other available scripting languages, you must write the code yourself.

When you select to run a macro using Tools > Macros > Run Macro, LibreOffice displays the Macro Selector dialog. This dialog enables selection and running of any available macro, coded in any of the available languages (Figure 21).

When you edit a macro using Tools > Macros > Edit Macros, LibreOffice displays the LibreOffice Basic IDE. This dialog enables selection and editing of any available LibreOffice Basic macro, but not macros in other languages.

• Tip

If you want to learn more about the LibreOffice API as well as UNO objects, refer to the official API documentation at https://api.libreoffice.org/

Python macros

Python is a high-level, general-purpose programming language that was first released in 1991.

When you select Tools > Macros > Organize Macros > Python, LibreOffice displays the Python Macros dialog (Figure 22). Facilities to edit and debug Python scripts are not currently integrated into the standard LibreOffice user interface. However, you can use any Python editor to create scripts and then copy these files into the Scripts folder in your home directory. For more information, refer to “Where are macros stored?” above.

Listing 9 presents an example of a Python macro that writes the text “Hello World from Python” into cell A1 of the first sheet in a Calc spreadsheet.

Listing 9: Sample Python macro

import uno

def HelloWorld():
   doc = XSCRIPTCONTEXT.getDocument()
   cell = doc.Sheets[0]['A1']
   cell.setString('Hello World from Python')
   return

• Tip

The Alternative Python Script Organizer (APSO) extension makes it easier to edit and organize Python scripts, especially when they are embedded in a document. Using APSO you can configure your preferred source code editor, start the integrated Python shell and debug Python scripts. Visit https://gitlab.com/jmzambon/apso to download APSO and learn more about how to use it.

• Tip

To learn more about Python scripting in LibreOffice, you can refer to the Wiki “Macros/Python Basics”, where you will find in-depth explanations and examples on how to get started with Python scripting. To learn more, visit https://wiki.documentfoundation.org/Macros/Python_Basics.

BeanShell macros

BeanShell is a Java-like scripting language that was first released in 1999.

When you select Tools > Macros > Organize Macros > BeanShell, LibreOffice displays the BeanShell Macros dialog (Figure 23).

Click the Edit button on the BeanShell Macros dialog to access the BeanShell Debug Window (Figure 24).

Listing 10 is an example of a BeanShell macro that inserts the text “Hello World from BeanShell” in cell A1 of the active Calc spreadsheet.

Listing 10: Sample BeanShell macro

import com.sun.star.uno.UnoRuntime;
import com.sun.star.sheet.XspreadsheetView;
import com.sun.star.text.XText;
model = XSCRIPTCONTEXT.getDocument();

controller = model.getCurrentController();

view = UnoRuntime.queryInterface(XSpreadsheetView.class, controller);

sheet = view.getActiveSheet();

cell = sheet.getCellByPosition(0, 0);

cellText = UnoRuntime.queryInterface(XText.class, cell);

textCursor = cellText.createTextCursor();

cellText.insertString(textCursor, "Hello World from BeanShell", true);

return 0;

JavaScript macros

JavaScript is a high-level scripting language that was first released in 1995.

When you select Tools > Macros > Organize Macros > JavaScript, LibreOffice displays the JavaScript Macros dialog (Figure 25).

Listing 11 is an example of a JavaScript macro that inserts the text “Hello World from JavaScript” in cell A1 of the first sheet in a Calc spreadsheet.

Listing 11: Sample JavaScript macro

importClass(Packages.com.sun.star.uno.UnoRuntime);
importClass(Packages.com.sun.star.sheet.XspreadsheetDocument);
importClass(Packages.com.sun.star.container.XindexAccess);
importClass(Packages.com.sun.star.table.XcellRange);
importClass(Packages.com.sun.star.table.Xcell);

documentRef = XSCRIPTCONTEXT.getDocument();
spreadsheetInterface = UnoRuntime.queryInterface(XSpreadsheetDocument, documentRef);
allSheets = UnoRuntime.queryInterface(XIndexAccess, spreadsheetInterface.getSheets());
theSheet = allSheets.getByIndex(0);

Cells = UnoRuntime.queryInterface(XCellRange,theSheet);
cellA1 = Cells.getCellByPosition(0,0);
theCell = UnoRuntime.queryInterface(XCell,cellA1);
theCell.setFormula("Hello World from JavaScript");

Changing the color scheme of the Basic IDE

To change the color scheme used by the Basic IDE code editor, do the following steps:

1. From within the Basic IDE go to View > Color scheme to open the Color Scheme dialog

2. By default the option Use Application Colors is selected, which makes the Basic IDE use the colors defined in the Application Colors dialog (accessible via Tools > Options > Application Colors)

3. To use a different color scheme, click Choose Color Scheme and select one of the available entries in the list box

4. Click OK to apply the selected color schemeFigure 26 shows the code editor after selecting the Solarized Light color scheme. Notice that the color scheme only changes the colors used by the code editor.

• Tip

Additional color schemes can be added by extensions. Visit LibreOffice’s Extensions website to search for additional color schemes for your Basic IDE.

Finding more information

Numerous resources are available that provide help with writing macros. Use Help > LibreOffice Help, or press the F1 key, to open the LibreOffice help pages. The upper left corner of the LibreOffice help system contains a drop-down list that determines which help set is displayed. To view the help for Basic, choose Basic from this list.

Included material

Many excellent macros are included with LibreOffice. Use Tools > Macros > Organize Macros > Basic to open the LibreOffice Basic Macros dialog. Expand the Tools library in the LibreOffice library container. Inspect the Debug module; some good examples include WritedbgInfo (document) and printdbgInfo (sheet).

Online resources

The following links and references contain information regarding macro programming:

https://wiki.documentfoundation.org/Macros

https://ask.libreoffice.org/ (a Q&A site where volunteers answer questions related to LibreOffice)

https://wiki.documentfoundation.org/Documentation/Other_Documentation_and_Resources (look in Programmers section for BASIC Programmers’ Guide and Developers’ Guide; the latter contains a detailed explanation)

http://forum.openoffice.org/en/forum/ (Apache OpenOffice community forum; volunteers answer questions about LibreOffice as well)

Printed and ebook materials

Andrew Pitonyak published a free online book OpenOffice.org Macros Explained, which is a great reference for learning the Basic language used in both LibreOffice and OpenOffice. You can download the PDF version at https://www.pitonyak.org/OOME_3_0.pdf.

Dr. Mark Alexander Bain published the book Learn OpenOffice.org Spreadsheet Macro Programming. See https://www.packtpub.com/openoffice-ooobasic-calc-automation/book.

Roberto Benitez's Database Programming with OpenOffice.org Base & Basic is also a great source to learn more about macro programming.

Contents

• Copyright

• Contributors

• Feedback

• Publication date and software version

• Using LibreOffice on macOS

• Introduction

• Your first macros

• Adding a macro

• Recording a macro

• Running a macro

• Viewing and editing macros

• Commenting with REM

• Defining subroutines with SUB

• Defining variables using DIM

• Explaining macro code

• Creating a macro

• A more complex example of a macro

• Running a macro quickly

• Limitations of the macro recorder

• Understanding the dispatch framework

• How the macro recorder uses the dispatch framework

• Other options

• Macro organization

• Where are macros stored?

• Exporting macros

• Importing macros

• Downloading macros to import

• How to run a macro

• Toolbars, menu items, and keyboard shortcuts

• Events

• Using extensions

• Writing macros without the recorder

• An example of a macro in code for Writer

• An example of a macro in code for Calc

• The ScriptForge library

• UNO Object Inspector

• Overview of Python, BeanShell, and JavaScript macros

• Python macros

• BeanShell macros

• JavaScript macros

• Changing the color scheme of the Basic IDE

• Finding more information

• Included material

• Online resources

• Printed and ebook materials