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.

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")

Властивості

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	Returns the StarDesktop object that represents the LibreOffice application.
ThisComponent	Yes	UNO object	If the current component refers to a LibreOffice document, this method returns the UNO object representing the document. This property returns None when the current component does not correspond to a document.
ThisDatabaseDocument	Yes	UNO object	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 property returns None otherwise.

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

Синтаксис:

svc.CDate(expression: any): obj

Параметри:

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 - Languages and Locales - General) 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.

Приклад:


    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.

Синтаксис:

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.


    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.

Синтаксис:

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 = bas.CDateToUnoDateTime(current_datetime)
    bas.MsgBox(str(uno_date.Year) + "-" + str(uno_date.Month) + "-" + str(uno_date.Day))

Параметри:

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

interval (string value)	Пояснення
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 datetime.datetime value.

Повертає значення:

A datetime.datetime value.

Приклад:


    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.

Синтаксис:

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

firstdayofweek value	Пояснення
0	Використовувати типове системне значення
1	Неділя (типова)
2	Понеділок
3	Вівторок
4	Середа
5	Четвер
6	П'ятниця
7	Субота

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

firstweekofyear value	Пояснення
0	Використовувати типове системне значення
1	Тиждень 1 - тиждень, який містить 1 січня (типово)
2	Тиждень 1 - перший тиждень, в якому міститься не менше чотирьох днів цього року
3	Тиждень 1 - перший тиждень, у якому містяться лише дні нового року

Повертає значення:

A number.

Приклад:


    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.

Синтаксис:

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(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.

Синтаксис:

svc.DateValue(date: str): datetime

Параметри:

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 - Languages and Locales - General) or using the ISO date format "yyyy-mm-dd" (year, month and day separated by hyphens).

Повертає значення:

The computed date.

Приклад:


    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.

Синтаксис:

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

Параметри:

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.

Повертає значення:

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.

.: Десятковий заповнювач визначає число десяткових розрядів зліва і справа від десяткового розділювача.

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.

Якщо експонента від'ємна, то знак мінус виводиться безпосередньо перед експонентою з E-, E+, e-, e+. Якщо ж експонента є додатною, то знак плюс виводиться лише перед експонентами з Е+ або е+.

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

Використання крапки як розділювача груп розрядів чи десяткового розділювача визначається параметрами регіональних стандартів операційної системи. При введенні числа безпосередньо у програмний код Basic завжди використовуйте в ролі десяткового розділювача крапку. Фактичний вигляд десяткового розділювача визначається форматом чисел, який заданий у системних параметрах.

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

Щоб показати інші символи, необхідно поставити перед ними обернену косу риску (\) або взяти їх у лапки (" ").

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

Зворотна коса риска в коді формату для того, щоб елемент виводився як символ, ставиться перед: символами для форматування дати й часу (a, c, d, h, m, n, p, q, s, t, w, y, /, :), символами для числового форматування (#, 0, %, E, e, кома, крапка) і символами для форматування рядків (@, &, <, >, !).

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.

Якщо використовуються наперед визначені формати, то їхні назви повинні бути укладені в лапки.

Predefined Formats

General Number: числа відображаються так, як вони введені.

Currency: після числа ставиться знак гривні, від'ємні числа беруться в дужки.

Fixed: принаймні один розряд показується перед десятковим розділювачем.

Standard: числа виводяться з розділювачами.

Percent: число множиться на 100 і до цього числа додається знак відсотків.

Scientific: числа виводяться у науковому форматі (наприклад, 1,00E+03 для числа 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.

Ви можете встановити локаль для керування форматуванням чисел, дат і валют у LibreOffice Basic у - Мови та локалі - Загальні. У кодах формату Basic десяткова крапка (.) завжди використовується як заповнювач для десяткового роздільника, визначеного у вашій локалі, і буде замінена відповідним символом.

Те ж саме стосується і параметрів мови для форматів дати, часу і валюти. Код формату Basic буде інтерпретуватися і відображатися у відповідності з національними установками.

Приклад:


    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.

Синтаксис:

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

Синтаксис:

svc.GetGuiType(): int

Приклад:


    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.

Синтаксис:

svc.GetPathSeparator(): str

Приклад:


    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:

Синтаксис:

svc.GetSystemTicks(): int

Приклад:


    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.

Синтаксис:

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

Синтаксис:

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 = bas.GlobalScope.DialogLibraries()
    lib_names = dlg_libs.getElementNames()
    bas.MsgBox("\n".join(lib_names))

InputBox

Синтаксис:

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

Параметри:

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

Повертає значення:

String

Приклад:


    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.

Синтаксис:

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

Параметри:

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:

Повертає значення:

An optional integer as detailed in above IDxx properties.

Приклад:


    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.

Синтаксис:

svc.Now(): datetime

Приклад:


    bas.MsgBox(bas.Now(), bas.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: 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.

Повертає значення:

Integer

Приклад:


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

Xray

Inspect Uno objects or variables.

Синтаксис:

svc.Xray(obj: any)

Параметри:

obj: A variable or UNO object.

Приклад:


    bas.Xray(bas.StarDesktop)

Усі ScriptForge Basic процедури або ідентифікатори, в яких префіксом є символ підкреслення "_" зарезервовано для внутрішнього використання. Вони не призначені для використання в макросах Basic або скриптах Python.

GlobalScope specifier

Програмування сценаріїв на Python

uno.fileUrlToSystemPath()

uno.systemPathToFileUrl()

Input/Output to Screen with Python on the wiki

XSCRIPTCONTEXT.getComponentContext()

uno.getComponentContext()

platform.system()

os.pathsep()