The Tools Library

To access this command...

Open Tools - Macros - LibreOfficeDev Basic - Edit and select Application Macros container.


Note Icon

This library must be loaded before execution. Execute the following statement before running any macro that uses this library:
GlobalScope.BasicLibraries.LoadLibrary("Tools")


Debug Module

ListBox Module

Misc Module

ModuleControls Module

Strings Module

UCB Module

Debug Module

Functions and subroutines for debugging Basic macros.

ActivateReadOnlyFlag


            Sub ActivateReadOnlyFlag()

DeactivateReadOnlyFlag


            Sub DeactivateReadOnlyFlag()

SetBasicReadOnlyFlag


            Sub SetBasicReadOnlyFlag(bReadOnly as Boolean)

WritedbgInfo


            Sub WritedbgInfo(LocObject as Object)

WriteDbgString


            Sub WriteDbgString(LocString as String)

ShowArray


            Sub ShowArray(LocArray())

ShowPropertyValues


            Sub ShowPropertyValues(oLocObject as Object)

ShowNameValuePair


            Sub ShowNameValuePair(Pair())

ShowElementNames

' Retrieves all the Elements of aSequence of an object, with the

' possibility to define a filter(sfilter <> "")


            Sub ShowElementNames(
            oLocElements() as Object,
            Optional sFiltername as String)

ShowSupportedServiceNames

' Retrieves all the supported servicenames of an object, with the

' possibility to define a filter(sfilter <> "")


            Sub ShowSupportedServiceNames(
            oLocObject as Object,
            Optional sFilterName as String)

ShowAvailableServiceNames

' Retrieves all the available Servicenames of an object, with the

' possibility to define a filter(sfilter <> "")


            Sub ShowAvailableServiceNames(
            oLocObject as Object, 
            Optional sFilterName as String)

ShowCommands


            Sub ShowCommands(oLocObject as Object)

ProtectCurrentSheets


            Sub ProtectCurrentSheets()

FillDocument


            Sub FillDocument()

ListBox Module

Functions and subroutines for handling ListBox elements.

Warning Icon

This help page needs further work for correctness and completion. Please join the LibreOffice project and help us out to write the missing information. Visit our web page on writing Help contents.


Misc Module

Miscellaneous functions and subroutines.

RegisterNewDataSource


            Function RegisterNewDataSource(
            DSName as  String, 
            PropertyList(), 
            Optional DriverProperties() 
            as New com.sun.star.beans.PropertyValue)

ConnecttoDatabase


            Function ConnecttoDatabase(
            DSName as String, 
            UserID as String, 
            Password as String, 
            Optional Propertylist(), 
            Optional DriverProperties() 
            as New com.sun.star.beans.PropertyValue)

GetStarOfficeLocale


            Function GetStarOfficeLocale() 
            as New com.sun.star.lang.Locale

GetRegistryKeyContent


            Function GetRegistryKeyContent(
            sKeyName as string, 
            Optional bforUpdate as Boolean)

Example


            Sub GetUserData()
            BasicLibraries.LoadLibrary("Tools")
            Dim oData As Object
            oData = GetRegistryKeyContent("org.openoffice.UserProfile/Data", True)
            MsgBox oData.givenname & " " & oData.sn
            End Sub

GetProductname


            Function GetProductname() as String

OpenDocument

' Opens a Document, checks beforehand, whether it has to be loaded or whether it is already on the desktop. If the parameter bDisposable is set to False then the returned document should not be disposed afterwards, because it is already opened.


            Function OpenDocument(
            DocPath as String, 
            Args(), 
            Optional bDisposable as Boolean)

TaskonDesktop


            Function TaskonDesktop(DocPath as String) as Boolean

RetrieveFileName

' Retrieves a FileName out of a StarOffice-Document.


            Function RetrieveFileName(LocDoc as Object)

GetPathSettings

' Gets a special configured PathSetting.


            Function GetPathSettings(
            sPathType as String,
            Optional bshowall as Boolean, 
            Optional ListIndex as integer) as String

GetOfficeSubPath

' Gets the fully qualified path to a subdirectory of the Template Directory, e. g. with the parameter "wizard/bitmap". The parameter must be passed over in Url-scription. The return-Value is in Urlscription.


            Function GetOfficeSubPath(
            sOfficePath as String, 
            ByVal sSubDir as String)

