ScriptForge Method Signatures /text/sbasic/shared/03/sf_methods.xhp

ScriptForge Method Signatures

ScriptForge; Method signatures ScriptForge libraries aggregate macro scripting resources for %PRODUCTNAME 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. Whenever service methods are proposed solely for %PRODUCTNAME Basic, their syntax presentation matches that of Basic subroutines, functions or properties. Whenever service methods are proposed for Python and Basic, or solely for Python, their syntax and arguments use a specific textual layout.

Basic only service method

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

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: Optional parameters are indicated with either opt, '=' accompanying a default value, or '[ ]' brackets. arguments are lowercased, in order to comply with Python PEP 8 while Basic is case-agnostic. Collections arguments or API sequences are denoted using UML multiplicity. That applies also to return values. Basic data types and Python annotations are syntactically transposed as: %PRODUCTNAME
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

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