ScriptForge.Basic service

The ScriptForge.Basic service proposes a collection of Collabora Office Basic methods to be executed in a Python context. Basic service methods reproduce the exact syntax and behaviour of Basic builtin functions.

Typical example:


   bas.MsgBox('Display this text in a message box from a Python script')

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
    bas = 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 Collabora Office Start Center.

List of Methods in the Basic Service
CDate CDateFromUnoDateTime CDateToUnoDateTime ConvertFromUrl ConvertToUrl CreateUnoService CreateUnoStruct 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.

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

Syntax:

svc.CDate(expression: any): obj

Parametrar:

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.

Exempel:


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

CDateFromUnoDateTime

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

Syntax:

svc.CDateFromUnoDateTime(unodate: uno): obj

Parametrar:

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

Exempel:

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


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

CDateToUnoDateTime

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

Syntax:

svc.CDateToUnoDateTime(date: obj): uno

Parametrar:

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.

Exempel:


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

Parametrar:

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

interval (string value)	Förklaring
yyyy	År
q	Kvartal
m	Månad
y	Dagen på året
w	Weekday
ww	Vecka på året
d	Dag
h	Hour
n	Minute
s	Second

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

Returnerat värde:

A datetime.datetime value.

Exempel:


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

DateDiff

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

Syntax:

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

Parametrar:

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	Förklaring
0	Använd systemets standardvärde
1	Söndag (standardvärde)
2	måndag
3	Tisdag
4	Onsdag
5	Torsdag
6	Fredag
7	Lördag

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

firstweekofyear value	Förklaring
0	Använd systemets standardvärde
1	Vecka 1 är den vecka där den 1 januari infaller (standardvärde)
2	Vecka 1 är den första veckan som innehåller fyra eller fler dagar på det året
3	Vecka 1 är den första veckan som enbart innehåller dagar under det nya året

Returnerat värde:

A number.

Exempel:


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

DatePart

The DatePart function returns a specified part of a date.

Syntax:

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

Parametrar:

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.

Returnerat värde:

The extracted part for the given date/time.

Exempel:


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

DateValue

Computes a date value from a date string.

Syntax:

svc.DateValue(date: str): datetime

Parametrar:

date: A string that contains the date that will be converted to a Date object.

The string passed to DateValue must be expressed in one of the date formats defined by your locale setting (see - Language Settings - Languages) or using the ISO date format "yyyy-mm-dd" (year, month and day separated by hyphens).

Returnerat värde:

The computed date.

Exempel:


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

Format

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

Syntax:

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

Parametrar:

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 Collabora Office Basic Str() function.

Returnerat värde:

Text string.

Formatting Codes

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.

.: Decimalplatshållaren bestämmer antalet decimaler till vänster och höger om decimaltecknet.

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.

Om exponenten är negativ visas ett minustecken direkt före en exponent med E-, E+, e-, e+. Om exponenten är positiv visas bara ett plustecken före exponenten med E+ eller e+.

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

Om punkt används som decimaltecken och tusentalsavgränsare beror på de nationella inställningarna. När du anger ett tal direkt i Basic-källkoden måste du däremot använda en punkt som decimalavgränsare. Vilket tecken som visas som decimaltecken beror på talformatet i systeminställningarna.

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

Om du vill visa andra tecken än de som listas här måste de föregås av ett omvänt snedstreck (\) eller inneslutas av citattecken (" ").

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

De tecken som bara visas om de föregås av ett omvänt snedstreck i formatbeskrivningen är tecken för datum- och tidsformat (a, c, d, h, m, n, p, q, s, t, w, y, /, :), tecken för numeriska format (#, 0, %, E, e, komma, punkt) och tecken för strängformat (@, &, <, >, !).

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.

Om du använder fördefinierade format måste du ange namnet inom citattecken.

Predefined Formats

General Number: Talen visas så som de har matats in.

Currency: Infogar ett dollartecken framför talet och sätter negativa tal inom parentes.

Fixed: Visar minst en siffra framför decimaltecknet.

Standard: Visar tal med tusentalsavgränsare.

Percent: Multiplicerar talet med 100 och lägger till ett procenttecken efter talet.

Vetenskap: Visar tal i potensformat (till exempel 1,00E+03 motsvarande 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.

Du kan ange en språkvariant för att styra konverteringen av tal, datum och valutor i Collabora Office Basic under – Språkinställningar – Språk. I Basic-talformat används alltid en decimalpunkt (.) som platshållare för det decimaltecken som gäller för den aktuella språkvarianten. Decimalpunkten kommer att ersättas med motsvarande decimaltecken.

Detta gäller även språkinställningar för datum-, tids- och valutaformat. Basic-formatet kommer att tolkas och visas på det sätt som definierats i språkinställningarna.

Exempel:


    txt = bas.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.

Syntax:

svc.GetDefaultContext(): uno

Returnerat värde:

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.

Exempel:


    ctx = bas.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.

Syntax:

svc.GetGuiType(): int

Exempel:


    n = bas.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.

Syntax:

svc.GetPathSeparator(): str

Exempel:


    sep = bas.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:

Syntax:

svc.GetSystemTicks(): int

Exempel:


    ticks_ini = bas.GetSystemTicks()
    time.sleep(1)
    ticks_end = bas.GetSystemTicks()
    bas.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.

Syntax:

svc.GlobalScope.BasicLibraries(): uno

Returnerat värde:

com.sun.star.script.XLibraryContainer

Exempel:

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


    libs = bas.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.

Syntax:

svc.GlobalScope.DialogLibraries(): uno

Returnerat värde:

com.sun.star.comp.sfx2.DialogLibraryContainer

Exempel:

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


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

InputBox

Syntax:

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

Parametrar:

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

title: String expression displayed in the title bar of the dialog box.

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

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

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

Returnerat värde:

String

Exempel:


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

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.

Syntax:

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

Parametrar:

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:

Returnerat värde:

An optional integer as detailed in above IDxx properties.

Exempel:


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

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.

Syntax:

svc.Now(): datetime

Exempel:


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

RGB

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

Syntax:

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

Parametrar:

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.

The resulting Long value is calculated with the following formula:
Result = red×65536 + green×256 + blue.

Under VBA compatibility mode (Option VBASupport 1), the Long value is calculated as
Result = red + green×256 + blue×65536
See RGB Function [VBA]

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.

Returnerat värde:

Integer

Exempel:


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

ThisComponent

If the current component refers to a Collabora Office 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.

Syntax:

svc.ThisComponent(): uno

Exempel:


    comp = bas.ThisComponent
    bas.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.

Syntax:

svc.ThisDatabaseDocument(): uno

Exempel:


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

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

Xray

Inspect Uno objects or variables.

Syntax:

svc.Xray(obj: any)

Parametrar:

obj: A variable or UNO object.

Exempel:


    bas.Xray(bas.StarDesktop)

All ScriptForge Basic routines or identifiers that are prefixed with an underscore character "_" are reserved for internal use. They are not meant be used in Basic macros or Python scripts.

GlobalScope specifier

Programming with Python Scripts

uno.fileUrlToSystemPath()

uno.systemPathToFileUrl()

Input/Output to Screen with Python on the wiki

XSCRIPTCONTEXT.getComponentContext()

uno.getComponentContext()

platform.system()

os.pathsep()