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

Bu hizmet LibreOffice 7.2'den itibaren mevcuttur.


Typical example:


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

ScriptForge.Basic service is limited to Python scripts.


Servis çağırma

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.


Sözdizimi:

svc.CDate(expression: any): obj

Parametreler:

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.

Örnek:


    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.

Sözdizimi:

svc.CDateFromUnoDateTime(unodate: uno): obj

Parametreler:

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

Örnek:

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.

Sözdizimi:

svc.CDateToUnoDateTime(date: obj): uno

Parametreler:

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.

Örnek:


    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.

Sözdizimi:

svc.ConvertFromUrl(url: str): str

Parametreler:

url: An absolute file: URL.

Dönüş değeri:

A system path file name.

Örnek:


    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.

Sözdizimi:

svc.ConvertToUrl(systempath: str): str

Parametreler:

systempath: A system file name as a string.

Dönüş değeri:

A file: URL as a string.

Örnek:


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

CreateUnoService

Instantiates a UNO service with the ProcessServiceManager.

Sözdizimi:

svc.CreateUnoService(servicename: str): uno

Parametreler:

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

Örnek:


    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.

Sözdizimi:

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

Parametreler:

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

interval (string value)

Açıklama

yyyy

Yıl

q

Çeyrek

m

Ay

y

Yılın günü

w

İş günü

ww

Yılın haftası

d

Gün

h

Saat

n

Dakika

s

Saniye


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.

Dönüş değeri:

A datetime.datetime value.

Örnek:


    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.

Sözdizimi:

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

Parametreler:

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

Açıklama

0

Sistem varsayılan değerini kullan

1

Pazar (varsayılan)

2

Pazartesi

3

Salı

4

Çarşamba

5

Perşembe

6

Cuma

7

Cumartesi


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

firstweekofyear value

Açıklama

0

Sistem varsayılan değerini kullan

1

Hafta 1 Ocak ayının haftasıdır, 1inci (varsayılan)

2

Hafta 1 yılın dört veya daha fazla gününü içeren ilk haftasıdır

3

Hafta 1 sadece yeni yılın günlerini içeren ilk haftadır


Dönüş değeri:

A number.

Örnek:


    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.

Sözdizimi:

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

Parametreler:

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.

Dönüş değeri:

The extracted part for the given date/time.

Örnek:


    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.

Sözdizimi:

svc.DateValue(date: str): datetime

Parametreler:

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

Dönüş değeri:

The computed date.

Örnek:


    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.

Sözdizimi:

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

Parametreler:

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.

Dönüş değeri:

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.

.: Ondalık yer tutucusu kendisinin sağında ve solunda kaç ondalık yer olacağını belirler.

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ğer üs negatif ise, eksi işareti E-, E+, e-, e+ üstünden hemen önce gösterilir. Eğer üs pozitif ise, sadece E+ or e+ üslerinden önce artı işareti gösterilir.

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

Noktanın binlik ve ondalık ayraç olarak kullanılması bölgesel ayarlara bağlıdır. Bir sayıyı Basic kaynak koduna eklediğiniz zaman, ondalık sınırlandırıcı olarak her zaman nokta kullanın. Ondalık ayraç olarak asıl gösterilecek karakter sistem ayarlarınızdaki sayı biçimine bağlıdır.

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

Burada listelenenler dışındaki karakterleri görüntülemek için önüne bir ters bölü işareti (\) koymalı veya çift tırnak (" ") içinde yazmalısınız.

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

Biçim kodu içerisinde gerçek karakter olarak güzükmeleri için önlerine ters bölü işareti konması gereken karakterler tarih ve zaman biçim karakterleri (a, c, d, h, m, n, p, q, s, t, w, y, /, :), sayısal biçimlendirme karakterleri (#, 0, %, E, e, virgül, nokta) ve karakter dizisi biçimlendirme karakterleridir (@, &, <, >, !).

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.

Eğer önceden tanımlanmış biçimleri kullanırsanız biçimin adı tırnak işaretleri arasına yazılmalıdır.

Predefined Formats

General Number: Sayılar girildiği gibi görüntülenir.

Currency: Sayının önüne bir dolar işareti yerleştirir ve negatif sayıları parantez içine alır.

Fixed: Ondalık ayracından sonra en az bir basamak görüntüler.

Standard: Sayıyı binler ayracıyla görüntüler.

Percent: Sayıyı 100 ile çarpar ve sonuna bir yüzde işareti ekler.

Scientific: Sayıyı bilimsel biçimde görüntüler (örneğin 1000 yerine 1.00E+03)

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 içerisinde kullanılan sayılar, tarihler ve yüzdelerin biçimlendirmesini kontrol etmek için yerel ayarlayabilirsiniz, - Dil Seçenekleri - Diller içerisinde. Basic biçim kodları içerisinde, ondalik nokta (.) her zaman yereliniz içerisinde ondalık ayracı olarak tanımlı yer tutucu olarak kullanılır ve karşılık gelen karakter ile yerdeğiştirlecektir.

Aynısı tarih, zaman ve döviz biçimleri için yerel ayarlara uygulanır. Basic biçim kodu yerel ayarınıza göre yorumlanıp gösterilecektir.

Örnek:


    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.

Sözdizimi:

svc.GetDefaultContext(): uno

Dönüş değeri:

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.

Örnek:


    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.

Sözdizimi:

svc.GetGuiType(): int

Örnek:


    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.

Sözdizimi:

svc.GetPathSeparator(): str


    svc.GetPathSeparator(): str
  

Örnek:


    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:

Sözdizimi:

svc.GetSystemTicks(): int

Örnek:


    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.

Sözdizimi:

svc.GlobalScope.BasicLibraries(): uno

Dönüş değeri:

com.sun.star.script.XLibraryContainer

Örnek:

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.

Sözdizimi:

svc.GlobalScope.DialogLibraries(): uno

Dönüş değeri:

com.sun.star.comp.sfx2.DialogLibraryContainer

Örnek:

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

Sözdizimi:

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

Parametreler:

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.

Dönüş değeri:

string

Örnek:


    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.

Sözdizimi:

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

Parametreler:

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:

Dönüş değeri:

An optional integer as detailed in above IDxx properties.

Örnek:


    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.

Sözdizimi:

svc.Now(): datetime

Örnek:


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

RGB

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

Sözdizimi:

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

Parametreler:

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.


Dönüş değeri:

integer

Örnek:


    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.

Sözdizimi:

svc.ThisComponent(): uno

Örnek:


    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.

Sözdizimi:

svc.ThisDatabaseDocument(): uno

Örnek:


    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.

Sözdizimi:

svc.Xray(obj: any)

Parametreler:

obj: A variable or Uno object.

Örnek:


    svc.Xray(svc.StarDesktop)
  
warning

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.


Please support us!