LibreOfficeDev 25.8 Help
ScriptForge-bibliotheken verzamelen macroscriptbronnen voor LibreOfficeDev om te worden aangeroepen vanuit basismacro's of Python-scripts. De modules en klassen worden aangeroepen vanuit gebruikersscripts als "Services" die eigenschappen, methodes en gebeurtenissen blootleggen.
Wanneer servicemethodes uitsluitend voor LibreOfficeDev Basic worden voorgesteld, komt hun syntaxispresentatie overeen met die van Basic-subroutines, -functies of -eigenschappen.
Telkens wanneer servicemethodes worden voorgesteld voor Python en Basic, of alleen voor Python, gebruiken hun syntaxis en argumenten een specifieke tekstindeling.
Typografische tekens zoals haakjes, weglatingsteken of accolades duiden optionele, repetitieve of verplichte argumenten aan:
       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
    De volgende typografische regels mengen de UML-notatie, de API-documentatie-indeling en de gebruikersinterface van de UNO-objectinspecteur:
Optionele parameters worden aangegeven met ofwel opt, '=' bij een standaardwaarde, of '[ ]' haakjes.
Argumenten zijn in kleine letters om overeen te komen met Python PEP 8, terwijl Basic niet hoofdlettergevoelig is.
Argumenten voor verzamelingen of API-reeksen worden aangeduid met UML-multipliciteit. Dat geldt ook voor retourwaarden.
Basic-gegevenstypes en Python-annotaties worden syntactisch getransponeerd als:
| LibreOfficeDev | Syntaxis | Python | 
|---|---|---|
| Booleaans | 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-object | uno | |
| Gebruikergedefinieerd | 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