La bibliothèque ScriptForge

Pour accéder à cette commande...

Ouvrez Outils - Macros - LibreOffice Basic - √Čditer et s√©lectionnez le conteneur Macros d'application.


Les bibliothèques ScriptForge constituent une collection évolutive de ressources de programmation pour LibreOffice qui peuvent être invoquées depuis des macros en Basic ou des scripts en Python.

note

‚ÄĘ Les macros Basic n√©cessitent de charger la biblioth√®que ScriptForge √† l'aide de l'instruction suivante¬†:
GlobalScope.BasicLibraries.loadLibrary("ScriptForge")

‚ÄĘ Les scripts Python n√©cessitent un import depuis le module scriptforge¬†:
from scriptforge import CreateScriptService


tip

Pour en savoir plus sur la création et l'exécution de scripts Python à l'aide de la bibliothèque ScriptForge, lisez la page d'aide Création de scripts Python avec ScriptForge.


Appel des services ScriptForge

Les modules et classes décrits sont appelés à partir de scripts utilisateur en tant que "Services". Un constructeur générique de ces services a été conçu à cet effet pour chaque langage.

La méthode Dispose est disponible dans tous les services et doit être appelée pour libérer des ressources après utilisation :

En Basic :

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

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

Services fournis par la bibliothèque ScriptForge

Catégorie

Services

LibreOffice Basic

Array
Dictionary

Exception
FileSystem

String
TextStream

Contenu du document

Base
Calc
Chart

Database
Dataset
Datasheet

Document
FormDocument
Writer

Interface utilisateur

Dialog
DialogControl
Form

FormControl
Menu
PopupMenu

Toolbar
ToolbarButton
UI

Utilitaires

Basic
L10N
Platform

Region
Services
Session

Timer
UnitTest


ScriptForge. Service Array

Fournit une collection de méthodes pour manipuler et transformer des matrices à une dimension (vecteurs) et des matrices à deux dimensions (matrices). Cela inclut les opérations d'ensemble, le tri, l'import depuis et l'export vers des fichiers texte.

Les matrices avec plus de deux dimensions ne peuvent pas être utilisées avec les méthodes de ce service, la seule exception étant la méthode CountDims qui accepte les matrices avec un nombre quelconque de dimensions.

Service SFDocuments.Base

Le service Base fournit un certain nombre de méthodes et de propriétés pour faciliter la gestion et la manipulation des documents LibreOffice Base.

Ce service est étroitement lié au service Document, qui fournit des méthodes génériques pour gérer les documents LibreOffice, y compris les documents Base. Par conséquent, le service Base étend le service Document et fournit des méthodes supplémentaires spécifiques aux documents Base, permettant aux utilisateurs de :

ScriptForge.Service Basic

Le service ScriptForge.Basic propose une collection de méthodes LibreOffice Basic à exécuter dans un contexte Python. Les méthodes de service Basic reproduisent la syntaxe et le comportement exacts des fonctions intégrées Basic.

SFDocuments. Service Calc

La bibliothèque partagée SFDocuments fournit un certain nombre de méthodes et de propriétés pour faciliter la gestion et la manipulation des documents LibreOffice.

Le service SFDocuments.Calc est une sous-classe du service SFDocuments.Document. Toutes les méthodes et propriétés définies pour le service Document sont également accessibles à l'aide d'une instance de service Calc.

Le service Calc se concentre sur :

Service SFDocuments.Chart

Le service Chart fournit un ensemble de propriétés et de méthodes pour gérer les diagrammes dans les documents Calc. Avec ce service il est possible de :

Service SFDatabases.Database

Le service Database permet d'accéder aux bases de données intégrées ou décrites dans les documents Base. Ce service fournit des méthodes pour :

ServiceSFDatabases.Dataset

Le service Dataset est utilisé pour représenter des données tabulaires produites par une base de données. Avec ce service, il est possible de :

Service SFDatabases.Datasheet

Le service Datasheet permet de visualiser le contenu des tables de la base de données ainsi que les résultats des requêtes et des instructions SQL à l'aide de la vue de données de Base. De plus, ce service permet de :

SFDialogs. Service Dialog

Le service Dialog contribue √† la gestion des bo√ģtes de dialogue cr√©√©es avec l'Dialog Editor Basic ou des bo√ģtes de dialogue cr√©√©es √† la vol√©e . Chaque instance de la classe actuelle repr√©sente une bo√ģte de dialogue unique affich√©e √† l'utilisateur.

SFDialogs. Service DialogControl

Le service DialogControl g√®re les contr√īles appartenant √† un dialogue d√©fini avec le Basic Dialog Editor. Chaque instance du service actuel repr√©sente un contr√īle unique dans une bo√ģte de dialogue.

L'accent est mis sur l'obtention et la d√©finition des valeurs affich√©es par les contr√īles de la bo√ģte de dialogue. La mise en forme est accessible via les propri√©t√©s XControlModel et XControlView.

Notez que le contenu unique de la propri√©t√© DialogControl.Value varie selon le type de contr√īle.

Une attention particuli√®re est port√©e aux contr√īles de type contr√īle en arborescence. Il est facile de peupler un arbre, soit branche par branche, soit avec un ensemble de branches √† la fois. Le remplissage d'un contr√īle d'arborescence peut √™tre effectu√© de mani√®re statique ou dynamique.

Service ScriptForge.Dictionary

