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

Aquest servei està disponible a partir de la versió 7.2 del LibreOffice.


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

Descripció

MB_OK, MB_OKCANCEL, MB_RETRYCANCEL, MB_YESNO, MB_YESNOCANCEL

enter

Valors: 0, 1, 5, 4, 3

MB_ICONEXCLAMATION, MB_ICONINFORMATION, MB_ICONQUESTION, MB_ICONSTOP

enter

Valors: 48, 64, 32, 16

MB_ABORTRETRYIGNORE, MB_DEFBUTTON1, MB_DEFBUTTON2, MB_DEFBUTTON3

enter

Valors: 2, 128, 256, 512

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

enter

Valors: 3, 2, 5, 7, 1, 4, 6
Constants que indiquen el botó seleccionat del MsgBox.

StarDesktop

Objecte
UNO

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.


Sintaxi:

svc.CDate(expression: any): obj

Paràmetres:

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

When you convert a string expression, the date and time must be entered either in one of the date acceptance patterns defined for your locale setting (see - Language Settings - Languages) or in ISO date format (momentarily, only the ISO format with hyphens, e.g. "2012-12-31" is accepted). In numeric expressions, values to the left of the decimal represent the date, beginning from December 31, 1899. Values to the right of the decimal represent the time.

Exemple:


    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.

Sintaxi:

svc.CDateFromUnoDateTime(unodate: uno): obj

Paràmetres:

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

Exemple:

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.

Sintaxi:

svc.CDateToUnoDateTime(date: obj): uno

Paràmetres:

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.

Exemple:


    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.

Sintaxi:

svc.ConvertFromUrl(url: str): str

Paràmetres:

url: An absolute file: URL.

Valor de retorn:

A system path file name.

Exemple:


    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.

Sintaxi:

svc.ConvertToUrl(systempath: str): str

Paràmetres:

systempath: A system file name as a string.

Valor de retorn:

A file: URL as a string.

Exemple:


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

CreateUnoService

Instantiates a UNO service with the ProcessServiceManager.

Sintaxi:

svc.CreateUnoService(servicename: str): uno

Paràmetres:

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

Exemple:


    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.

Sintaxi:

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

Paràmetres:

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

interval (string value)

Explicació

yyyy

Any

q

Trimestre

m

Mes

y

Dia de l'any

w

Dia feiner

ww

Setmana de l'any

d

Dia

h

Hora

n

Minut

s

Segon


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.

Valor de retorn:

A datetime.datetime value.

Exemple:


    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.

Sintaxi:

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

Paràmetres:

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: An optional parameter that specifies the starting day of a week.

firstdayofweek value

Explicació

0

Utilitza el valor per defecte del sistema

1

Diumenge (per defecte)

2

Dilluns

3

Dimarts

4

Dimecres

5

Dijous

6

Divendres

7

Dissabte


firstweekofyear: An optional parameter that specifies the starting week of a year.

firstweekofyear value

Explicació

0

Utilitza el valor per defecte del sistema

1

La setmana 1 és la setmana de l'1 de gener (per defecte)

2

La setmana 1 és la primera setmana que conté quatre dies o més d'aquell any

3

La setmana 1 és la primera setmana que només conté dies de l'any nou


Valor de retorn:

A number.

Exemple:


    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.

Sintaxi:

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

Paràmetres:

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.

Valor de retorn:

The extracted part for the given date/time.

Exemple:


    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.

Sintaxi:

svc.DateValue(date: str): datetime

Paràmetres:

Date: String expression that contains the date that you want to calculate. In contrast to the DateSerial function that passes years, months and days as separate numeric values, the DateValue function requests the date string to be according to either one of the date acceptance patterns defined for your locale setting (see - Language Settings - Languages) or to ISO date format (momentarily, only the ISO format with hyphens, e.g. "2012-12-31" is accepted).

Valor de retorn:

The computed date.

Exemple:


    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.

Sintaxi:

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

Paràmetres:

expression: Numeric expression that you want to convert to a formatted string.

format: String that specifies the format code for the number. If format is omitted, the Format function works like the LibreOffice Basic Str() function.

Valor de retorn:

Text string.

Codis de formatació

The following list describes the codes that you can use for formatting a numeric expression:

0: If expression has a digit at the position of the 0 in the format code, the digit is displayed, otherwise a zero is displayed.

If expression has fewer digits than the number of zeros in the format code, (on either side of the decimal), leading or trailing zeros are displayed. If the expression has more digits to the left of the decimal separator than the amount of zeros in the format code, the additional digits are displayed without formatting.

Decimal places in the expression are rounded according to the number of zeros that appear after the decimal separator in the format code.

#: If expression contains a digit at the position of the # placeholder in the format code, the digit is displayed, otherwise nothing is displayed at this position.

This symbol works like the 0, except that leading or trailing zeroes are not displayed if there are more # characters in the format code than digits in the expression. Only the relevant digits of the expression are displayed.

,: El marcador decimal determina el nombre de llocs decimals a l'esquerra i a la dreta del separador decimal.

If the format code contains only # placeholders to the left of this symbol, numbers less than 1 begin with a decimal separator. To always display a leading zero with fractional numbers, use 0 as a placeholder for the first digit to the left of the decimal separator.

%: Multiplies the expressionby 100 and inserts the percent sign (%) where the expression appears in the format code.

