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

Αυτή η υπηρεσία είναι διαθέσιμη από το LibreOffice 7.2 και μετά.


Typical example:


   svc.MsgBox('This has to be displayed in a message box')
  
warning

ScriptForge.Basic service is limited to Python scripts.


Service invocation

Before using the Basic service, import the CreateScriptService() method from the scriptforge module:


    from scriptforge import CreateScriptService
    svc = CreateScriptService("Basic")
  

Properties

Name

ReadOnly

Type

Description

MB_OK, MB_OKCANCEL, MB_RETRYCANCEL, MB_YESNO, MB_YESNOCANCEL

Yes

integer

Values: 0, 1, 5, 4, 3

MB_ICONEXCLAMATION, MB_ICONINFORMATION, MB_ICONQUESTION, MB_ICONSTOP

Yes

integer

Values: 48, 64, 32, 16

MB_ABORTRETRYIGNORE, MB_DEFBUTTON1, MB_DEFBUTTON2, MB_DEFBUTTON3

Yes

integer

Values: 2, 128, 256, 512

IDABORT, IDCANCEL, IDIGNORE, IDNO, IDOK, IDRETRY, IDYES

Yes

integer

Values: 3, 2, 5, 7, 1, 4, 6
Constants indicating MsgBox selected button.

StarDesktop

Yes

UNO
object

StarDesktop object represents LibreOffice Start Center.


List of Methods in the Basic Service

CDate
CDateFromUnoDateTime
CDateToUnoDateTime
ConvertFromUrl
ConvertToUrl
CreateUnoService
DateAdd
DateDiff
DatePart

DateValue
Format
GetDefaultContext
GetGuiType
GetPathSeparator
GetSystemTicks
GlobalScope.BasicLibraries
GlobalScope.DialogLibraries
InputBox

MsgBox
Now
RGB
ThisComponent
ThisDatabaseDocument
Xray




CDate

Converts a numeric expression or a string to a datetime.datetime Python native object.

note

This method exposes the Basic builtin function CDate to Python scripts.


Σύνταξη:

svc.CDate(expression: any): obj

Παράμετροι:

expression: a numeric expression or a string representing a date.

Όταν μετατρέπετε έκφραση συμβολοσειράς, η ημερομηνία και η ώρα πρέπει να εισέρχονται είτε σε ένα από τα μοτίβα αποδοχής ημερομηνίας που ορίστηκαν στις τοπικές σας ρυθμίσεις (δείτε - Ρυθμίσεις γλώσσας - Γλώσσες) ή σε μορφή ημερομηνίας ISO (προς το παρόν, μόνο η μορφή ISO με ενωτικά, π.χ. "31-12-2012" είναι αποδεκτή). Στις αριθμητικές εκφράσεις, οι τιμές στα αριστερά του δεκαδικού αναπαριστούν την ημερομηνία, με έναρξη 31 Δεκεμβρίου 1899. Οι τιμές στα δεξιά του δεκαδικού αναπαριστούν την ώρα.

Παράδειγμα:


    d = svc.CDate(1000.25)
    svc.MsgBox(str(d)) # 1902-09-26 06:00:00
    svc.MsgBox(d.year) # 1902
  

CDateFromUnoDateTime

Converts a UNO date/time representation to a datetime.datetime Python native object.

Σύνταξη:

svc.CDateFromUnoDateTime(unodate: uno): obj

Παράμετροι:

unodate: A UNO date/time object of one of the following types: com.sun.star.util.DateTime, com.sun.star.util.Date or com.sun.star.util.Time

Παράδειγμα:

The following example creates a com.sun.star.util.DateTime object and converts it to a datetime.datetime Python object.


    import uno
    uno_date = uno.createUnoStruct('com.sun.star.util.DateTime')
    uno_date.Year = 1983
    uno_date.Month = 2
    uno_date.Day = 23
    new_date = svc.CDateFromUnoDateTime(uno_date)
    svc.MsgBox(str(new_date)) # 1983-02-23 00:00:00
  

CDateToUnoDateTime

Converts a date representation into a com.sun.star.util.DateTime object.

Σύνταξη:

svc.CDateToUnoDateTime(date: obj): uno

