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

Tato služba je k dispozici od verze 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.


Syntaxe:

svc.CDate(expression: any): obj

Parametry:

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

Při převádění řetězce musejí být datum a čas zadány buď podle některé z masek pro rozpoznání data stanovených v národním nastavení ( - Jazyková nastavení - Jazyky), nebo ve formátu data podle normy ISO (prozatím je povolený pouze formát ISO se spojovníky, např. "2012-12-31"). V číselných výrazech představuje část vlevo od desetinné čárky datum (počítáno od 31. prosince 1899) a část vpravo od desetinné čárky představuje čas.

Příklad:


    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.

Syntaxe:

svc.CDateFromUnoDateTime(unodate: uno): obj

Parametry:

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

Příklad:

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.

Syntaxe:

svc.CDateToUnoDateTime(date: obj): uno

Parametry:

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.

Příklad:


    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.

Syntaxe:

svc.ConvertFromUrl(url: str): str

Parametry:

url: An absolute file: URL.

Návratová hodnota:

A system path file name.

Příklad:


    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.

Syntaxe:

svc.ConvertToUrl(systempath: str): str

Parametry:

systempath: A system file name as a string.

Návratová hodnota:

A file: URL as a string.

Příklad:


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

CreateUnoService

Instantiates a UNO service with the ProcessServiceManager.

Syntaxe:

svc.CreateUnoService(servicename: str): uno

Parametry:

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

Příklad:


    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.

Syntaxe:

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

Parametry:

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

Interval (řetězec)

Vysvětlení

yyyy

Rok

q

Čtvrtletí

m

Měsíc

y

Den v roce

w

Den v týdnu

ww

Týden v roce

d

Den

h

Hodina

n

Minuta

s

Sekunda


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.

Návratová hodnota:

A datetime.datetime value.

Příklad:


    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.

Syntaxe:

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

Parametry:

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: Nepovinný parametr, který určuje první den v týdnu.

Hodnota firstdayofweek

Vysvětlení

0

Použít výchozí systémovou hodnotu

1

Neděle (výchozí)

2

Pondělí

3

Úterý

4

Středa

5

Čtvrtek

6

Pátek

7

Sobota


firstweekofyear: Nepovinný parametr, který určuje první týden v roce.

Hodnota firstweekofyear

Vysvětlení

0

Použít výchozí systémovou hodnotu

1

První týden je ten, který obsahuje 1. leden (výchozí)

2

První týden je ten, který obsahuje alespoň čtyři dny roku

3

První týden je ten, který obsahuje pouze dny z nového roku


Návratová hodnota:

A number.

Příklad:


    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.

Syntaxe:

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

Parametry:

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.

Návratová hodnota:

The extracted part for the given date/time.

Příklad:


    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.

Syntaxe:

svc.DateValue(date: str): datetime

Parametry:

Date: Řetězec obsahující datum, jehož číselnou hodnotu chcete vypočítat. Na rozdíl od funkce DateSerial, která prochází roky, měsíce a dny jako samostatné číselné hodnoty, funkce DateValue vyžaduje, aby řetězec data odpovídal buď některé z masek pro rozpoznání data definovaných pro dané národní prostředí (viz - Jazykové nastavení - Jazyky), nebo ve formátu ISO (prozatím je možné použít pouze formát ISO se spojovníky, např. "2012-12-31").

Návratová hodnota:

The computed date.

Příklad:


    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.

Syntaxe:

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

Parametry:

expression: Číselný výraz, který chcete převést na formátovaný řetězec.

format: Řetězec, který určuje formátovací kód pro číslo. Je-li format vynechán, funguje funkce Format podobně jako funkce LibreOffice Basic Str().

Návratová hodnota:

Textový řetězec.

Formatting Codes

Následující seznam popisuje kódy, které je možné použít k formátování číselného výrazu:

0: Pokud má expression na pozici, kde je v kódu format 0, číslici, zobrazí se číslice, jinak se zobrazí nula.

