Instantiating UNO Services

From Apache OpenOffice Wiki
< Documentation‎ | DevGuide
Revision as of 01:25, 15 January 2009 by TJFrazier (Talk | contribs)

Jump to: navigation, search

In Basic, instantiate services using the Basic Runtime Library (RTL) function createUnoService(). This function expects a fully qualified service name and returns an object supporting this service, if it is available:

 oSimpleFileAccess = CreateUnoService( "" )

This call instantiates the service. To ensure that the function was successful, the returned object can be checked with the IsNull function:

 oSimpleFileAccess = CreateUnoService( "" )
 bError = IsNull( oSimpleFileAccess )' bError is set to False
 oNoService = CreateUnoService( "" )
 bError = IsNull( oNoService )' bError is set to True

Instead of using CreateUnoService() to instantiate a service, it is also possible to get the global UNO of the process by calling GetProcessServiceManager(). Once obtained, use createInstance() directly:

 oServiceMgr = GetProcessServiceManager()
 oSimpleFileAccess = oServiceMgr.createInstance( "" )
 ' is the same as
 oSimpleFileAccess = CreateUnoService( "" )

The advantage of GetProcessServiceManager() is that additional information and pass in arguments is received when services are instantiated using the service manager. For instance, to initialize a service with arguments, the createInstanceWithArguments() method of has to be used at the service manager, because there is no appropriate Basic RTL function to do that. Example:

 Dim args(1)
 args(0) = "Important information"
 args(1) = "Even more important information"
 oService = oServiceMgr.createInstanceWithArguments _
     ( "", args() )

The object returned by GetProcessServiceManager() is a normal Basic UNO object supporting Its properties and methods are accessed as described above.

In addition, the Basic RTL provides special properties as API entry points. They are described in more detail in Features of Basic: Basic RTL Property Description
ThisComponent Only exists in Basic code which is embedded in a Writer, Calc, Draw or Impress document. It contains the document model the Basic code is embedded in.
StarDesktop The singleton of the office application. It loads document components and handles the document windows. For instance, the document in the top window can be retrieved using oDoc = StarDesktop.CurrentComponent.
Content on this page is licensed under the Public Documentation License (PDL).
Personal tools
In other languages