Παράμετροι:

date: A Python date/time object of one of the following types: datetime.datetime, datetime.date, datetime.time, float (time.time) or time.struct_time.

Παράδειγμα:


    from datetime import datetime
    current_datetime = datetime.now()
    uno_date = svc.CDateToUnoDateTime(current_datetime)
    svc.MsgBox(str(uno_date.Year) + "-" + str(uno_date.Month) + "-" + str(uno_date.Day))
  

ConvertFromUrl

Returns a system path file name for the given file: URL.

Σύνταξη:

svc.ConvertFromUrl(url: str): str

Παράμετροι:

url: An absolute file: URL.

Επιστρεφόμενη τιμή:

A system path file name.

Παράδειγμα:


    filename = svc.ConvertFromUrl( "file:///C:/Program%20Files%20(x86)/LibreOffice/News.txt")
    svc.MsgBox(filename)
  

ConvertToUrl

Returns a file: URL for the given system path.

Σύνταξη:

svc.ConvertToUrl(systempath: str): str

Παράμετροι:

systempath: A system file name as a string.

Επιστρεφόμενη τιμή:

A file: URL as a string.

Παράδειγμα:


    url = svc.ConvertToUrl( 'C:\Program Files(x86)\LibreOffice\News.txt')
    svc.MsgBox(url)
  

CreateUnoService

Instantiates a UNO service with the ProcessServiceManager.

Σύνταξη:

svc.CreateUnoService(servicename: str): uno

Παράμετροι:

servicename : A fully qualified service name such as "com.sun.star.ui.dialogs.FilePicker" or 'com.sun.star.sheet.FunctionAccess'.

Παράδειγμα:


    dsk = svc.CreateUnoService('com.sun.star.frame.Desktop')
  

DateAdd

Adds a date or time interval to a given date/time a number of times and returns the resulting date.

Σύνταξη:

svc.DateAdd(interval: str, number: num, date: datetime): datetime

Παράμετροι:

interval: A string expression from the following table, specifying the date or time interval.

interval (τιμή συμβολοσειράς)

Εξήγηση

yyyy

Έτος

q

Τέταρτο

m

Μήνας

y

Ημέρα του έτους

w

Μέρα της εβδομάδος

ww

Εβδομάδα του έτους

d

Μέρα

h

Ώρα

n

Λεπτά

s

Δευτερόλεπτά


number: A numerical expression specifying how often the interval value will be added when positive or subtracted when negative.

date: A given datetime.datetime value, the interval value will be added number times to this date/time value.

Επιστρεφόμενη τιμή:

A datetime.datetime value.

Παράδειγμα:


    dt = datetime.datetime(2004, 1, 31)
    dt = svc.DateAdd("m", 1, dt)
    print(dt)
  

DateDiff

Returns the number of date or time intervals between two given date/time values.

Σύνταξη:

svc.DateDiff(interval: str, date1: datetime, date2: datetime, firstdayofweek = 1, firstweekofyear = 1): int

Παράμετροι:

interval: A string expression specifying the date interval, as detailed in above DateAdd method.

date1, date2: The two datetime.datetime values to be compared.

firstdayofweek: Μια προαιρετική παράμετρος που καθορίζει την ημέρα έναρξης μιας εβδομάδας.

τιμή firstdayofweek

Εξήγηση

0

Χρήση προκαθορισμένων τιμών συστήματος

1

Κυριακή (προεπιλογή)

2

Δευτέρα

3

Τρίτη

4

Τετάρτη

5

Πέμπτη

6

Παρασκευή

7

Σάββατο


firstweekofyear: Μια προαιρετική παράμετρος που καθορίζει την εβδομάδα έναρξης ενός έτους.

τιμή firstweekofyear

Εξήγηση

0

Χρήση προκαθορισμένων τιμών συστήματος

1

Η εβδομάδα 1 είναι η εβδομάδα με την 1η Ιανουαρίου, (προεπιλογή)

2

Η εβδομάδα 1 είναι η πρώτη εβδομάδα που περιέχει τέσσερις ή περισσότερες ημέρες εκείνου του έτους

3

Η εβδομάδα 1 η πρώτη εβδομάδα περιέχει μόνο ημέρες του νέου έτους


