Pustaka ScriptForge

Untuk mengakses fungsi ini...

Open Tools - Macros - LibreOffice Basic - Edit and select Application Macros container.


Pustaka ScriptForge membangun kumpulan sumber skrip makro yang dapat diperluas untuk LibreOffice yang akan dipanggil dari makro dasar atau skrip Python.

note

• Makro dasar perlu dimuat ScriptForge pustaka menggunakan pernyataan berikut:
GlobalScope.BasicLibraries.loadLibrary("ScriptForge")

• Skrip python memerlukan impor dari modul scriptforge:
from scriptforge import CreateScriptService


tip

Untuk mempelajari lebih lanjut tentang cara membuat dan menjalankan skrip Python menggunakan pustaka ScriptForge, baca halaman bantuan Membuat Script Python dengan ScriptForge.


Meminta layanan ScriptForge

Modul dan kelas yang dijelaskan dipanggil dari skrip pengguna sebagai "Layanan". Konstruktor generik dari layanan tersebut telah dirancang untuk tujuan itu untuk setiap bahasa.

Metode Dispose tersedia dalam semua layanan dan bisa dipanggil untuk membebaskan sumber daya setelah penggunaan:

In Basic

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

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

Layanan yang disediakan oleh pustaka ScriptForge

Kategori

Layanan

dasar LibreOffice

Array
Dictionary

Exception
FileSystem

String
TextStream

Isi Dokumen

Base
Calc

Chart
Database

Document
Writer

Antarmuka pengguna

Dialog
DialogControl
Form

FormControl
Menu

PopupMenu
UI

Utilitas

Basic
L10N
Platform

Region
Services
Session

Timer
UnitTest


ScriptForge.Layanan larik

Menyediakan kumpulan metode untuk memanipulasi dan mengubah larik satu dimensi (vektor) dan larik dua dimensi (matriks). Ini termasuk mengatur operasi, menyortir, mengimpor dari dan mengekspor ke berkas teks.

Larik dengan lebih dari dua dimensi tidak dapat digunakan dengan metode dalam layanan ini, satu-satunya pengecualian adalah metode CountDims yang menerima Larik dengan sejumlah dimensi.

SFDocuments.Base service

The Base service provides a number of methods and properties to facilitate the management and handling of LibreOffice Base documents.

This service is closely related to the Document service, which provides generic methods for handling LibreOffice documents, including Base documents. Hence, the Base service extends the Document service and provides additional methods that are specific for Base documents, enabling users to:

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.

SFDocuments.Calc service

The SFDocuments shared library provides a number of methods and properties to facilitate the management and handling of LibreOffice documents.

The SFDocuments.Calc service is a subclass of the SFDocuments.Document service. All methods and properties defined for the Document service can also be accessed using a Calc service instance.

The Calc service is focused on:

SFDocuments.Chart service

The Chart service provides a set of properties and methods to handle charts in Calc documents. With this service it is possible to:

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

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:

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:

SFWidgets.Menu service

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:

ScriptForge.Platform service

The Platform service provides a collection of properties about the current execution environment and context, such as:

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

ScriptForge.Region service

The Region service provides a collection of properties and methods to handle locale and region-related aspects of programming, such as:

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:

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

The Timer service measures the amount of time it takes to run user scripts.

A Timer measures durations. It can be:

ScriptForge.UI service

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

SFUnitTests.UnitTest service

The UnitTest service provides a framework for automating unit tests using the Basic language, including the ability to:

SFDocuments.Writer service

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.

Catatan: Modul ScriptForge lainnya yang belum dijelaskan dicadangkan untuk penggunaan internal. Konten mereka dapat berubah tanpa pemberitahuan.

warning

Semua Basic routines atau identifiers dalam ScriptForge yang diawali dengan karakter garis bawah "_" adalah untuk penggunaan internal. Mereka tidak dimaksudkan untuk digunakan dalam makro dasar atau skrip Python.


Mohon dukung kami!