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

This service is available from LibreOffice 7.2 onwards.


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.


አገባብ:

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

ለምሳሌ:


    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.

አገባብ:

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.


    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.

አገባብ:

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

አገባብ:

svc.ConvertFromUrl(url: str): str

ደንቦች:

url: An absolute file: URL.

ዋጋ ይመልሳል:

A system path file name.

ለምሳሌ:


    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.

አገባብ:

svc.ConvertToUrl(systempath: str): str

ደንቦች:

systempath: A system file name as a string.

ዋጋ ይመልሳል:

A file: URL as a string.

ለምሳሌ:


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

CreateUnoService

Instantiates a UNO service with the ProcessServiceManager.

አገባብ:

svc.CreateUnoService(servicename: str): uno

ደንቦች:

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

ለምሳሌ:


    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.

አገባብ:

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

ደንቦች:

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

interval (string value)

መግለጫዎች

አአአአ

አመት

q

ሩብ

ወር

ቀን በ አመት ውስጥ

የ ስራ ቀን

ሳሳ

ሳምንት በ አመት ውስጥ

ቀን

h

ሰአት

ደቂቃ

ሰከንድ


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.

ዋጋ ይመልሳል:

A datetime.datetime value.

ለምሳሌ:


    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.

አገባብ:

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

አገባብ:

svc.DateValue(date: str): datetime

ደንቦች:

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

ዋጋ ይመልሳል:

The computed date.

ለምሳሌ:


    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.

አገባብ:

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+. ጋር: ኤክስፖነንት አዎንታዊ ከሆነ የ መደመሪያ ምልክት ይታያል በ ቀጥታ ከ ኤክስፖነንት በፊት ከ 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

ቁጥር ባጠቃላይ: ቁጥሮች የሚታዩት እንደገቡት ነው

ገንዘብ: የ ብር ምልክት ያስገባል ከ ቁጥር ፊት ለ ፊት እና አሉታዊ ቁጥሮች በ ቅንፍ ውስጥ ይከብባል

የ ተወሰነ: ቢያንስ አንድ አሀዝ ከ ዴሲማል መለያያ በፊት ያሳያል

መደበኛ: ቁጥሮች ከ ሺዎች መለያያ ጋር ያሳያል

ፐርሰንት: ማባዣ ቁጥር በ 100 እና መጨመሪያ የ ፐርሰንት ምልክት ወደ ቁጥሩ ውስጥ

ሳይንሳዊ: ቁጥሮች ማሳያ በ ሳይንሳዊ አቀራረብ (ለምሳሌ: 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 format code ይተረጉም እና ያሳያል እርስዎ እንደ እንደ አሰናዱት ቋንቋ አይነት

ለምሳሌ:


    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.

አገባብ:

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

አገባብ:

svc.GetGuiType(): int

ለምሳሌ:


    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.

አገባብ:

svc.GetPathSeparator(): str


    svc.GetPathSeparator(): str
  

ለምሳሌ:


    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:

አገባብ:

svc.GetSystemTicks(): int

ለምሳሌ:


    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.

አገባብ:

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

አገባብ:

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 = svc.GlobalScope.DialogLibraries()
    lib_names = dlg_libs.getElementNames()
    svc.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, 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.

አገባብ:

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

አገባብ:

svc.Now(): datetime

ለምሳሌ:


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

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.


ዋጋ ይመልሳል:

integer

ለምሳሌ:


    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.

አገባብ:

svc.ThisComponent(): uno

ለምሳሌ:


    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.

አገባብ:

svc.ThisDatabaseDocument(): uno

ለምሳሌ:


    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.

አገባብ:

svc.Xray(obj: any)

ደንቦች:

obj: A variable or Uno object.

ለምሳሌ:


    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!