Отворете Инструменти - Макроси - LibreOffice Basic - Редактиране и изберете контейнера Макроси на приложението.
Библиотеките ScriptForge представляват разширяем набор от ресурси за скриптиране на макроси за LibreOffice, които могат да бъдат използвани от макроси на Basic или скриптове на Python.
• Макросите на Basic изискват зареждане на библиотеката ScriptForge чрез следния оператор: GlobalScope.BasicLibraries.loadLibrary("ScriptForge")
• Скриптовете на Python изискват импортиране от модула scriptforge: from scriptforge import CreateScriptService
Описаните модули и класове се извикват от потребителски скриптове като „Услуги“. За тази цел за всеки език е проектиран общ конструктор на тези услуги.
Методът Dispose е наличен във всички услуги и трябва да бъде извикван, за да се освободят ресурсите след употреба:
Предоставя набор от методи за манипулиране и трансформиране на едномерни масиви (вектори) и двумерни масиви (матрици). Това включва операции с множества, сортиране, импортиране от и експортиране към текстови файлове.
Масиви с повече от две измерения не могат да се използват с методите в тази услуга, с изключение само на метода CountDims, който приема масиви с произволен брой измерения.
Услугата Base предоставя методи и свойства за управление и работа с документи на LibreOffice Base.
Тази услуга е тясно свързана с услугата Document, която предоставя общи методи за работа с документи на LibreOffice, включително такива на Base. Следователно услугата Base разширява Document и предлага допълнителни методи, специфични за документите на Base, като позволява на потребителите:
да получават достъп до базата от данни, която се съдържа в документ на Base;
да отварят документи с формуляри, съхранявани в документ на Base;
да проверяват дали в момента е зареден документ с формуляри от документ на Base.
Услугата ScriptForge предоставя съвкупност от методи на LibreOffice Basic за изпълнение в контекст на Python. Методите на услугата Basic възпроизвеждат точния синтаксис и поведение на вградените функции на Basic.
Споделената библиотека SFDocuments предлага набор от методи и свойства за улесняване управлението и боравенето с документи на LibreOffice.
Услугата SFDocuments.Calc е подклас на услугата SFDocuments.Document. Всички методи и свойства, дефинирани за услугата Document, са достъпни и през екземпляр на услугата Calc.
Услугата Calc е предназначена основно за:
боравене с листове в документ на Calc (копиране, вмъкване, преместване и т.н.)
обмен на данни между структури от данни на Basic и диапазони на Calc
копиране и импортиране на големи количества данни.
Услугата Datasheet позволява визуализиране съдържанието на таблици в база от данни, както и резултатите от заявки и оператори на SQL, посредством прозореца „Изглед с данни“ на Base. Освен това чрез нея е възможно:
да се добавят потребителски менюта в изгледа с данни
да се осъществява достъп до данните в конкретни позиции от изгледа с данни
да се позиционира курсора в зададена клетка от изгледа с данни.
Услугата Dialog подпомага управлението на диалози, изградени с редактора на диалози на Basic или създадени в движение. Всеки екземпляр на текущия клас представя един отделен диалогов прозорец, показан на потребителя.
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.
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:
Opening, closing and saving documents
Accessing standard or custom properties of documents
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 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:
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.
The FormDocument service allows to access form documents stored in LibreOffice Base documents.
In a Base document, existing form documents can be viewed by selecting View - Forms 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:
Create POT files that can be used as templates for translation of all strings in the program.
Get translated strings at runtime for the language defined in the Locale property.
The Menu service can be used to create and remove menus from the menubar of a LibreOffice 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.
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.
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 Toolbar service allows to retrieve information related to the toolbars available for a specific document window. With this service it is possible to:
Toggle the visibility of specific toolbars.
Access information about the buttons available in each toolbar.
The ToolbarButton service allows to retrieve information related to the toolbar buttons available in a given toolbar. With this service it is possible to:
Toggle the visibility of toolbar elements.
Execute the command associated with a given toolbar button.
The UI (User Interface) service simplifies the identification and the manipulation of the different windows composing the whole LibreOffice application:
Споделената библиотека SFDocuments предлага набор от методи и свойства за улесняване управлението и боравенето с документи на LibreOffice.
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.
Бележка: други, неописани модули на ScriptForge са запазени за вътрешна употреба. Съдържанието им подлежи на промяна без предизвестие.
В ScriptForge всички подпрограми или идентификатори на Basic с префикс „_“ са запазени за вътрешна употреба. Те не са предназначени за използване в макроси на Basic.