Difference between revisions of "Documentation/DevGuide/Basic/Accessing the UNO API"

From Apache OpenOffice Wiki
Jump to: navigation, search
m (1 revision(s))
(added : ThisDatabaseDocument)
(5 intermediate revisions by 3 users not shown)
Line 5: Line 5:
 
|NextPage=Documentation/DevGuide/Basic/Special Behavior of OpenOffice.org Basic
 
|NextPage=Documentation/DevGuide/Basic/Special Behavior of OpenOffice.org Basic
 
}}
 
}}
−
{{DISPLAYTITLE:Accessing the UNO API}}
+
{{Documentation/DevGuideLanguages|Documentation/DevGuide/Basic/{{SUBPAGENAME}}}}
 +
{{DISPLAYTITLE:Accessing the UNO API}}
 
In [[Documentation/DevGuide/ProUNO/Basic/OpenOffice.org Basic|OpenOffice.org Basic]], the interaction between Basic and UNO is described on an elementary level. This section describes the interface between Basic and the UNO API at the level of the {{PRODUCTNAME}} application.  
 
In [[Documentation/DevGuide/ProUNO/Basic/OpenOffice.org Basic|OpenOffice.org Basic]], the interaction between Basic and UNO is described on an elementary level. This section describes the interface between Basic and the UNO API at the level of the {{PRODUCTNAME}} application.  
  
Line 13: Line 14:
 
* <code>ThisComponent</code>
 
* <code>ThisComponent</code>
  
−
The property <code>StarDesktop</code> gives access to the global {{PRODUCTNAME}} application API while the property <code>ThisComponent<code> accesses the document related API.
+
The property <code>StarDesktop</code> gives access to the global {{PRODUCTNAME}} application API while the property <code>ThisComponent</code> accesses the document related API.
  
 
=== StarDesktop ===
 
=== StarDesktop ===
  
−
The property <code>StarDesktop</code> is a shortcut for the service <code>com.sun.star.frame.Desktop</code>.  
+
The property <code>StarDesktop</code> is a shortcut for the service <idl>com.sun.star.frame.Desktop</idl>.  
  
 
Example:
 
Example:
  
 +
<source lang="oobas">
 
   MsgBox StarDesktop.Dbg_SupportedInterfaces
 
   MsgBox StarDesktop.Dbg_SupportedInterfaces
 
    
 
    
Line 28: Line 30:
 
   oDesktop = CreateUnoService( "com.sun.star.frame.Desktop" )
 
   oDesktop = CreateUnoService( "com.sun.star.frame.Desktop" )
 
   MsgBox oDesktop.Dbg_SupportedInterfaces
 
   MsgBox oDesktop.Dbg_SupportedInterfaces
 +
</source>
  
 
The displayed message box differs slightly because <code>Dbg_SupportedInterfaces</code> displays "StarDesktop" as an object type of the desktop object in the first case and "com.sun.star.frame.Desktop" in the second. But the two objects are the same.
 
The displayed message box differs slightly because <code>Dbg_SupportedInterfaces</code> displays "StarDesktop" as an object type of the desktop object in the first case and "com.sun.star.frame.Desktop" in the second. But the two objects are the same.
Line 37: Line 40:
 
Basic module in a {{PRODUCTNAME}} document:
 
Basic module in a {{PRODUCTNAME}} document:
  
 +
<source lang="oobas">
 
   Sub Main
 
   Sub Main
 
       MsgBox ThisComponent.Dbg_SupportedInterfaces
 
       MsgBox ThisComponent.Dbg_SupportedInterfaces
 
   End Sub
 
   End Sub
 +
</source>
  
 
The execution of this Basic routine shows different results for a Text, Spreadsheet and Presentation document. Depending on the document type, a different set of interfaces are supported by the object. A portion of the interfaces are common to all these document types representing the general functionality that documents of any type offer. In particular, all {{PRODUCTNAME}} documents support the <idl>com.sun.star.document.OfficeDocument</idl> service, including the interfaces <idl>com.sun.star.frame.XStorable</idl> and <idl>com.sun.star.view.XPrintable</idl>. Another interface is <idl>com.sun.star.frame.XModel</idl>.
 
The execution of this Basic routine shows different results for a Text, Spreadsheet and Presentation document. Depending on the document type, a different set of interfaces are supported by the object. A portion of the interfaces are common to all these document types representing the general functionality that documents of any type offer. In particular, all {{PRODUCTNAME}} documents support the <idl>com.sun.star.document.OfficeDocument</idl> service, including the interfaces <idl>com.sun.star.frame.XStorable</idl> and <idl>com.sun.star.view.XPrintable</idl>. Another interface is <idl>com.sun.star.frame.XModel</idl>.
Line 84: Line 89:
  
 
As previously mentioned, <code>ThisComponent</code> is used from document Basic, but it is also possible to use it from application Basic. In an application wide Basic module, <code>ThisComponent</code> is identical to the current component that can also be accessed through <code>StarDesktop.CurrentComponent</code>. The only difference between the two is that if the BasicIDE is active, <code>StarDesktop.CurrentComponent</code> refers to the BasicIDE itself while <code>ThisComponent</code> always refers to the component that was active before the BasicIDE became the top window.
 
