ScriptForge Method Signatures

ScriptForge libraries aggregate macro scripting resources for LibreOffice to be invoked from Basic macros or Python scripts. Its modules and classes are invoked from user scripts as "Services" that expose properties, methods and events.

Basic only service method

Typographical characters such as brackets, ellipsis or curly braces denote optional, repetitive or compulsory arguments:

Example:


       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
    

Python or Basic service methods

The following typographical rules are mixing the UML notation, the API documentation layout and the UNO object inspector user interface:

LibreOffice
Basic

Syntax

Python

Boolean

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

User Defined
Type (UDT)

obj

ScriptForge
service

svc


Example:

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

Please support us!