Un dictionnaire est une collection de paires d'éléments clés

Service SFDocuments.Document

La bibliothèque SFDocuments fournit des méthodes et des propriétés pour faciliter la gestion et la manipulation des documents LibreOffice.

Les méthodes applicables à tous les types de documents (Documents Textes, Classeurs, Présentations, etc.) sont fournies par le service SFDocuments.Document. Certains exemples sont :

Service ScriptForge.Exception

Le service Exception est un ensemble de méthodes pour aider au débogage du code dans les scripts Basic et Python et à la gestion des erreurs dans les scripts Basic.

Dans les scripts de base, lorsqu'une erreur d'exécution se produit, les méthodes et propriétés du service Exception aident à identifier le contexte de l'erreur et permettent de le gérer.

ScriptForge. Service FileSystem

Le service FileSystem inclut des routines pour gérer les fichiers et les dossiers. Voici quelques exemples des fonctionnalités fournies par ce service :

SFDocuments. Service Form

Le service Form fournit des méthodes et des propriétés pour gérer les formulaires dans les documents LibreOffice. Ce service prend en charge les formulaires dans les documents Base, Calc et Writer et permet de :

Service SFDocuments.FormControl

Le service FormControl permet d'acc√©der aux contr√īles appartenant √† un formulaire, un sous-formulaire ou un contr√īle de table d'un FormDocument. Chaque instance du service FormControl fait r√©f√©rence √† un seul contr√īle dans le formulaire. Ce service permet aux utilisateurs de :

Service SFDocuments.FormDocument

Le service FormDocument permet d'accéder aux documents de formulaire stockés dans les documents LibreOffice Base.

Dans un document Base, les documents de formulaire existants peuvent être visualisés en sélectionnant Afficher - Formulaires dans l'interface utilisateur. Chaque document de formulaire peut être composé d'un ou plusieurs formulaires, y compris le formulaire principal et d'autres sous-formulaires.

Service ScriptForge.L10N

Ce service fournit un certain nombre de m√©thodes li√©es √† la traduction des cha√ģnes avec un impact minimal sur le code source du programme. Les m√©thodes fournies par le service L10N permettent principalement de¬†:

Service SFWidgets.Menu

Le service Menu permet de créer et de supprimer des menus de la barre de menus d'une fenêtre de document LibreOffice. Chaque entrée de menu peut être associée à un script ou à une commande UNO. Ce service offre les fonctionnalités suivantes :

Service ScriptForge.Platform

Le service Platform fournit une collection de propriétés sur l'environnement et le contexte d'exécution actuels, telles que :

Service SFWidgets.PopupMenu

Le service PopupMenu permet de créer des menus contextuels pouvant être associés à des événements ou exécutés par des scripts. Ce service offre les fonctionnalités suivantes :

Service ScriptForge.Region

Le service Region fournit un ensemble de propriétés et de méthodes pour gérer les aspects de programmation liés aux paramètres locaux et régionaux, tels que :

Service ScriptForge.Services

L'objectif principal du module Services est de fournir un accès à la méthode CreateScriptService, qui peut être appelée dans des scripts utilisateur pour instancier des services implémentés à l'aide de l'environnement ScriptForge.

Service ScriptForge.Session

Le service Session rassemble diverses méthodes à usage général concernant :

Service ScriptForge.String

Le service String fournit une collection de m√©thodes pour le traitement des cha√ģnes. Ces m√©thodes peuvent √™tre utilis√©es pour :

Service ScriptForge.TextStream

Le service TextStream est utilisé pour lire et écrire séquentiellement dans des fichiers ouverts ou créés à l'aide du service ScriptForge.FileSystem.

Les méthodes OpenTextFile et CreateTextFile du service FileSystem renvoient une instance du service TextStream.

Service ScriptForge.Timer

Le service Timer mesure le temps nécessaire à l'exécution des scripts utilisateur.

Un Timer mesure les durées. Ça peut être:

ServiceSFWidgets.Toolbar

Le service Toolbar permet de récupérer des informations relatives aux barres d'outils disponibles pour une fenêtre de document spécifique. Avec ce service, il est possible de :

Service SFWidgets.ToolbarButton

Le service ToolbarButton permet de récupérer des informations relatives aux boutons de barre d'outils disponibles dans une barre d'outils donnée. Avec ce service, il est possible de :

Service ScriptForge.UI

Le service UI (User Interface) simplifie l'identification et la manipulation des différentes fenêtres composant l'ensemble de l'application LibreOffice :

Service SFUnitTests.UnitTest

Le service UnitTest fournit un cadre pour automatiser les tests unitaires à l'aide du langage Basic, notamment la possibilité de :

Service SFDocuments.Writer

La bibliothèque partagée SFDocuments fournit un certain nombre de méthodes et de propriétés pour faciliter la gestion et la manipulation des documents LibreOffice.

Certaines méthodes sont génériques pour tous les types de documents et sont héritées du module SF_Document, tandis que d'autres méthodes spécifiques aux documents Writer sont définies dans le module SF_Writer.

Remarque :les autres modules ScriptForge non décrits sont réservés à un usage interne. Leur contenu est sujet à changement sans préavis.

warning

Toutes les routines ou identifiants de base ScriptForge qui sont préfixés par un caractère de soulignement "_" sont réservés à un usage interne. Ils ne sont pas destinés à être utilisés dans des macros de base ou des scripts Python.


Aidez-nous !