As previously mentioned, <code>ThisComponent</code> is used from document Basic, but it is also possible to use it from application Basic. In an application wide Basic module, <code>ThisComponent</code> is identical to the current component that can also be accessed through <code>StarDesktop.CurrentComponent</code>. The only difference between the two is that if the BasicIDE is active, <code>StarDesktop.CurrentComponent</code> refers to the BasicIDE itself while <code>ThisComponent</code> always refers to the component that was active before the BasicIDE became the top window.
 +
 +
=== ThisDatabaseDocument===
 +
 +
The property <code>ThisDatabaseDocument</code>, introduced since {{OOo}} 3.1, is only used from a Basic code which is embedded in a Base document. It refers to the Base document model.
 +
 +
Typically, when a macro is started by an event from a Form of the Base document, <code>ThisDatabaseDocument</code> represents the Base document, whereas <code>ThisComponent</code> refers to the Form document.
 +
 +
  
 
{{PDL1}}
 
{{PDL1}}
−
[[Category: Basic and Dialogs]]
+
 
 +
[[Category:Documentation/Developer's Guide/Basic and Dialogs]]

Revision as of 10:49, 21 June 2015



In OpenOffice.org Basic, the interaction between Basic and UNO is described on an elementary level. This section describes the interface between Basic and the UNO API at the level of the OpenOffice.org application.

This is realized by two predefined Basic properties:

  • StarDesktop
  • ThisComponent

The property StarDesktop gives access to the global OpenOffice.org application API while the property ThisComponent accesses the document related API.

StarDesktop

The property StarDesktop is a shortcut for the service com.sun.star.frame.Desktop.

Example: 

  MsgBox StarDesktop.Dbg_SupportedInterfaces
 
  ' is the same as
 
  Dim oDesktop
  oDesktop = CreateUnoService( "com.sun.star.frame.Desktop" )
  MsgBox oDesktop.Dbg_SupportedInterfaces

The displayed message box differs slightly because Dbg_SupportedInterfaces displays "StarDesktop" as an object type of the desktop object in the first case and "com.sun.star.frame.Desktop" in the second. But the two objects are the same.

ThisComponent

The property ThisComponent is used from document Basic, where it represents the document the Basic belongs to. The type of object accessed by ThisComponent depends on the document type. The following example shows the differences.

Basic module in a OpenOffice.org document: 

  Sub Main
      MsgBox ThisComponent.Dbg_SupportedInterfaces
  End Sub

The execution of this Basic routine shows different results for a Text, Spreadsheet and Presentation document. Depending on the document type, a different set of interfaces are supported by the object. A portion of the interfaces are common to all these document types representing the general functionality that documents of any type offer. In particular, all OpenOffice.org documents support the com.sun.star.document.OfficeDocument service, including the interfaces com.sun.star.frame.XStorable and com.sun.star.view.XPrintable. Another interface is com.sun.star.frame.XModel.

The following list shows the interfaces supported by all document types:

For more information about the functionality of these interfaces, see Frame-Controller-Model Paradigm in OpenOffice.org. This section also goes into detail about the general document API.

In addition to the common services or interfaces, each document type supports specific services or interfaces. The following list outlines the supported services and important interfaces:

A Text document supports:

A Spreadsheet document supports:

Presentation and Drawing documents support:

The usage of these services and interfaces is explained in the document type specific chapters Text Documents, Spreadsheet Documents and Drawing Documents and Presentation Documents.

As previously mentioned, ThisComponent is used from document Basic, but it is also possible to use it from application Basic. In an application wide Basic module, ThisComponent is identical to the current component that can also be accessed through StarDesktop.CurrentComponent. The only difference between the two is that if the BasicIDE is active, StarDesktop.CurrentComponent refers to the BasicIDE itself while ThisComponent always refers to the component that was active before the BasicIDE became the top window.

ThisDatabaseDocument

The property ThisDatabaseDocument, introduced since Apache OpenOffice 3.1, is only used from a Basic code which is embedded in a Base document. It refers to the Base document model.

Typically, when a macro is started by an event from a Form of the Base document, ThisDatabaseDocument represents the Base document, whereas ThisComponent refers to the Form document.


Content on this page is licensed under the Public Documentation License (PDL).
Retrieved from "https://wiki.openoffice.org/w/index.php?title=Documentation/DevGuide/Basic/Accessing_the_UNO_API&oldid=236430"
Personal tools
In other languages