E- E+ e- e+ : If the format code contains at least one digit placeholder (0 or #) to the right of the symbol E-, E+, e-, or e+, the expression is formatted in the scientific or exponential format. The letter E or e is inserted between the number and the exponent. The number of placeholders for digits to the right of the symbol determines the number of digits in the exponent.

Si l'exponent és negatiu, un signe menys es mostra directament al davant de l'exponent amb E-, E+, e-, e+. Si l'exponent és positiu, un signe més només es mostra abans dels exponents amb E+ o e+.

The thousands delimiter is displayed if the format code contains the delimiter enclosed by digit placeholders (0 or #).

L'ús d'un punt com a separador de milers i decimal depèn de la configuració regional. Quan introduïu un número directament al codi font del Basic, utilitzeu sempre un punt com a delimitador decimal. El caràcter real que es mostra com a separador decimal depèn del format numèric dels paràmetres del sistema.

- + $ ( ) space: A plus (+), minus (-), dollar ($), space, or brackets entered directly in the format code is displayed as a literal character.

Per mostrar caràcters diferents dels que es llisten aquí, cal que vagi precedit per una barra inversa (\), o envoltat entre cometes ("").

\ : The backslash displays the next character in the format code.

Characters in the format code that have a special meaning can only be displayed as literal characters if they are preceded by a backslash. The backslash itself is not displayed, unless you enter a double backslash (\\) in the format code.

Els caràcters que han d'anar precedits per una barra inversa al codi de format per tal que es mostrin com a caràcters literals són els caràcters de formatació de la data - i de l'hora- (a, c, d, h, m, n, p, q, s, t, w, y, /, :), els caràcters de formatació numèrica (#, 0, %, E, e, coma, punt), i caràcters de formatació de cadenes (@, &, <, >, !).

You can also use the following predefined number formats. Except for "General Number", all of the predefined format codes return the number as a decimal number with two decimal places.

Si utilitzeu formats predefinits, el nom del format s'ha d'incloure entre cometes.

Formats predefinits

General Number: Els números es mostren tal com s'introdueixen.

Moneda: Insereix un signe de dòlar davant del número i afegeix números negatius entre parèntesis.

Fixat: Mostra com a mínim un dígit davant del separador decimal.

Estàndard: Mostra nombres amb un separador de milers.

Percentatge: Multiplica el número per 100 i afegeix un signe de percentatge al número.

Científic: Mostra números en format científic (per exemple, 1.00E+03 per a 1000).

A format code can be divided into three sections that are separated by semicolons. The first part defines the format for positive values, the second part for negative values, and the third part for zero. If you only specify one format code, it applies to all numbers.

Podeu definir la configuració regional per controlar el format de nombres, dates i monedes al LibreOffice Basic a ▸ Configuració de la llengua- Llengües. En codis de format del Basic, el punt decimal (.) sempre s'utilitza com a espai reservat per al separador decimal definit a la vostra configuració regional i es reemplaçarà pel caràcter corresponent.

El mateix és aplicable a la configuració regional pel que fa al format de la data, l'hora i la moneda. El codi de format del Basic s'interpretarà i es mostrarà segons la configuració regional.

Exemple:


    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.

Sintaxi:

svc.GetDefaultContext(): uno

Valor de retorn:

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.

Exemple:


    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.

Sintaxi:

svc.GetGuiType(): int

Exemple:


    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.

Sintaxi:

svc.GetPathSeparator(): str


    svc.GetPathSeparator(): str
  

Exemple:


    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:

Sintaxi:

svc.GetSystemTicks(): int

Exemple:


    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.

Sintaxi:

svc.GlobalScope.BasicLibraries(): uno

Valor de retorn:

com.sun.star.script.XLibraryContainer

Exemple:

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.

Sintaxi:

svc.GlobalScope.DialogLibraries(): uno

Valor de retorn:

com.sun.star.comp.sfx2.DialogLibraryContainer

Exemple:

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

Sintaxi:

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

Paràmetres:

prompt: String expression displayed as the message in the dialog box.

títol: expressió de cadena que es mostra a la barra de títol del quadre de diàleg.

default: String expression displayed in the text box as default if no other input is given.

xpostwips: Integer expression that specifies the horizontal position of the dialog. The position is an absolute coordinate and does not refer to the window of LibreOffice.

ypostwips: Integer expression that specifies the vertical position of the dialog. The position is an absolute coordinate and does not refer to the window of LibreOffice.

If xpostwips and ypostwips are omitted, the dialog is centered on the screen. The position is specified in twips.

Valor de retorn:

string

Exemple:


    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.

Sintaxi:

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

Paràmetres:

prompt: String expression displayed as a message in the dialog box. Line breaks can be inserted with Chr$(13).

title: String expression displayed in the title bar of the dialog. If omitted, the title bar displays the name of the respective application.

buttons: Any integer expression that specifies the dialog type, as well as the number and type of buttons to display, and the icon type. buttons represents a combination of bit patterns, that is, a combination of elements can be defined by adding their respective values:

Valor de retorn:

An optional integer as detailed in above IDxx properties.

Exemple:


    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.

Sintaxi:

svc.Now(): datetime

Exemple:


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

RGB

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

Sintaxi:

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

Paràmetres:

red: Any integer expression that represents the red component (0-255) of the composite color.

green: Any integer expression that represents the green component (0-255) of the composite color.

blue: Any integer expression that represents the blue component (0-255) of the composite color.

tip

The color picker dialog helps computing red, green and blue components of a composite color. Changing the color of text and selecting Custom color displays the color picker dialog.


Valor de retorn:

enter

Exemple:


    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.

Sintaxi:

svc.ThisComponent(): uno

Exemple:


    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.

Sintaxi:

svc.ThisDatabaseDocument(): uno

Exemple:


    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.

Sintaxi:

svc.Xray(obj: any)

Paràmetres:

obj: A variable or Uno object.

Exemple:


    svc.Xray(svc.StarDesktop)
  
warning

Totes les rutines o identificadors Basic de l'ScriptForge que comencen per un guió baix «_» són únicament per a ús intern. No han d'utilitzar-se en macros Basic.


Ens cal la vostra ajuda!