De ScriptForge -bibliotheek
Open en selecteer container.
ScriptForge bibliotheken zijn een uitbreidbare collectie van macro-scripts voor LibreOffice die aangeroepen kunnen worden door Basic-macro's en Python-scripts.
• Basic macros require to load ScriptForge library using the following statement:
GlobalScope.BasicLibraries.LoadLibrary("ScriptForge")
• Python scripts require an import from scriptforge module:
from scriptforge import CreateScriptService
De beschreven modules en klassen worden aangeroepen vanuit gebruikersscripts als "Services". Voor dat doel is voor elke taal een generieke constructor van die services ontworpen:
GlobalScope.BasicLibraries.LoadLibrary("ScriptForge")
Set oSvc = CreateScriptService("servicename"[, arg0, arg1, ...])
from scriptforge import CreateScriptService
svc = CreateScriptService('servicename'[, arg0, arg1, ...])
De ScriptForge Basic-bibliotheek is beschikbaar vanaf versie LibreOffice 7.1.
De Python scriptforge-module is vanaf versie LibreOffice 7.2 beschikbaar.
Services beschikbaar in de ScriptForge-bibliotheek
Provides a collection of methods for manipulating and transforming arrays of one dimension (vectors) and arrays of two dimensions (matrices). This includes set operations, sorting, importing to and exporting from text files.
Voor arrays met meer dan twee dimensies kunnen deze methoden niet worden gebruikt, hierop is één uitzondering, de methode CountDims.
The Base service provides a number of methods and properties to facilitate the management and handling of LibreOffice Base documents.
This service is closely related to the Document service, which provides generic methods for handling LibreOffice documents, including Base documents. Hence, the Base service extends the Document service and provides additional methods that are specific for Base documents, enabling users to:
-
Get access to the database contained in a Base document.
-
Open form documents stored in a Base document.
-
Check if a form document from a Base document is currently loaded.
Deze service is beschikbaar vanaf LibreOffice 7.2.
The ScriptForge.Basic service proposes a collection of LibreOffice Basic methods to be executed in a Python context. Basic service methods reproduce the exact syntax and behaviour of Basic builtin functions.
Deze service is beschikbaar vanaf LibreOffice 7.2.
The SFDocuments library provides a number of methods and properties to facilitate the management and handling of LibreOffice Calc documents.
Some methods are generic for all types of documents and are inherited from the Document service, whereas other methods are specific for the SF_Calc module.
The SF_Calc module is focused on:
-
Handling sheets within a Calc document (copy, insert, move, etc)
-
Exchanging data between Basic data structures and Calc ranges
-
Copying and importing massive amounts of data
The Database service provides access to databases either embedded or described in Base documents. This service provides methods to:
-
Get access to data in database tables.
-
Run SELECT queries and perform aggregate functions.
-
Run SQL action statements such as INSERT, UPDATE, DELETE, etc.
The Dialog service contributes to the management of dialogs created with the Basic Dialog Editor. Each instance of the current class represents a single dialog box displayed to the user.
The DialogControl service manages the controls belonging to a dialog defined with the Basic Dialog Editor. Each instance of the current service represents a single control within a dialog box.
The focus is set on getting and setting the values displayed by the controls of the dialog box. Formatting is accessible via the XControlModel and XControlView properties.
Note that the unique DialogControl.Value property content varies according to the control type.
A special attention is given to controls of type tree control. It is easy to populate a tree, either branch by branch, or with a set of branches at once. Populating a tree control can be performed statically or dynamically.
A dictionary is a collection of key-item pairs
The SFDocuments library provides methods and properties to facilitate the management and manipulation of LibreOffice documents.
Methods that are applicable for all types of documents (Text Documents, Sheets, Presentations, etc) are provided by the SFDocuments.Document service. Some examples are:
The Exception service is a collection of methods to assist in code debugging in Basic and Python scripts and in error handling in Basic scripts.
In Basic scripts, when a run-time error occurs, the methods and properties of the Exception service help identify the error context and allow to handle it.
The FileSystem service includes routines to handle files and folders. Next are some examples of the features provided by this service:
-
Verify whether a file or folder exists.
-
Create and delete folders and files.
-
Launch dialog boxes to open/save files.
-
Access the list of files in a folder, etc.
The Form service provides methods and properties to manage forms in LibreOffice documents. This service supports forms in Base, Calc and Writer documents and allows to:
-
Open and activate forms.
-
Navigate through records shown by the form.
-
Get access to the controls inside the form.
-
Get access to subforms of a parent form.
The FormControl service provides access to the controls that belong to a form, a subform or a table control of a FormDocument. Each instance of the FormControl service refers to a single control in the form. This service allows users to:
-
Get and set the properties of the control represented by the FormControl instance.
-
Access the current value displayed by the control.
-
Set the focus on the desired control.
This service provides a number of methods related to the translation of strings with minimal impact on the program's source code. The methods provided by the L10N service can be used mainly to:
The Platform service provides a collection of properties about the current execution environment and context, such as:
-
The hardware platform (architecture, CPU count, machine type, etc)
-
Operating system information (OS type, release, version, etc)
-
The LibreOffice version
-
The current user name
The ScriptForge library is built upon an extensible collection of so-called "Services".
This collection is implemented as categories of Basic libraries or Python modules:
-
the standard ScriptForge library shipped with LibreOffice
-
a number of "associated" libraries shipped with LibreOffice as well
-
any user/contributor LibreOffice extension wanting to fit into the same framework
The Session service gathers various general-purpose methods about:
The String service provides a collection of methods for string processing. These methods can be used to:
-
Validate the contents of strings
-
Format strings by trimming, justifying or wrapping their contents
-
Use regular expressions to search and replace substrings
-
Apply hash algorithms on strings, etc.
The TextStream service is used to sequentially read from and write to files opened or created using the ScriptForge.FileSystem service.
The methods OpenTextFile and CreateTextFile from the FileSystem service return an instance of the TextStream service.
The Timer service measures the amount of time it takes to run user scripts.
A Timer measures durations. It can be:
-
Started, to indicate when to start measuring time.
-
Suspended, to pause measuring running time.
-
Resumed, to continue tracking running time after the Timer has been suspended.
-
Restarted, which will cancel previous measurements and start the Timer at zero.
The UI (User Interface) service simplifies the identification and the manipulation of the different windows composing the whole LibreOffice application:
-
Windows selection
-
Windows moving and resizing
-
Statusbar settings
-
Display of a floating progress bar
-
Creation of new windows
-
Access to the underlying "documents"
NB: Overige ScriptForge-modules die hier niet beschreven zijn, dienen voor intern gebruik door ScriptForge. Deze modules kunnen zonder kennisgeving worden gewijzigd.
All ScriptForge Basic routines or identifiers that are prefixed with an underscore character "_" are reserved for internal use. They are not meant be used in Basic macros.
