La biblioteca ScriptForge

Para acceder a esta orden…

Abra Herramientas ▸ Macros ▸ LibreOffice Basic ▸ Editar y seleccione el contenedor Macros de LibreOffice.


Las bibliotecas de ScriptForge constituyen una amplia colección de recursos de programación para LibreOffice que pueden invocarse desde macros escritas en BASIC o secuencias de órdenes escritas en Python.

note

• 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


tip

Para conocer más sobre la creación y ejecución de secuencias escritas en Python con la biblioteca ScriptForge, consulte la página de ayuda Creating Python Scripts with ScriptForge.


Los módulos y las clases que aquí se describen se pueden invocar desde secuencias de órdenes de usuario como «servicios». Para tal efecto, se ha diseñado un constructor genérico de dichos servicios para cada lenguaje:


      GlobalScope.BasicLibraries.LoadLibrary("ScriptForge")
      Set oSvc = CreateScriptService("servicename"[, arg0, arg1, ...])
    

      from scriptforge import CreateScriptService
      svc = CreateScriptService('servicename'[, arg0, arg1, ...])
      
    
note

La biblioteca ScriptForge para Basic está disponible a partir de la versión 7.1 de LibreOffice.
El módulo scriptforge de Python está disponible a partir de la versión 7.2.


Servicios que ofrece la biblioteca ScriptForge

Categoría

Servicios

LibreOffice Basic

Array
Dictionary
Exception

FileSystem
String
TextStream

Contenido del documento

Base
Calc

Database
Document

Interfaz de usuario

Dialog
DialogControl
UI

Form
FormControl

Utilidades

Basic
L10N
Platform

Services
Session
Timer


Servicio ScriptForge.Array

Facilita una colección de métodos para manipular y transformar formaciones de una dimensión (vectores) y de dos (matrices). La colección incluye operaciones de conjunto, ordenación, importación y exportación a partir de archivos de texto.

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.

Servicio SFDocuments.Base

El servicio Base proporciona diversos métodos y propiedades que facilitan la gestión y la manipulación de los documentos de LibreOffice Base.

Este servicio está estrechamente relacionado con el servicio Document, que brinda métodos genéricos para manipular documentos de LibreOffice, incluidos los de Base. De ahí que el servicio Base amplíe Document y ofrezca métodos adicionales específicos para los documentos de Base, permitiendo a los usuarios:

note

Este servicio está disponible a partir de la versión 7.2 de LibreOffice.


ScriptForge.Basic service

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.

note

Este servicio está disponible a partir de la versión 7.2 de LibreOffice.


SFDocuments.Calc service

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:

SFDatabases.Database service

The Database service provides access to databases either embedded or described in Base documents. This service provides methods to:

SFDialogs.Dialog service

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.

SFDialogs.DialogControl service

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.

ScriptForge.Dictionary service

A dictionary is a collection of key-item pairs

Servicio SFDocuments.Document

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:

ScriptForge.Exception service

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.

ScriptForge.FileSystem service

The FileSystem service includes routines to handle files and folders. Next are some examples of the features provided by this service:

SFDocuments.Form service

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:

SFDocuments.FormControl service

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:

ScriptForge.L10N service

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:

Servicio ScriptForge.Platform

El servicio Platform ofrece una colección de propiedades sobre el entorno y el contexto de ejecución actuales, tales como:

ScriptForge.Services service

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:

  1. the standard ScriptForge library shipped with LibreOffice

  2. a number of "associated" libraries shipped with LibreOffice as well

  3. any user/contributor LibreOffice extension wanting to fit into the same framework

ScriptForge.Session service

El servicio Session reúne varios métodos de uso general relativos a:

ScriptForge.String service

The String service provides a collection of methods for string processing. These methods can be used to:

ScriptForge.TextStream service

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.

ScriptForge.Timer service

El servicio Timer mide el intervalo de tiempo necesario para ejecutar secuencias de órdenes de usuario.

A Timer measures durations. It can be:

Servicio ScriptForge.UI

The UI (User Interface) service simplifies the identification and the manipulation of the different windows composing the whole LibreOffice application:

Nota: los otros módulos de ScriptForge que no se describen aquí están reservados para uso interno. Su contenido está sujeto a cambios sin previo aviso.

warning

Todas las rutinas o los identificadores Basic de ScriptForge que comienzan por un guion bajo «_» son únicamente para uso interno. No deben utilizarse en macros Basic.


¡Necesitamos su ayuda!