The ScriptForge Library
Open and select container.
ScriptForge libraries build up an extensible collection of macro scripting resources for Collabora Office to be invoked from Basic macros or 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
Invoking ScriptForge services
The described modules and classes are invoked from user scripts as "Services". A generic constructor of those services has been designed for that purpose for each language.
The Dispose method is available in all services and should be called to free up resources after usage:
GlobalScope.BasicLibraries.LoadLibrary("ScriptForge")
Set oSvc = CreateScriptService("servicename"[, arg0, arg1, ...])
' ...
oSvc.Dispose()
from scriptforge import CreateScriptService
svc = CreateScriptService('servicename'[, arg0, arg1, ...])
# ...
svc.Dispose()
Services provided by the ScriptForge library
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 from and exporting to text files.
Arrays with more than two dimensions cannot be used with the methods in this service, the only exception being the CountDims method that accepts Arrays with any number of dimensions.
The Base service provides a number of methods and properties to facilitate the management and handling of Collabora Office Base documents.
This service is closely related to the Document service, which provides generic methods for handling Collabora Office 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.
The ScriptForge.Basic service proposes a collection of Collabora Office Basic methods to be executed in a Python context. Basic service methods reproduce the exact syntax and behaviour of Basic builtin functions.
The SFDocuments shared library provides a number of methods and properties to facilitate the management and handling of Collabora Office documents.
The SFDocuments.Calc service is a subclass of the SFDocuments.Document service. All methods and properties defined for the Document service can also be accessed using a Calc service instance.
The Calc service 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 Chart service provides a set of properties and methods to handle charts in Calc documents. With this service it is possible to:
-
Access chart objects in Calc documents and manipulate their properties.
-
Create and insert new charts into a Calc document.
-
Export charts as image files.
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 Dataset service is used to represent tabular data produced by a database. With this service it is possible to:
The Datasheet service allows to visualize the contents of database tables as well as the results of queries and SQL statements using Base's Data View. Additionally, this service allows to:
-
Add custom menus to the data view.
-
Access values in specific positions of the data view.
-
Position the cursor in a specific cell of the data view.
The Dialog service contributes to the management of dialogs created with the Basic Dialog Editor or dialogs created on-the-fly. 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 Collabora Office 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 Collabora Office 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.
The FormDocument service allows to access form documents stored in Collabora Office Base documents.
In a Base document, existing form documents can be viewed by selecting in the user interface. Each form document may be composed of one or more forms, including the main form and other sub-forms.
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 Menu service can be used to create and remove menus from the menubar of a Collabora Office document window. Each menu entry can be associated with a script or with a UNO command. This service provides the following capabilities:
-
Creation of menus with custom entries, checkboxes, radio buttons and separators.
-
Decoration of menu items with icons and tooltips.
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 Collabora Office version
-
The current user name
The PopupMenu service can be used to create popup menus that can be associated with events or executed by scripts. This service provides the following capabilities:
-
Creation of popup menus with custom entries, checkboxes and radio buttons.
-
Decoration of menu items with icons and tooltips.
The Region service provides a collection of properties and methods to handle locale and region-related aspects of programming, such as:
-
Accessing locale and region-dependent settings such as number formatting, currency and timezones.
-
Converting timezones and calculate Daylight Saving Time (DST) offsets.
-
Transforming numbers into text in any supported language.
The main purpose of the Services module is to provide access to the CreateScriptService method, which can be called in user scripts to instantiate services that are implemented using the ScriptForge 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 Toolbar service allows to retrieve information related to the toolbars available for a specific document window. With this service it is possible to:
The ToolbarButton service allows to retrieve information related to the toolbar buttons available in a given toolbar. With this service it is possible to:
The UI (User Interface) service simplifies the identification and the manipulation of the different windows composing the whole Collabora Office application:
-
Windows selection
-
Windows moving and resizing
-
Statusbar settings
-
Display of a floating progress bar
-
Creation of new windows
-
Access to the underlying "documents"
The UnitTest service provides a framework for automating unit tests using the Basic language, including the ability to:
-
Aggregate test cases into test suites and unit tests.
-
Share setup and shutdown code among test cases.
-
Report test results using the Console.
The SFDocuments shared library provides a number of methods and properties to facilitate the management and handling of Collabora Office documents.
Some methods are generic for all types of documents and are inherited from the SF_Document module, whereas other methods that are specific for Writer documents are defined in the SF_Writer module.
Note: Other ScriptForge undescribed modules are reserved for internal use. Their content is subject to change without notice.
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 or Python scripts.