Επιστρεφόμενη τιμή:

A number.

Παράδειγμα:


    date1 = datetime.datetime(2005,1, 1)
    date2 = datetime.datetime(2005,12,31)
    diffDays = svc.DateDiff('d', date1, date2)
    print(diffDays)
  

DatePart

The DatePart function returns a specified part of a date.

Σύνταξη:

svc.DatePart(interval: str, date: datetime, firstdayofweek = 1, firstweekofyear = 1): int

Παράμετροι:

interval: A string expression specifying the date interval, as detailed in above DateAdd method.

date: The date/time from which the result is calculated.

firstdayofweek, firstweekofyear: optional parameters that respectively specify the starting day of a week and the starting week of a year, as detailed in above DateDiff method.

Επιστρεφόμενη τιμή:

The extracted part for the given date/time.

Παράδειγμα:


    print(svc.DatePart("ww", datetime.datetime(2005,12,31)
    print(svc.DatePart('q', datetime.datetime(1999,12,30)
  

DateValue

Computes a date value from a date string.

Σύνταξη:

svc.DateValue(date: str): datetime

Παράμετροι:

Date (Ημερομηνία): Έκφραση συμβολοσειράς που περιέχει την ημερομηνία που θέλετε να υπολογίσετε. Σε αντίθεση με τη συνάρτηση DateSerial που περνά χρόνια, μήνες και ημέρες ως ξεχωριστές αριθμητικές τιμές, η συνάρτηση DateValue ζητά η συμβολοσειρά ημερομηνίας να είναι σύμφωνη με ένα από τα μοτίβα αποδοχής ημερομηνίας που ορίζονται για τη ρύθμιση τοπικών ρυθμίσεων (δείτε - Ρυθμίσεις γλώσσας - Γλώσσες) ή σε μορφή ημερομηνίας ISO (προς το παρόν, γίνεται αποδεκτή μόνο η μορφή ISO με παύλες, π.χ. "2012-12-31").

Επιστρεφόμενη τιμή:

The computed date.

Παράδειγμα:


    dt = svc.DateValue("23-02-2011")
    print(dt)
  

Format

Converts a number to a string, and then formats it according to the format that you specify.

Σύνταξη:

svc.Format(expression: any, format = ''): str

Παράμετροι:

expression (έκφραση): Αριθμητική έκφραση που θέλετε να μετατρέψετε σε μορφοποιημένη συμβολοσειρά.

format (μορφή): Συμβολοσειρά που καθορίζει τον κωδικό μορφής για τον αριθμό. Εάν η format παραλειφθεί, η συνάρτηση Format λειτουργεί όπως η συνάρτηση LibreOffice Basic Str().

Επιστρεφόμενη τιμή:

Συμβολοσειρά κειμένου.

Formatting Codes

Ο παρακάτω κατάλογος περιγράφει τους κωδικούς που μπορείτε να χρησιμοποιήσετε για τη μορφοποίηση μιας αριθμητικής παράστασης:

0: Εάν η expression έχει ένα ψηφίο στη θέση του 0 στον κωδικό format, το ψηφίο εμφανίζεται, διαφορετικά εμφανίζεται ένα μηδέν.

Εάν η expression έχει λιγότερα ψηφία από τον αριθμό των μηδενικών στον κωδικό format, (και στις δύο πλευρές του δεκαδικού), εμφανίζονται μηδενικά στην αρχή ή στο τέλος. Εάν η expression έχει περισσότερα ψηφία στα αριστερά του δεκαδικού διαχωριστικού από το ποσό των μηδενικών στον κωδικό format, τα πρόσθετα ψηφία εμφανίζονται χωρίς μορφοποίηση.

Οι δεκαδικοί θέσεις στην expression στρογγυλοποιούνται σύμφωνα με τον αριθμό των μηδενικών που εμφανίζονται μετά το δεκαδικό διαχωριστικό στον κώδικα format.

#: Εάν η expression περιέχει ένα ψηφίο στη θέση του σύμβολο κράτησης θέσης # στον κωδικό format, το ψηφίο εμφανίζεται, διαφορετικά δεν εμφανίζεται τίποτα σε αυτήν τη θέση.

Αυτό το σύμβολο λειτουργεί όπως το 0, εκτός από το ότι τα μηδενικά στην αρχή ή στο τέλος δεν εμφανίζονται εάν υπάρχουν περισσότεροι # χαρακτήρες στον κωδικό format από ψηφία στην expression. Εμφανίζονται μόνο τα σχετικά ψηφία της expression.

.: Το δεκαδικό σύμβολο κράτησης θέσης καθορίζει το πλήθος των δεκαδικών ψηφίων δεξιά και αριστερά της υποδιαστολής.

Εάν ο κωδικός format περιέχει μόνο # σύμβολα κράτησης θέσης στα αριστερά αυτού του συμβόλου, οι αριθμοί που είναι μικρότεροι από 1 ξεκινούν με δεκαδικό διαχωριστικό. Για να εμφανίζεται πάντα ένα μηδενικό στην αρχή με κλασματικούς αριθμούς, χρησιμοποιήστε το 0 ως σύμβολο κράτησης θέσης για το πρώτο ψηφίο στα αριστερά του δεκαδικού διαχωριστικού.

%: Πολλαπλασιάζει την expressionεπί 100 και εισάγει το σύμβολο ποσοστού (%) όπου η expression εμφανίζεται στον κώδικα format.

E- E+ e- e+ : Εάν ο κώδικας format περιέχει τουλάχιστον ένα σύμβολο κράτησης θέσης ψηφίου (0 ή #) στα δεξιά του συμβόλου E-, E+, e-, ή e+, η expression (έκφραση) μορφοποιείται σε επιστημονική ή εκθετική μορφή. Το γράμμα E ή e παρεμβάλλεται μεταξύ του αριθμού και του εκθέτη. Ο αριθμός των δεσμευτικών θέσης για ψηφία στα δεξιά του συμβόλου καθορίζει τον αριθμό των ψηφίων στον εκθέτη.

Αν ο εκθέτης είναι αρνητικός, εμφανίζεται ένα αρνητικό πρόσημο μπροστά από έναν εκθέτη με E-, E+, e-, e+. Αν ο εκθέτης είναι θετικός, τότε εμφανίζεται θετικό πρόσημο μόνο μπροστά από εκθέτες με E+ ή e+.

Ο οριοθέτης χιλιάδων εμφανίζεται εάν ο κωδικός format (μορφή) περιέχει τον οριοθέτη που περικλείεται από σύμβολα κράτησης θέσης ψηφίων (0 ή #).

Η χρήση της τελείας ως διαχωριστικού χιλιάδων και υποδιαστολής εξαρτάται από τις τοπικές ρυθμίσεις του συστήματός σας. Όταν εισάγετε έναν αριθμό άμεσα στο πηγαίο κώδικα της Basic, χρησιμοποιείτε πάντα μια τελεία ως υποδιαστολή. Ο χαρακτήρας που εμφανίζεται στην πραγματικότητα ως υποδιαστολή εξαρτάται από την μορφή του αριθμού στις τοπικές σας ρυθμίσεις. Τα παραδείγματα που παρουσιάζονται εδώ υποθέτουν ότι οι τοπικές ρυθμίσεις είναι US (Η.Π.Α.).

- + $ ( ) space: (διάστημα) Ένα συν (+), μείον (-), δολάριο ($), κενό διάστημα ή αγκύλες που εισάγονται απευθείας στον κώδικα format (μορφή) εμφανίζονται ως ένας κυριολεκτικός χαρακτήρας.

Για την εμφάνιση χαρακτήρων που δεν αναφέρονται σε αυτή τη λίστα, θα πρέπει να προηγείται του χαρακτήρα μια ανάστροφη κάθετος (\), ή να περικλείεται σε αγγλικά εισαγωγικά (" ").

\ : Η ανάστροφη κάθετος εμφανίζει τον επόμενο χαρακτήρα στον κώδικα format (μορφή).

Οι χαρακτήρες στον κώδικα format (μορφή) που έχουν ειδική σημασία μπορούν να εμφανίζονται ως κυριολεκτικοί χαρακτήρες μόνο εάν προηγείται ανάστροφη κάθετος. Η ίδια η ανάστροφη κάθετος δεν εμφανίζεται, εκτός εάν εισαγάγετε διπλή κάθετο (\\) στον κώδικα μορφής.

Οι χαρακτήρες μπροστά από τους οποίους θα πρέπει να υπάρχει μια ανάστροφη κάθετος στον κώδικα μορφής ώστε να εμφανίζονται ως ρητοί χαρακτήρες είναι οι χαρακτήρες ημερομηνίας και χρόνου (a, c, d, h, m, n, p, q, s, t, w, y, /, :), οι χαρακτήρες αριθμητικής μορφοποίησης (#, 0, %, E, e, κόμμα, τελεία) και οι χαρακτήρες μορφοποίησης συμβολοσειράς (@, &, <, >, !).

Μπορείτε επίσης να χρησιμοποιήσετε τις ακόλουθες προκαθορισμένες μορφές αριθμών. Εκτός από τον "General Number" (Γενικό αριθμό), όλοι οι προκαθορισμένοι κώδικες μορφής επιστρέφουν τον αριθμό ως δεκαδικό αριθμό με δύο δεκαδικά ψηφία.

Αν χρησιμοποιείτε προκαθορισμένες μορφές, το όνομα της μορφής θα πρέπει να περικλείεται σε αγγλικά εισαγωγικά.

Predefined Formats

General Number: Οι αριθμοί εμφανίζονται όπως έχουν εισαχθεί.

Currency: Μπροστά από τον αριθμό τοποθετείται ένα σύμβολο δολαρίου. Οι αρνητικό αριθμοί περικλείονται σε παρενθέσεις.

Fixed: Εμφανίζεται τουλάχιστον ένα ψηφίο μπροστά από την υποδιαστολή.

Standard: Εμφανίζει αριθμούς με διαχωριστικό χιλιάδων.

Percent: Ο αριθμός πολλαπλασιάζεται επί 100 και στον αριθμό προστίθεται ένα ποσοστιαίο σύμβολο.

Scientific: Εμφανίζει αριθμούς σε εκθετική μορφή (π.χ. 1,00E+03 για 1000).

Ένας κώδικας format (μορφή) μπορεί να χωριστεί σε τρεις ενότητες που χωρίζονται με ;. Το πρώτο μέρος ορίζει τη μορφή για τις θετικές τιμές, το δεύτερο μέρος για τις αρνητικές τιμές και το τρίτο μέρος για το μηδέν. Εάν καθορίσετε μόνο έναν κώδικα format (μορφής), ισχύει για όλους τους αριθμούς.

Μπορείτε να ορίσετε τις χρησιμοποιούμενες τοπικές ρυθμίσεις για έλεγχο μορφοποίησης αριθμών, ημερομηνιών και νομισμάτων στο LibreOffice Basic στο - Ρυθμίσεις γλώσσας - Γλώσσες. Σε κωδικούς μορφοποίησης Basic, το δεκαδικό σημείο (.) χρησιμοποιείται πάντοτε ως δεσμευτικό θέσης για τον καθορισμένο διαχωριστή δεκαδικών στις τοπικές σας ρυθμίσεις και θα αντικατασταθεί από τον αντίστοιχο χαρακτήρα.

Το ίδιο ισχύει και για τις τοπικές ρυθμίσεις για την μορφή της ημερομηνίας, ώρας και νομίσματος. Ο κώδικας μορφοποίησης της Basic θα ερμηνευθεί και θα εμφανισθεί σύμφωνα με τις τοπικές ρυθμίσεις σας.

Παράδειγμα:


    txt = svc.Format(6328.2, '##.##0.00')
    print(txt)
  

GetDefaultContext

Returns the default context of the process service factory, if existent, else returns a null reference.

GetDefaultContext is an alternative to the getComponentContext() method available from XSCRIPTCONTEXT global variable or from uno.py module.

Σύνταξη:

svc.GetDefaultContext(): uno

Επιστρεφόμενη τιμή:

The default component context is used, when instantiating services via XMultiServiceFactory. See the Professional UNO chapter in the Developer's Guide on api.libreoffice.org for more information.

Παράδειγμα:


    ctx = svc.GetDefaultContext()
  

GetGuiType

Returns a numerical value that specifies the graphical user interface. This function is only provided for backward compatibility with previous versions.

Refer to system() method from platform Python module to identify the operating system.

Σύνταξη:

svc.GetGuiType(): int

Παράδειγμα:


    n = svc.GetGuiType()
  

GetPathSeparator

Returns the operating system-dependent directory separator used to specify file paths.

Use os.pathsep from os Python module to identify the path separator.

Σύνταξη:

svc.GetPathSeparator(): str


    svc.GetPathSeparator(): str
  

Παράδειγμα:


    sep = svc.GetPathSeparator()
  

GetSystemTicks

Returns the number of system ticks provided by the operating system. You can use this function to optimize certain processes. Use this method to estimate time in milliseconds:

Σύνταξη:

svc.GetSystemTicks(): int

Παράδειγμα:


    ticks_ini = svc.GetSystemTicks()
    time.sleep(1)
    ticks_end = svc.GetSystemTicks()
    svc.MsgBox("{} - {} = {}".format(ticks_end, ticks_ini,ticks_end - ticks_ini))
  

GlobalScope.BasicLibraries

Returns the UNO object containing all shared Basic libraries and modules.

This method is the Python equivalent to GlobalScope.BasicLibraries in Basic scripts.

Σύνταξη:

svc.GlobalScope.BasicLibraries(): uno

Επιστρεφόμενη τιμή:

com.sun.star.script.XLibraryContainer

Παράδειγμα:

The following example loads the Gimmicks Basic library if it has not been loaded yet.


    libs = svc.GlobalScope.BasicLibraries()
    if not libs.isLibraryLoaded("Gimmicks"):
        libs.loadLibrary("Gimmicks")
  

GlobalScope.DialogLibraries

Returns the UNO object containing all shared dialog libraries.

This method is the Python equivalent to GlobalScope.DialogLibraries in Basic scripts.

Σύνταξη:

svc.GlobalScope.DialogLibraries(): uno

Επιστρεφόμενη τιμή:

com.sun.star.comp.sfx2.DialogLibraryContainer

Παράδειγμα:

The following example shows a message box with the names of all available dialog libraries.


    dlg_libs = svc.GlobalScope.DialogLibraries()
    lib_names = dlg_libs.getElementNames()
    svc.MsgBox("\n".join(lib_names))
  

InputBox

Σύνταξη:

svc.InputBox(prompt: str, [title: str], [default: str], [xpostwips: int, ypostwips: int]): str

Παράμετροι:

prompt (προτροπή): Η έκφραση συμβολοσειράς εμφανίζεται ως μήνυμα στο πλαίσιο διαλόγου.

title (τίτλος): Έκφραση συμβολοσειράς που εμφανίζεται στη γραμμή τίτλου του πλαισίου διαλόγου.

default (προεπιλογή): Η έκφραση συμβολοσειράς που εμφανίζεται στο πλαίσιο κειμένου ως προεπιλογή εάν δεν δοθεί άλλη είσοδος.

xpostwips: Παράσταση ακέραιου αριθμού που καθορίζει την οριζόντια θέση του διαλόγου. Η θέση είναι απόλυτη συντεταγμένη και δεν αναφέρεται στο παράθυρο του LibreOffice.

ypostwips: Παράσταση ακέραιου αριθμού που καθορίζει την κατακόρυφη θέση του διαλόγου. Η θέση είναι απόλυτη συντεταγμένη και δεν αναφέρεται στο παράθυρο του LibreOffice.

Εάν παραληφθούν τα xpostwips και ypostwips, το παράθυρο διαλόγου κεντράρεται στην οθόνη. Η θέση καθορίζεται στο twips.

Επιστρεφόμενη τιμή:

string

Παράδειγμα:


    txt = s.InputBox('Please enter a phrase:', "Dear user")
    s.MsgBox(txt, MB_ICONINFORMATION, "Confirmation of phrase")
  
note

For in-depth information please refer to Input/Output to Screen with Python on the Wiki.


MsgBox

Displays a dialog box containing a message and returns an optional value.
MB_xx constants help specify the dialog type, the number and type of buttons to display, plus the icon type. By adding their respective values they form bit patterns, that define the MsgBox dialog appearance.

Σύνταξη:

svc.MsgBox(prompt: str, [buttons: int], [title: str])[: int]

Παράμετροι:

prompt (προτροπή): Η έκφραση συμβολοσειράς εμφανίζεται ως μήνυμα στο πλαίσιο διαλόγου. Οι αλλαγές γραμμής μπορούν να εισαχθούν με το Chr$(13).

title (τίτλος): Έκφραση συμβολοσειράς που εμφανίζεται στη γραμμή τίτλου του διαλόγου. Εάν παραλειφθεί, η γραμμή τίτλου εμφανίζει το όνομα της αντίστοιχης εφαρμογής.

buttons (πλήκτρα): Οποιαδήποτε ακέραια έκφραση που καθορίζει τον τύπο διαλόγου, καθώς και τον αριθμό και τον τύπο των πλήκτρων που θα εμφανίζονται και τον τύπο εικονιδίου. Τα buttons αντιπροσωπεύουν έναν συνδυασμό μοτίβων bit, δηλαδή, ένας συνδυασμός στοιχείων μπορεί να οριστεί προσθέτοντας τις αντίστοιχες τιμές τους:

Επιστρεφόμενη τιμή:

An optional integer as detailed in above IDxx properties.

Παράδειγμα:


    txt = s.InputBox('Please enter a phrase:', "Dear user")
    s.MsgBox(txt, MB_ICONINFORMATION, "Confirmation of phrase")
  
note

For in-depth information please refer to Input/Output to Screen with Python on the Wiki.


Now

Returns the current system date and time as a datetime.datetime Python native object.

Σύνταξη:

svc.Now(): datetime

Παράδειγμα:


    svc.MsgBox(svc.Now(), svc.MB_OK, "Now")
  

RGB

Returns an integer color value consisting of red, green, and blue components.

Σύνταξη:

svc.RGB(red:int, green: int, blue: int): int

Παράμετροι:

red (κόκκινο): Οποιαδήποτε ακέραια παράσταση που αντιπροσωπεύει το κόκκινο συστατικό (0-255) του σύνθετου χρώματος.

green (πράσινο): Οποιαδήποτε ακέραια παράσταση που αντιπροσωπεύει το πράσινο στοιχείο (0-255) του σύνθετου χρώματος.

blue (γαλάζιο): Οποιαδήποτε ακέραια παράσταση που αντιπροσωπεύει το μπλε στοιχείο (0-255) του σύνθετου χρώματος.

tip

Ο διάλογος επιλογέα χρώματος βοηθά τον υπολογισμό του κόκκινου, πράσινου και του γαλάζιου συστατικού σύνθετου χρώματος. Η Αλλαγή χρώματος κειμένου και η επιλογή Προσαρμοσμένου χρώματος εμφανίζει τον διάλογο επιλογέα χρώματος.


Επιστρεφόμενη τιμή:

integer

Παράδειγμα:


    YELLOW = svc.RGB(255,255,0)
  

ThisComponent

If the current component refers to a LibreOffice document, this method returns the UNO object representing the document.

The method will return None when the current component does not correspond to a document.

Σύνταξη:

svc.ThisComponent(): uno

Παράδειγμα:


    comp = svc.ThisComponent
    svc.MsgBox("\n".join(comp.getSupportedServiceNames()))
  

ThisDatabaseDocument

If the script is being executed from a Base document or any of its subcomponents this method returns the main component of the Base instance.

This method returns None otherwise.

Σύνταξη:

svc.ThisDatabaseDocument(): uno

Παράδειγμα:


    db_doc = svc.ThisDatabaseDocument
    table_names = db_doc.DataSource.getTables().getElementNames()
    bas.MsgBox("\n".join(table_names))
  
tip

Visit the OfficeDatabaseDocument API page to learn more about Base's main component structure.


Xray

Inspect Uno objects or variables.

Σύνταξη:

svc.Xray(obj: any)

Παράμετροι:

obj: A variable or Uno object.

Παράδειγμα:


    svc.Xray(svc.StarDesktop)
  
warning

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