The Unofficial LibreOffice Basic Reference

Purpose of this documentation

This documentation project has two goals:

• To comprehensively document the LibreOffice Basic programming language and the LibreOffice API as it is used in Basic.

• To help users familiar with Microsoft Visual Basic for Applications (VBA) to get started with LibreOffice Basic.

Scope

This documentation project currently focuses exclusively on the LibreOffice API and the LibreOffice version of the Basic programming language. No other APIs or programming languages are covered.

While it is true that the OpenOffice API is very similar to the LibreOffice API, and much of this documentation is likely applicable to both, small differences have crept in since LibreOffice branched off from OpenOffice. For this reason, readers should not expect compatibility.

This documentation is inspired by the outstanding Microsoft Visual Basic for Applications (VBA) Documentation. Microsoft’s business practices may suck, but its documentation rocks.

Note

TRADEMARK NOTICE LibreOffice® is a registered trademark of The Document Foundation. Microsoft Office® and Visual Basic for Applications® are registered trademarks of Microsoft Corporation. All other trademarks referenced in this documentation are the property of their respective owners.

Note

DISCLAIMER This project is not affiliated with, supported by or endorsed by The Document Foundation in any way. It is my own personal project, I am not compensated for it, and while I have taken the utmost care in preparing it, it is provided without any claim of correctness, completeness or suitability for any purpose.

Note

COPYRIGHT / LICENSE This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International Public License. TL:DR Yes, you can use my stuff. No, you can’t pretend it’s your stuff. No, you can’t make money off of stuff I made for free.

Contents

• The Unofficial LibreOffice Basic Reference
• A quick comparison of LibreOffice Basic and VBA
• LibreOffice (common)
  • Object model
    • Document object (LibreOffice common)
      • Methods
        • Document.GetCurrentController method (LibreOffice common)
        • Document.SupportsService method (LibreOffice common)
• Calc
  • Calc object model
    • ScTableSheetObj object (Calc)
      • Methods
        • ScTableSheetObj.CreateFilterDescriptor method (Calc)
• Writer
  • Writer object model
    • SwXBodyText object (Writer)
      • Methods
        • SwXBodyText.insertControlCharacter method (Writer)
    • Enumerations
      • com.sun.star.text.ControlCharacter Enumeration (Writer)
• Language reference
  • Detailed comparison of LibreOffice Basic and Visual Basic for Applications
  • Reference
    • Functions
      • Overview of LibreOffice Basic functions
      • CreateUnoService function
      • HasUnoInterfaces function
    • Objects
      • Overview of LibreOffice Basic objects
      • StarDesktop object
      • ThisComponent object
• License