Hilfe für LibreOffice 24.8
Bibliotheken "ScriptForge" aggregieren Makro-Scripting-Ressourcen für LibreOffice, die von Basic-Makros oder Python-Scripts aufgerufen werden. Seine Module und Klassen werden von Benutzerskripten als "Dienste" aufgerufen, die Eigenschaften, Methoden und Ereignisse offenlegen.
Wenn Dienstmethoden nur für LibreOffice Basic vorgeschlagen werden, stimmt ihre Syntaxdarstellung mit der von Basic-Subroutinen, -Funktionen oder -Eigenschaften überein.
Immer wenn Dienstmethoden für Python und Basic oder nur für Python vorgeschlagen werden, verwenden ihre Syntax und Argumente ein bestimmtes Textlayout.
Typografische Zeichen wie Klammern, Auslassungspunkte oder geschweifte Klammern kennzeichnen optionale, sich wiederholende oder obligatorische Argumente:
       FSO.HashFile(FileName As String, _
           Algorithm As String = {MD5|SHA1|SHA224|SHA256|SHA384|SHA512}) As String
       SF_Array.ImportFromCSVFile(FileName As String, _
           [Delimiter = ","], [DateFormat As String]) As Variant
       SF_String.SplitNotQuoted(InputStr As String, _
          [Delimiter As String], [Occurrences As Long], [QuoteChar As String]) As Variant
    Die folgenden typografischen Regeln mischen die UML-Notation, das Layout der API-Dokumentation und die Benutzeroberfläche des UNO-Objektinspektors:
Optionale Parameter werden entweder mit opt, '=' neben einem Standardwert oder '[ ]'-Klammern angegeben.
Argumente werden in Kleinbuchstaben geschrieben, um Python PEP 8 zu entsprechen, während Basic die Groß- und Kleinschreibung nicht berücksichtigt.
Sammlungsargumente oder API-Sequenzen werden mit UML-Multiplizität bezeichnet. Das gilt auch für Rückgabewerte.
Basic-Datentypen und Python-Anmerkungen werden syntaktisch transponiert als:
| LibreOffice | Syntax | Python | 
|---|---|---|
| Boolesch | bool | bool | 
| Date | datetime | datetime | 
| Double | float | float | 
| Integer | int | int | 
| Long | int | int | 
| Object | obj | |
| Single | float | float | 
| String | str | str | 
| Variant | any | |
| UNO-Objekt | uno | |
| Benutzerdefiniert | obj | |
| ScriptForge | svc | 
svc.Forms( opt form: any ): svc[0..*]
svc.MsgBox( prompt: str, buttons = svc.MB_OK , opt title: str ): opt str
svc.InputBox( prompt: str, default = "", [ title: str ], [ xpostwips: int, ypostwips: int ] ): str