Pokud má expression méně číslic, než je počet nul v kódu format (před či za desetinnou čárkou), zobrazí se nuly navíc na začátku nebo na konci. Pokud má expression před desetinnou čárkou více číslic než počet nul v kódu format, číslice navíc se zobrazí bez formátování.

Desetinná část hodnoty expression se zaokrouhlí podle počtu nul, které jsou kódu format za desetinným oddělovačem.

#: Pokud expression obsahuje v kódu format na pozici znaku # číslici, tato číslice se zobrazí, jinak se na této pozici nezobrazí nic.

Tento symbol má stejnou funkci jako 0, kromě toho, že se úvodní a koncové nuly nezobrazí, je-li v kódu format více znaků # než číslic v expression. Zobrazí se pouze relevantní číslice daného výrazu expression.

.: Zástupný znak pro desetinný oddělovač.

Pokud kód format obsahuje zástupné znaky # pouze nalevo od tohoto symbolu, budou čísla menší než 1 začínat desetinnou čárkou. Pokud chcete u zlomkových čísel vždy zobrazit úvodní nulu, použijte 0 jako zástupný znak pro první číslici nalevo od desetinné čárky.

%: Vynásobí expression číslem 100 a vloží znak procenta (%) na místo, kde se expression nachází v kódu format.

