Open Tools - Macros - LibreOffice Basic - Edit and select Application Macros container.
As bibliotecas ScriptForge constituem uma coleção extensível de recursos de scripts de macros para o LibreOffice, que podem ser invocados a partir de macros Basic ou scripts Python.
• As macros básicas requerem o carregamento da biblioteca ScriptForge através da seguinte instrução: GlobalScope.BasicLibraries.loadLibrary("ScriptForge")
• Os scripts Python requerem a importação do módulo scriptforge: from scriptforge import CreateScriptService
Os módulos e classes descritos são chamados a partir de scripts do utilizador como «Serviços». Para esse efeito, foi concebido um construtor genérico desses serviços para cada linguagem.
O método Dispose está disponível em todos os serviços e deve ser chamado para libertar recursos após a utilização:
Fornece um conjunto de métodos para manipular e transformar matrizes unidimensionais (vetores) e bidimensionais (matrizes). Isto inclui operações com conjuntos, ordenação, importação e exportação para ficheiros de texto.
As matrizes com mais de duas dimensões não podem ser utilizadas com os métodos deste serviço, sendo a única exceção o método CountDims, que aceita matrizes com qualquer número de dimensões.
O serviço Base disponibiliza vários métodos e propriedades para facilitar a gestão e o manuseamento de documentos LibreOffice Base.
Este serviço está intimamente relacionado com o serviço Document, que fornece métodos genéricos para o tratamento de documentos LibreOffice, incluindo documentos Base. Por conseguinte, o serviço Base estende o serviço Document e fornece métodos adicionais específicos para documentos Base, permitindo aos utilizadores:
Obter acesso à base de dados contida num documento Base.
Abrir documentos de formulário armazenados num documento Base.
Verifique se está carregado um documento de formulário proveniente de um documento Base.
O serviço ScriptForge.Basic disponibiliza um conjunto de métodos LibreOffice Basic para serem executados num contexto Python. Os métodos do serviço Basic reproduzem exatamente a sintaxe e o comportamento das funções integradas do Basic.
A biblioteca partilhada SFDocuments disponibiliza vários métodos e propriedades para facilitar a gestão e o manuseamento de documentos LibreOffice.
O serviço SFDocuments.Calc é uma subclasse do serviço SFDocuments.Document. Todos os métodos e propriedades definidos para o serviço Document também podem ser acedidos utilizando uma instância do serviço Calc.
O serviço Calc centra-se em:
Manipular folhas num documento do Calc (copiar, inserir, mover, etc.)
Troca de dados entre estruturas de dados básicas e intervalos do Calc
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.
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:
The SFDocuments shared library provides a number of methods and properties to facilitate the management and handling of LibreOffice 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.
Nota: Outros módulos do ScriptForge não descritos estão reservados para uso interno. O seu conteúdo está sujeito a alterações sem aviso prévio.
Todas as rotinas ou identificadores do ScriptForge Basic que tenham o caractere de sublinhado «_» como prefixo estão reservados para uso interno. Não se destinam a ser utilizados em macros do Basic ou em scripts Python.