ShowNoOfficePathError


            Sub ShowNoOfficePathError()

InitResources


            Function InitResources(
            Description, 
            ShortDescription as String) as boolean

GetResText


            Function GetResText( nID as integer ) As string

CutPathView


            Function CutPathView(
            sDocUrl as String, 
            Optional PathLen as Integer)

DeleteInputCells

' Deletes the content of all cells that are softformatted according to the 'InputStyleName'.


            Sub DeleteInputCells(
            oSheet as Object, 
            InputStyleName as String)

ChangeValueofRange

' Inserts a certain String to all cells of a Range that is passed over either as an object or as the RangeName.


            Sub ChangeValueofRange(
            oSheet as Object, 
            Range, 
            ReplaceValue, 
            Optional StyleName as String)

ReplaceRangeValues


            Sub ReplaceRangeValues(
            oRange as Object, 
            ReplaceValue)

GetValueofCellbyName

' Returns the Value of the first cell of a Range.


            Function GetValueofCellbyName(
            oSheet as Object, 
            sCellName as String)

DuplicateRow


            Function DuplicateRow(
            oSheet as Object, 
            RangeName as String)

GetStringofCellbyName

' Returns the String of the first cell of a Range.


            Function GetStringofCellbyName(
            oSheet as Object, 
            sCellName as String)

GetCellByName

' Returns a named Cell


            Function GetCellByName(
            oSheet as Object, 
            sCellName as String) as Object

ChangeCellValue

' Changes the numeric Value of a cell by transmitting the String of the numeric Value.


            Sub ChangeCellValue(
            oCell as Object, 
            ValueString as String)

GetDocumentType


            Function GetDocumentType(oDocument)

GetNumberFormatType


            Function GetNumberFormatType(
            oDocFormats, 
            oFormatObject as Object) as Integer

ProtectSheets


            Sub ProtectSheets(Optional oSheets as Object)

UnprotectSheets


            Sub UnprotectSheets(Optional oSheets as Object)

GetRowIndex


            Function GetRowIndex(
            oSheet as Object, 
            RowName as String)

GetColumnIndex


            Function GetColumnIndex(
            oSheet as Object, 
            ColName as String)

CopySheetbyName


            Function CopySheetbyName(
            oSheets as Object, 
            OldName as String, 
            NewName as String, 
            DestPos as Integer) as Object

ToggleWindow

' Dis-or enables a Window and adjusts the mousepointer accordingly


            Sub ToggleWindow(bDoEnable as Boolean)

CheckNewSheetname


            Function CheckNewSheetname(
            oSheets as Object, 
            Sheetname as String, 
            Optional oLocale) as String

AddNewSheetName


            Sub AddNewSheetName(
            oSheets as Object, 
            ByVal SheetName as String)

GetSheetIndex


            Function GetSheetIndex(oSheets, sName) as Integer

GetLastUsedRow


            Function GetLastUsedRow(oSheet as Object) as Integer

ModifyBorderLineWidth

' Note To set a one lined frame you have to set the inner width to 0 In the API all Units that refer to pt-Heights are "1/100mm" The convert factor from 1pt to 1/100 mm is approximately 35 


            Function ModifyBorderLineWidth(
            ByVal oStyleBorder, 
            iInnerLineWidth as Integer, 
            iOuterLineWidth as Integer)

AttachBasicMacroToEvent


            Sub AttachBasicMacroToEvent(
            oDocument as Object, 
            EventName as String, 
            SubPath as String)

ModifyPropertyValue


            Function ModifyPropertyValue(
            oContent() as New com.sun.star.beans.PropertyValue, 
            TargetProperties() 
            as New com.sun.star.beans.PropertyValue)

GetPropertyValueIndex


            Function GetPropertyValueIndex(
            SearchName as String, 
            TargetProperties() 
            as New com.sun.star.beans.PropertyValue ) as Integer

DispatchSlot


            Sub DispatchSlot(SlotID as Integer)

IsFatOffice

'returns the type of the office application FatOffice = 0, WebTop = 1 This routine has to be changed if the Product Name is being changed! 


            Function IsFatOffice() As Boolean

ToggleDesignMode


            Sub ToggleDesignMode(oDocument as Object)

isHighContrast


            Function isHighContrast(oPeer as Object)

CreateNewDocument