Βιβλιοθήκες ScriptForge

Περιεχόμενα
Δείκτης 🔎︎

# Η βιβλιοθήκη ScriptForge

Για να έχετε πρόσβαση σε αυτήν τη λειτουργία...

Ανοίξτε Εργαλεία - Μακροεντολές - LibreOffice Basic - Επεξεργασία και επιλέξτε τον περιέκτη Μακροεντολές LibreOffice.

Οι βιβλιοθήκες ScriptForge δημιουργούν μια επεκτάσιμη συλλογή πόρων δέσμης ενεργειών μακροεντολών για το LibreOffice που θα κληθεί από μακροεντολές Basic ή σενάρια Python.

• 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

Για να μάθετε περισσότερα σχετικά με τον τρόπο δημιουργίας και εκτέλεσης σεναρίων Python χρησιμοποιώντας τη βιβλιοθήκη ScriptForge, διαβάστε τη σελίδα βοήθειας Δημιουργία σεναρίων Python με το ScriptForge.

## Kλση υπηρεσιών ScriptForge

Οι περιγραφόμενες μονάδες και κλάσεις καλούνται από τα σενάρια χρήστη ως "Υπηρεσίες". Ένας γενικός κατασκευαστής αυτών των υπηρεσιών έχει σχεδιαστεί για αυτόν τον σκοπό για κάθε γλώσσα:

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

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

Η μέθοδος Dispose (Απόρριψη) είναι διαθέσιμη σε όλες τις υπηρεσίες και θα πρέπει να καλείται για να απελευθερώσει πόρους μετά τη χρήση.

## Υπηρεσίες που παρέχονται από τη βιβλιοθήκη ScriptForge

Κατηγορία | Υπηρεσίες |
LibreOffice Basic | Array Dictionary Exception | FileSystem String TextStream
Περιεχόμενο εγγράφου | Base Calc Chart | Database Document
Διεπαφή χρήστη | Dialog DialogControl Form | FormControl PopupMenu UI
Βοηθητικά προγράμματα | Basic L10N Platform | Services Session Timer

## ScriptForge.Υπηρεσία Πίνακας

Παρέχει μια συλλογή μεθόδων για το χειρισμό και τον μετασχηματισμό πινάκων μιας διάστασης (διανύσματα) και πινάκων δύο διαστάσεων (μήτρες). Αυτό περιλαμβάνει λειτουργίες συνόλου, ταξινόμηση, εισαγωγή και εξαγωγή από αρχεία κειμένου.

Πίνακες με περισσότερες από δύο διαστάσεις δεν μπορούν να χρησιμοποιηθούν με τις μεθόδους αυτής της υπηρεσίας, η μόνη εξαίρεση είναι η μέθοδος CountDims που δέχεται Πίνακες με οποιονδήποτε αριθμό διαστάσεων.

## SFDocuments.Υπηρεσία Base

Η υπηρεσία Base παρέχει έναν αριθμό μεθόδων και ιδιοτήτων για τη διευκόλυνση της διαχείρισης και του χειρισμού των εγγράφων της Base του LibreOffice.

Αυτή η υπηρεσία σχετίζεται στενά με την υπηρεσία Document, η οποία παρέχει γενικές μεθόδους για το χειρισμό εγγράφων του LibreOffice, συμπεριλαμβανομένων των εγγράφων Base. Ως εκ τούτου, η υπηρεσία Base επεκτείνει την υπηρεσία Document και παρέχει πρόσθετες μεθόδους που είναι ειδικές για έγγραφα Base, επιτρέποντας στους χρήστες να:

- Αποκτήστε πρόσβαση στη βάση δεδομένων που περιέχεται σε ένα έγγραφο Base.

- Άνοιγμα εγγράφων φόρμας που είναι αποθηκευμένα σε ένα έγγραφο Base.

- Ελέγξτε εάν ένα έγγραφο φόρμας από ένα έγγραφο Base έχει φορτωθεί αυτήν τη στιγμή.

## Υπηρεσία ScriptForge.Basic

Η υπηρεσία ScriptForge.Basic προτείνει μια συλλογή μεθόδων του LibreOffice Basic που θα εκτελεστούν σε περιβάλλον Python. Οι μέθοδοι υπηρεσίας Basic αναπαράγουν την ακριβή σύνταξη και συμπεριφορά των ενσωματωμένων συναρτήσεων Basic.

## Υπηρεσία SFDocuments.Calc

Η κοινόχρηστη βιβλιοθήκη SFDocuments παρέχει έναν αριθμό μεθόδων και ιδιοτήτων για τη διευκόλυνση της διαχείρισης και του χειρισμού των εγγράφων του LibreOffice.

Η υπηρεσία SFDocuments.Calc είναι μια υποκατηγορία της υπηρεσίας SFDocuments.Document . Όλες οι μέθοδοι και οι ιδιότητες που ορίζονται για την υπηρεσία Document μπορούν επίσης να προσπελαστούν χρησιμοποιώντας μια παρουσία υπηρεσίας Calc.

Η υπηρεσία Calc επικεντρώνεται σε:

- Χειρισμός φύλλων σε έγγραφο Calc (αντιγραφή, εισαγωγή, μετακίνηση κ.λπ.)

- Ανταλλαγή δεδομένων μεταξύ δομών δεδομένων Basic και περιοχών Calc

- Αντιγραφή και εισαγωγή μαζικών ποσοτήτων δεδομένων

## Υπηρεσία ScriptForge.Γράφημα

Η υπηρεσία Chart παρέχει ένα σύνολο ιδιοτήτων και μεθόδων χειρισμού γραφημάτων σε έγγραφα Calc. Με αυτήν την υπηρεσία είναι δυνατό να:

- Να προσπελάσετε σε αντικείμενα γραφήματος σε έγγραφα Calc και να χειριστείτε τις ιδιοτήτες τους.

- Να δημιουργήσετε και να εισαγάγετε νέα γραφήματα σε ένα έγγραφο Calc.

- Να εξάγετε γραφημάτα ως αρχεία εικόνας.

## SFDatabases.Database service

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.

## 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

- The key is a case-insensitive string

- Items may be of any type

## SFDocuments.Document service

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

## 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:

- 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.

## 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:

- 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.

## 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:

- 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.

## 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:

- 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.

## ScriptForge.Platform service

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 LibreOffice version

- The current user name

## ScriptForge.PopupMenu service

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.

## ScriptForge.Services service

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.

## ScriptForge.Session service

The Session service gathers various general-purpose methods about:

- the installation or execution environment

- UNO introspection

- the invocation of external scripts or programs

## ScriptForge.String service

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.

## 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

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.

## ScriptForge.UI service

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

- Windows selection

- Windows moving and resizing

- Statusbar settings

- Display of a floating progress bar

- Creation of new windows

- Access to the underlying "documents"

Σημείωση: Άλλες μη περιγραφόμενες λειτουργικές μονάδες ScriptForge προορίζονται για εσωτερική χρήση. Το περιεχόμενό τους υπόκειται σε αλλαγές χωρίς προειδοποίηση.

Όλες οι ρουτίνες ή αναγνωριστικά του ScriptForge στη Basic που έχουν το πρόθεμα χαρακτήρα υπογράμμισης "_" δεσμεύονται για εσωτερική χρήση. Δεν προορίζονται να χρησιμοποιηθούν σε μακροεντολές Basic ή σενάρια Python.