E- E+ e- e+ : Pokud kód format obsahuje alespoň jeden zástupný znak pro číslici (0 nebo #) napravo do symbolu E-, E+, e- nebo e+, expression se naformátuje podle vědeckého (exponenciálního) formátu. Mezi číslo a exponent se vloží písmeno E nebo e. Počet zástupných znaků vpravo symbolu určuje počet číslic exponentu.

Je-li exponent záporný, zobrazí se bezprostředně před exponentem s E-, E+, e-, e+ znaménko minus. Je-li exponent kladný, zobrazí se znaménko plus pouze před exponenty s E+ nebo e+.

Oddělovač tisíců se zobrazí, pokud kód format obsahuje oddělovač obklopený zástupnými znaky pro číslice (0 nebo #).

Použití tečky jako oddělovače tisíců nebo desetinného oddělovače závisí na místním nastavení. Když zadáváte číslo přímo do kódu Basic, vždy používejte tečku jako desetinný oddělovač. Podle místního nastavení vašeho systému se zobrazí skutečný desetinný oddělovač.

- + $ ( ) mezera: Plus (+), mínus (-), dolar ($), mezera nebo závorky zadané v kódu format se zobrazí jako znaky.

Chcete-li zobrazit jiné znaky, musíte jim předřadit zpětné lomítko (\) nebo je uzavřít do uvozovek (" ").

\ : Zpětné lomítko zobrazí přímo další znak v kódu format.

Znaky v kódu format, které mají zvláštní význam, lze jako znaky zobrazit, pouze pokud před ně přidáte zpětné lomítko. Samotné zpětné lomítko se nezobrazí, pokud nezapíšete dvojité zpětné lomítko (\\).

Znaky, před které musíte přidat zpětné lomítko, aby se zobrazily přímo jako znaky, jsou formátovací znaky pro datum a čas (a, c, d, h, m, n, p, q, s, t, w, y, /, :), formátovací znaky pro čísla (#, 0, %, E, e, čárka, tečka) a formátovací znaky pro řetězce (@, &, <, >, !).

Také je možné použít následující předem definované formáty čísla. Kromě "General Number" se všechny předem definované formáty zobrazují jako čísla zaokrouhlená na dvě desetinná místa.

Pokud používáte předem definované formáty, musí být název formátu uveden v uvozovkách.

Predefined Formats

General Number: Čísla se zobrazí, jak jsou zadána.

Currency: Vloží před číslo znak dolaru a záporná čísla uzavře do závorek.

Fixed: Zobrazí před desetinným oddělovačem alespoň jednu číslici.

Standard: Zobrazí čísla s oddělovačem tisíců.

Percent: Vynásobí číslo 100 a přidá k číslu znak procent.

Scientific: Zobrazí čísla ve vědeckém formátu (např. 1.00E+03 místo 1000).

Kód format lze rozdělit na tři části oddělené středníky. První část určuje formát pro kladná čísla, druhá pro záporná čísla a třetí pro nulu. Pokud určíte jen jeden kód format, použije se pro všechna čísla.

Národní prostředí použité pro formátování čísel, dat a měny v jazyce LibreOffice Basic můžete nastavit v - Jazyková nastavení - Jazyky. Ve formátovacích kódech se jako zástupný znak pro desetinný oddělovač používá vždy tečka (.), která se při zobrazení nahradí odpovídajícím znakem podle národního prostředí.

Totéž platí pro národní prostředí formátu data, času a měny. Formátovací kódy se interpretují a zobrazí podle aktuálního národního prostředí.

Příklad:


    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.

Syntaxe:

svc.GetDefaultContext(): uno

Návratová hodnota:

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.

Příklad:


    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.

Syntaxe:

svc.GetGuiType(): int

Příklad:


    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.

Syntaxe:

svc.GetPathSeparator(): str


    svc.GetPathSeparator(): str
  

Příklad:


    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:

Syntaxe:

svc.GetSystemTicks(): int

Příklad:


    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.

Syntaxe:

svc.GlobalScope.BasicLibraries(): uno

Návratová hodnota:

com.sun.star.script.XLibraryContainer

Příklad:

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.

Syntaxe:

svc.GlobalScope.DialogLibraries(): uno

Návratová hodnota:

com.sun.star.comp.sfx2.DialogLibraryContainer

Příklad:

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

Syntaxe:

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

Parametry:

prompt: Řetězec, který se zobrazí jako zpráva v dialogovém okně.

title: Řetězec, který se zobrazí v záhlaví dialogového okna.

default: Řetězec, který se zobrazí v textovém poli jako výchozí, pokud není zadán vstup.

xpostwips: Celočíselný výraz, který určuje vodorovné umístění dialogu. Pozice je absolutní souřadnice a nevztahuje se k oknu aplikace.

ypostwips: Celočíselný výraz, který určuje svislé umístění dialogu. Pozice je absolutní souřadnice a nevztahuje se k oknu aplikace.

Pokud jsou pozice xpostwips a ypostwips vynechány, dialog se na obrazovce zarovná na střed. Pozice se určuje v twipech.

Návratová hodnota:

string

Příklad:


    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.

Syntaxe:

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

Parametry:

prompt: Řetězec zobrazený jako zpráva v dialogovém okně. Zalomení řádku lze vložit pomocí Chr$(13).

title: Řetězec zobrazený v záhlaví dialogového okna. Je-li vynechán, zobrazí se v záhlaví název odpovídající aplikace.

buttons: Jakýkoliv celočíselný výraz, který určuje druh dialogu a také počet a druh zobrazených tlačítek a druh ikony. buttons představuje kombinaci bitových vzorků, takže lze použít kombinaci prvků součtem jejich hodnot:

Návratová hodnota:

An optional integer as detailed in above IDxx properties.

Příklad:


    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.

Syntaxe:

svc.Now(): datetime

Příklad:


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

RGB

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

Syntaxe:

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

Parametry:

red: Celočíselný výraz reprezentující červenou složku (0-255) barvy.

green: Celočíselný výraz reprezentující zelenou složku (0-255) barvy.

blue: Celočíselný výraz reprezentující modrou složku (0-255) barvy.

tip

Zjistit hodnoty červené, zelené a modré složky barvy lze pomocí dialogového okna pro výběr barvy. Toto okno zobrazíte volbou Vlastní barva při změně barvy textu.


Návratová hodnota:

integer

Příklad:


    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.

Syntaxe:

svc.ThisComponent(): uno

Příklad:


    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.

Syntaxe:

svc.ThisDatabaseDocument(): uno

Příklad:


    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.

Syntaxe:

svc.Xray(obj: any)

Parametry:

obj: A variable or Uno object.

Příklad:


    svc.Xray(svc.StarDesktop)
  
warning

Všechny procedury nebo identifikátory knihovny ScriptForge, které jsou uvozeny podtržítkem "_", jsou určeny pro interní použití. Není zamýšleno je používat v makrech Basicu.