LibreOffice

https://wiki.documentfoundation.org/Documentation
Admin
LibreOffice is a free and open-source office suite that includes applications for word processing,...
Tokens:628,712
Snippets:6,165
Trust Score:9.4
Update:3 months ago
Show doc for...
Tokens:
Raw
### Bootstrap UNO with Automatic Office Start (C#)

Source: https://wiki.documentfoundation.org/Documentation/DevGuide/Professional_UNO

C# example to bootstrap UNO, automatically starting LibreOffice. This method uses registry keys or environment variables to find the installation and defaults to a pipe connection.

```csharp
//C# example. OOo is started automatically.
XComponentContext xContext = uno.util.Bootstrap.bootstrap();
```

--------------------------------

### Complete URI Examples - Extension (All Users)

Source: https://wiki.documentfoundation.org/Documentation/DevGuide/Scripting_Framework

Examples of URIs calling scripts stored in an extension installed for all users.

```uri
vnd.sun.star.script:myLibrary.myModule.myMacro?language=Basic&location=application
```

```uri
vnd.sun.star.script:myLibrary.myMacro.bsh?language=BeanShell&location=share:uno_packages/myExtension.oxt
```

```uri
vnd.sun.star.script:myLibrary.myMethod?language=Java&location=share:uno_packages/myExtension.oxt
```

```uri
vnd.sun.star.script:myLibrary.myMacro.js?language=JavaScript&location=share:uno_packages/myExtension.oxt
```

```uri
vnd.sun.star.script:myExtension.oxt|myScript|myModule.py$myFunction?language=Python&location=share:uno_packages
```

--------------------------------

### Text Conversion Example in Java

Source: https://wiki.documentfoundation.org/Documentation/DevGuide/OfficeDev/Frame-Controller-Model_Paradigm_in_OpenOffice.org

Demonstrates how to perform text conversion using the XTextConversion interface in OpenOffice. This example shows steps for getting the desktop, creating a document, inserting sample text, converting it, and inserting the converted text.

```Java
//***************************************************************************
// comment: Step 1: get the Desktop object from the office
// Step 2: open an empty text document
// Step 3: insert a sample text
// Step 4: convert sample text
// Step 5: insert converted text
//***************************************************************************
import com.sun.star.uno.UnoRuntime;
public class TextConversion {

    public static void main(String args[]) {
        // You need the desktop to create a document
        // The getDesktop method does the UNO bootstrapping, gets the
        // remote servie manager and the desktop object.
        com.sun.star.frame.XDesktop xDesktop = null;
        xDesktop = getDesktop();

        com.sun.star.text.XTextDocument xTextDocument =
            createTextdocument( xDesktop );
        com.sun.star.i18n.XTextConversion xTextConversion =
            getTextConversion();
        try {
            // Korean sample text
            String aHeader = "\u7b2c\u0020\u0031\u0020\u7ae0\u0020\ud55c\ubb38\uc758\u0020\uad6c\uc870\u0028\u69cb\u9020\u0029";
            String aText = "\uc6b0\uc120\u0020\ud55c\uc790\ub294\u0020\uc11c\uc220\uc5b4\u0020\u0028\u654c\u8ff0\u8a9e\u0029\uc758\u0020\uc704\uce58\uac00\u0020\uc6b0\ub9ac\ub9d0\uacfc\u0020\ub2e4\ub974\ub2e4\u002e";

```

--------------------------------

### UNO Client Execution and Output

Source: https://wiki.documentfoundation.org/Documentation/DevGuide/Writing_UNO_Components

Example command line to run the Java UNO client and connect to the previously started server. Shows the expected output from the client, including data read from the server.

```bash
I:\\tmp>java UnoExeClient uno:socket,host=localhost,port=2083;urp;test
 Available bytes : 5
 read 2:1,2
 Available bytes : 3
 read 3:3,4,5
 Terminating client
```

--------------------------------

### Install LibreOffice on Gentoo

Source: https://wiki.documentfoundation.org/Documentation/Install/Linux

Install the binary LibreOffice package from the Gentoo portage repository using the emerge command.

```bash
# emerge libreoffice-bin
```

--------------------------------

### Example Macro URL

Source: https://wiki.documentfoundation.org/Documentation/DevGuide/Office_Development

An example of a macro URL specifying library, module, and method with arguments.

```text
 macro:///MyLib.MyModule.MyMethod(foo,bar)
```

--------------------------------

### Start Office Bean on Windows

Source: https://wiki.documentfoundation.org/Documentation/DevGuide/JavaBean_for_Office_Components

Use this command to start the Office Bean on Windows with default settings, enabling it to listen for connections.

```bash
# WINDOWS
soffice.exe -bean -accept=pipe,name=<user.name>_Office;urp;StarOffice.NamingService
```

--------------------------------

### Install UNO Component using unopkg

Source: https://wiki.documentfoundation.org/Documentation/DevGuide/Writing_UNO_Components

Installs a UNO component extension package from the command line. Ensure you are in the OfficePath/program directory.

```bash
$ unopkg add /foo/bar/ExampleHandler.oxt
```

--------------------------------

### Start Office for UNO Connections

Source: https://wiki.documentfoundation.org/Documentation/DevGuide/Professional_UNO

Use this command to start the office application and enable it to accept UNO connections on a specific socket.

```bash
soffice --accept=socket,host=localhost,port=8100;urp
```

--------------------------------

### Test LibreOffice Installation

Source: https://wiki.documentfoundation.org/Documentation/Install/Linux

Verify the LibreOffice installation by running the command in the terminal. This command should launch the LibreOffice suite.

```bash
$ libreoffice

```

--------------------------------

### User-Defined Path Variable Configuration Example

Source: https://wiki.documentfoundation.org/Documentation/DevGuide/Office_Development

Example demonstrating how to configure user-defined path variables with environment-specific rules for Windows and Unix.

```xml
<?xml version="1.0" encoding="utf-8"?>
<oor:component-data oor:name="Substitution" oor:context="org.openoffice.Office"
xsi:schemaLocation="http://openoffice.org/2001/registry component-update.xsd"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:oor="http://openoffice.org/2001/registry"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <node oor:name="SharePoints">
        <node oor:name="MyDocuments" oor:op="replace">
            <node oor:name="1" oor:op="replace">
                <prop oor:name="Directory"><value>file:///H:/documents</value></prop>
                <node oor:name="Environment">
                    <prop oor:name="OS"><value>Windows</value></prop>
                </node>
            </node>
            <node oor:name="2" oor:op="replace">
                <prop oor:name="Directory"><value>file:///net/home/user/documents</value></prop>
                <node oor:name="Environment">
                    <prop oor:name="OS"><value>UNIX</value></prop>
                </node>
            </node>
        </node>
    </node>
</oor:component-data>
```

--------------------------------

### Example of creating a known URI

Source: https://wiki.documentfoundation.org/Documentation/DevGuide/Office_Development

Example demonstrating how to create a known URI using the `createKnown` constructor and constants from `com.sun.star.rdf.URIs`.

```APIDOC
## Example of creating a known URI

```
rdf.XURI xContentFile = rdf.URI.createKnown(rdf.URIs.ODF_CONTENTFILE);
```
```

--------------------------------

### Listing Markup for Multi-line Code Examples

Source: https://wiki.documentfoundation.org/Documentation/DevGuide/IDL_Documentation_Guidelines

Use the <listing> markup for presenting multi-line code examples. It supports different languages, as shown in the StarBASIC example.

```xml
<listing>
 This markup is used for multiple line code examples.
 Example:
 @example StarBASIC
 <listing>
 aCmp = StarDesktop.loadComponentFromURL( ... )
 if ( isnull(aCmp) )
 ....
 endif
 </listing>
</listing>
```

--------------------------------

### Start LibreOffice with Pipe Connection

Source: https://wiki.documentfoundation.org/Documentation/DevGuide/Professional_UNO

Command line to start LibreOffice with a pipe connection for UNO interprocess communication.

```bash
soffice --accept=pipe,name=pipe_name;urp
```

--------------------------------

### Start LibreOffice with Socket Connection

Source: https://wiki.documentfoundation.org/Documentation/DevGuide/Professional_UNO

Command line to start LibreOffice with a socket connection for UNO interprocess communication.

```bash
soffice --accept=socket,host=localhost,port=2002;urp
```

--------------------------------

### Test LibreOffice Installation

Source: https://wiki.documentfoundation.org/Documentation/Install/Linux

Verify the LibreOffice installation by running the 'libreoffice' command or its version-specific or 'soffice' alias. This should display the LibreOffice splash screen.

```bash
$ libreoffice
```

```bash
$ libreoffice$version
```

```bash
$ soffice
```

--------------------------------

### C++ UNO Bootstrap and Service Manager

Source: https://wiki.documentfoundation.org/Documentation/DevGuide/First_Steps

Illustrates the initial setup for C++ UNO applications, including bootstrapping the Office environment and obtaining the service manager. This is a foundational step for most C++ UNO interactions.

```cpp
#include <iostream>
#include <sal/main.h>
#include <cppuhelper/bootstrap.hxx>

#include <com/sun/star/beans/PropertyValue.hpp>
#include <com/sun/star/beans/XPropertySet.hpp>
#include <com/sun/star/container/XEnumerationAccess.hpp>
#include <com/sun/star/container/XEnumeration.hpp>
#include <com/sun/star/frame/XComponentLoader.hpp>
#include <com/sun/star/frame/XController.hpp>
#include <com/sun/star/frame/XModel.hpp>
#include <com/sun/star/lang/XComponent.hpp>
#include <com/sun/star/lang/XMultiComponentFactory.hpp>
#include <com/sun/star/sheet/CellFlags.hpp>
#include <com/sun/star/sheet/XCellAddressable.hpp>
#include <com/sun/star/sheet/XCellRangesQuery.hpp>
#include <com/sun/star/sheet/XSheetCellRanges.hpp>
#include <com/sun/star/sheet/XSpreadsheetDocument.hpp>
#include <com/sun/star/sheet/XSpreadsheet.hpp>
#include <com/sun/star/sheet/XSpreadsheets.hpp>
#include <com/sun/star/sheet/XSpreadsheetView.hpp>
#include <com/sun/star/table/CellVertJustify.hpp>
#include <com/sun/star/table/XCell.hpp>
#include <com/sun/star/uno/RuntimeException.hpp>
#include <com/sun/star/uno/Sequence.hxx>
#include <com/sun/star/uno/Type.hxx>
#include <com/sun/star/uno/XComponentContext.hpp>
#include <com/sun/star/uno/XInterface.hpp>

using namespace rtl;
using namespace cppu;
using namespace css::uno;
using namespace css::lang;
using namespace css::frame;
using namespace css::container;
using namespace css::sheet;
using namespace css::beans;
using namespace css::table;

SAL_IMPLEMENT_MAIN()
{
    try
    {
        Reference<XComponentContext> xRemoteContext = bootstrap();
        if (!xRemoteContext.is())
        {
            std::cerr << "ERROR: Could not bootstrap default Office.\n";
            return 1;
        }

        Reference<XMultiComponentFactory> xRemoteServiceManager
            = xRemoteContext->getServiceManager();


```

--------------------------------

### Multiple Platform Tokens

Source: https://wiki.documentfoundation.org/Documentation/DevGuide/Extensions

Example of specifying multiple platform tokens, separated by commas, for extension installation compatibility.

```xml
<platform value="windows_x86,linux_x86,solaris_sparc" />
```

--------------------------------

### Bootstrap UNO Service Manager with C++

Source: https://wiki.documentfoundation.org/Documentation/DevGuide/Writing_UNO_Components

Demonstrates bootstrapping a UNO service manager using C++ and the `defaultBootstrap_InitialComponentContext()` function. This is required for applications needing to connect to the office via UnoUrlResolver.

```cpp
#include <cppuhelper/bootstrap.hxx>

using namespace com::sun::star::uno;
using namespace com::sun::star::lang;
using namespace rtl;
using namespace cppu;
int main( )
{
    // create the initial component context
    Reference< XComponentContext > rComponentContext = 
        defaultBootstrap_InitialComponentContext();

    // retrieve the service manager from the context
    Reference< XMultiComponentFactory > rServiceManager = 
        rComponentContext()->getServiceManager();

    // instantiate a sample service with the service manager.
    Reference< XInterface > rInstance = 
        rServiceManger->createInstanceWithContext(
        OUString::createFromAscii("com.sun.star.bridge.UnoUrlResolver" ),
            rComponentContext );

    // continue to connect to the office ....
}
```

--------------------------------

### Set Numbering Types and Levels Example

Source: https://wiki.documentfoundation.org/Documentation/DevGuide/Text_Documents

Demonstrates setting numbering types and levels using the com.sun.star.text.NumberingRules service. This example requires setup for document cursor, text, factory, and relative text content insertion interfaces.

```java
/** This method demonstrates how to set numbering types and numbering levels using the
    com.sun.star.text.NumberingRules service
  */
protected void NumberingExample() {
    try {
        // Go to the end of the document
        mxDocCursor.gotoEnd(false);
        // Get the RelativeTextContentInsert interface of the document
        XRelativeTextContentInsert xRelative = (XRelativeTextContentInsert) 
            UnoRuntime.queryInterface(XRelativeTextContentInsert.class, mxDocText);

        // Use the document's factory to create the NumberingRules service, and get it's
        // XIndexAccess interface
        XIndexAccess xNum = UnoRuntime.queryInterface(XIndexAccess.class, 
            mxDocFactory.createInstance("com.sun.star.text.NumberingRules"));

        // Also get the NumberingRule's XIndexReplace interface
        XIndexReplace xReplace = UnoRuntime.queryInterface(
            XIndexReplace.class, xNum);

        // Create an array of XPropertySets, one for each of the three paragraphs we're about
        // to create
        XPropertySet xParas[] = new XPropertySet[3];
        for (int i = 0 ; i < 3 ; ++ i) {
            // Create a new paragraph
            XTextContent xNewPara = UnoRuntime.queryInterface(
                XTextContent.class, mxDocFactory.createInstance(
                    "com.sun.star.text.Paragraph"));

            // Get the XPropertySet interface of the new paragraph and put it in our array
            xParas[i] = UnoRuntime.queryInterface(
                XPropertySet.class, xNewPara);

            // Insert the new paragraph into the document after the fish section. As it is
            // an insert

```

--------------------------------

### Instantiate and Use UNO Services in Basic

Source: https://wiki.documentfoundation.org/Documentation/DevGuide/Writing_UNO_Components

LibreOffice Basic script demonstrating how to instantiate UNO service implementations and call their methods. It shows creating instances with and without arguments.

```basic
Sub Main

    REM calling service1 impl
    mgr = getProcessServiceManager()
    o = mgr.createInstance("my_module.MyService1")
    MsgBox o.methodOne("foo")
    MsgBox o.dbg_supportedInterfaces

    REM calling service2 impl
    dim args( 0 )
    args( 0 ) = "foo"
    o = mgr.createInstanceWithArguments("my_module.MyService2", args())
    MsgBox o.methodOne("bar")
    MsgBox o.dbg_supportedInterfaces

End Sub

```

--------------------------------

### Build LibreOffice with Help Support

Source: https://wiki.documentfoundation.org/Documentation/Screenshots

Build LibreOffice with the `--with-help` switch to enable help content generation, which is a prerequisite for creating screenshots for documentation.

```bash
--with-help
```

--------------------------------

### Path Substitution Example

Source: https://wiki.documentfoundation.org/Documentation/DevGuide/Office_Development

Demonstrates connecting to the LibreOffice service manager and obtaining the path substitution service.

```java
import com.sun.star.bridge.XUnoUrlResolver;
import com.sun.star.uno.UnoRuntime;
import com.sun.star.uno.XComponentContext;
import com.sun.star.lang.XMultiComponentFactory;
import com.sun.star.beans.XPropertySet;
import com.sun.star.beans.PropertyValue;

import com.sun.star.util.XStringSubstitution;
import com.sun.star.frame.TerminationVetoException;
import com.sun.star.frame.XTerminateListener;

/*
  * Provides example code how to access and use the
  * path substitution sercvice.
  */
public class PathSubstitutionTest {

    /*
      * List of predefined path variables supported by
      * the path substitution service.
      */
    private static String[] predefinedPathVariables = {
        "$(home)","$(inst)","$(prog)","$(temp)","$(user)", "$(username)",
        "$(work)","$(path)","$(langid)","$(vlang)"
    };

    /*
      * @param args the command line arguments
      */
    public static void main(String[] args) {

        XComponentContext xRemoteContext = null;
        XMultiComponentFactory xRemoteServiceManager = null;
        XStringSubstitution xPathSubstService = null;

        try {
            // connect
            XComponentContext xLocalContext =
                com.sun.star.comp.helper.Bootstrap.createInitialComponentContext(null);
            XMultiComponentFactory xLocalServiceManager = xLocalContext.getServiceManager();
            Object urlResolver = xLocalServiceManager.createInstanceWithContext(
                "com.sun.star.bridge.UnoUrlResolver", xLocalContext );
            XUnoUrlResolver xUnoUrlResolver = UnoRuntime.queryInterface(
                XUnoUrlResolver.class, urlResolver );
            Object initialObject = xUnoUrlResolver.resolve(
                "uno:socket,host=localhost,port=2083;urp;StarOffice.ServiceManager" );

```

--------------------------------

### Get Extension Location with C++

Source: https://wiki.documentfoundation.org/Documentation/DevGuide/Extensions

This C++ snippet demonstrates how to obtain the URL for an installed extension using the PackageInformationProvider singleton.

```cpp
namespace css = com::sun::star;
css::uno::Reference< css::uno::XComponentContext > mxContext;
...
css::uno::Reference< css::deployment::XPackageInformationProvider >
xInfoProvider( css::deployment::PackageInformationProvider::get( mxContext ) );

// "MY_PACKAGE_ID" is the identifier of the package whose location we want
rtl::OUString sLocation = xInfoProvider->getPackageLocation(
rtl::OUString::createFromAscii( "MY_PACKAGE_ID" ) );
...

```

--------------------------------

### Get Extension Location with Basic

Source: https://wiki.documentfoundation.org/Documentation/DevGuide/Extensions

This Basic example shows how to retrieve the package location of an extension using its identifier and the default context.

```basic
Dim pip As Object, extensionLocation As String
Const extensionIdentifier = "org.toto.test3"

pip = GetDefaultContext.getByName("/singletons/com.sun.star.deployment.PackageInformationProvider")
extensionLocation = pip.getPackageLocation(extensionIdentifier)
' display a human readable address
MsgBox(ConvertFromURL(extensionLocation))

```

--------------------------------

### Instantiate Universal Content Broker (Java)

Source: https://wiki.documentfoundation.org/Documentation/DevGuide/Universal_Content_Broker

Demonstrates how to create an instance of the UniversalContentBroker service, passing configuration keys for UCP registration. This should be done once per process.

```java
import com.sun.star.lang.XMultiServiceFactory;
import com.sun.star.uno.Exception;
import com.sun.star.uno.XInterface;

boolean initUCB() {

    /////////////////////////////////////////////////////////////////////
    // Obtain Process Service Manager.
    /////////////////////////////////////////////////////////////////////

    XMultiServiceFactory xServiceFactory = ...

    /////////////////////////////////////////////////////////////////////
    // Create UCB. This needs to be done only once per process.
    /////////////////////////////////////////////////////////////////////

    XInterface xUCB;
    try {
        // Supply configuration to use for this UCB instance...
        String[] keys = new String[2];
        keys[ 0 ] = "Local";
        keys[ 1 ] = "Office";

        xUCB = xServiceFactory.createInstanceWithArguments(
            "com.sun.star.ucb.UniversalContentBroker", keys );
    }
    catch (com.sun.star.uno.Exception e) {
    }

    if (xUCB == null)
        return false;

    return true;
}
```

--------------------------------

### Print Structured Filter

Source: https://wiki.documentfoundation.org/Documentation/DevGuide/Database_Access

Example of retrieving and printing the structured filter of a query. Requires setup of database connection and query access.

```java
// prints the structured filter
public static void printStructeredFilter(XMultiServiceFactory _rMSF) throws com.sun.star.uno.Exception {
    XNameAccess xNameAccess = (XNameAccess)UnoRuntime.queryInterface(
        XNameAccess.class, _rMSF.createInstance("com.sun.star.sdb.DatabaseContext"));
    // we use the first datasource
    XDataSource xDS = UnoRuntime.queryInterface(
        XDataSource.class, xNameAccess.getByName("Bibliography"));
    XConnection con = xDS.getConnection("", "");
    XQueriesSupplier xQuerySup = UnoRuntime.queryInterface(
        XQueriesSupplier.class, con);

    XNameAccess xQDefs = xQuerySup.getQueries();

    XPropertySet xQuery = UnoRuntime.queryInterface(
        XPropertySet.class,xQDefs.getByName("Query1"));
    String sCommand = (String)xQuery.getPropertyValue("Command");

    XSQLQueryComposerFactory xQueryFac = UnoRuntime.queryInterface(
        XSQLQueryComposerFactory.class, con);

    XSQLQueryComposer xQComposer = xQueryFac.createQueryComposer();
    xQComposer.setQuery(sCommand);

    PropertyValue aFilter [][] = xQComposer.getStructuredFilter();
    for (int i=0; i<aFilter.length; ) {
        System.out.println("( ");
        for (int j=0; j<aFilter[i].length; ++j)
            System.out.println("Name: " + aFilter[i][j].Name + " Value: " + aFilter[i][j].Value);
            System.out.println(")");
            ++i;
            if (i<aFilter.length )
                System.out.println(" OR ");
        }
    }
}
```

--------------------------------

### Get Desktop Instance

Source: https://wiki.documentfoundation.org/Documentation/DevGuide/Office_Development

Retrieves the XDesktop interface, which represents the main office application window. This is often the starting point for many automation tasks.

```java
public static com.sun.star.frame.XDesktop getDesktop() {
        com.sun.star.frame.XDesktop xDesktop = null;
        com.sun.star.lang.XMultiComponentFactory xMCF = null;

        try {
            com.sun.star.uno.XComponentContext xContext = null;

            // get the remote office component context
            xContext = com.sun.star.comp.helper.Bootstrap.bootstrap();

            // get the remote office service manager
            xMCF = xContext.getServiceManager();
            if( xMCF != null ) {
                System.out.println("Connected to a running office ...");
                Object oDesktop = xMCF.createInstanceWithContext(
                    "com.sun.star.frame.Desktop", xContext);
                xDesktop = UnoRuntime.queryInterface(
                    com.sun.star.frame.XDesktop.class, oDesktop);
                }
                else
                    System.out.println( "Can't create a desktop. No connection, no remote office servicemanager available!" );
            }
            catch( Exception e) {
                e.printStackTrace(System.err);
                System.exit(1);
            }

            return xDesktop;
        }
```

--------------------------------

### Launch Extension Manager GUI with unopkg

Source: https://wiki.documentfoundation.org/Documentation/DevGuide/Extensions

Execute 'unopkg gui' to open the Extension Manager dialog, allowing modification and addition of extensions.

```bash
[<OfficePath>/program] $ unopkg gui

```

--------------------------------

### Image URL Expansion Example

Source: https://wiki.documentfoundation.org/Documentation/DevGuide/Writing_UNO_Components

Illustrates how external user-defined image URLs are expanded by LibreOffice, showing the substitution of '%origin%' with the component's installation path.

```text
vnd.sun.star.expand:$UNO_USER_PACKAGES_CACHE/uno_packages/component.zip.1051610942/image
.
```

--------------------------------

### Frame Setup and Component Linking

Source: https://wiki.documentfoundation.org/Documentation/DevGuide/Office_Development

Methods for setting up a frame's container window and linking a component window and controller to the frame. The initialize method expects a top-level window.

```uno
// methods for container window
void initialize ( [in] com::sun::star::awt::XWindow xWindow);
com::sun::star::awt::XWindow getContainerWindow ();

// methods for component window and controller
boolean setComponent ( [in] com::sun::star::awt::XWindow xComponentWindow,
                        [in] com::sun::star::frame::XController xController );
com::sun::star::awt::XWindow getComponentWindow ();
com::sun::star::frame::XControllergetController ();
```

--------------------------------

### Example ScriptEditorForYourLanguage Implementation

Source: https://wiki.documentfoundation.org/Documentation/DevGuide/Scripting_Framework

A sample implementation of the ScriptEditor interface for a custom scripting language. It provides methods for editing, getting templates, and specifying file extensions.

```java
import com.sun.star.script.framework.provider.ScriptEditor;
import com.sun.star.script.provider.XScriptContext;
import com.sun.star.script.framework.container.ScriptMetaData;

import javax.swing.*;

public class ScriptEditorForYourLanguage implements ScriptEditor
{
    public Object execute()
    {
        return null;
    }

    public void indicateErrorLine( int lineNum )
    {
        return;
    }

    public void edit(XScriptContext context, ScriptMetaData entry)
    {
        JFrame frame = new JFrame();
        frame.setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE);

        JTextArea ta = new JTextArea();
        entry.loadSource();
        ta.setText(entry.getSource());

        frame.getContentPane().add(ta);
        frame.setSize(400, 400);
        frame.show();
    }

    public String getTemplate()
    {
        return "the code for a YourLanguage script";
    }

    public String getExtension()
    {
        return "yl";
    }
}
```

--------------------------------

### Create and Insert RectangleShape in Writer

Source: https://wiki.documentfoundation.org/Documentation/DevGuide/Text_Documents

Demonstrates creating a RectangleShape using the document factory and inserting it into the document. Requires setup to get the document cursor and factory.

```java
/** This method demonstrates how to create and manipulate shapes, and how to access the draw page
    of the document to insert shapes
  */
protected void DrawPageExample () {
    try {
        // Go to the end of the document
        mxDocCursor.gotoEnd(false);
        // Insert two new paragraphs
        mxDocText.insertControlCharacter(mxDocCursor,
        ControlCharacter.PARAGRAPH_BREAK, false);
        mxDocText.insertControlCharacter(mxDocCursor,
            ControlCharacter.PARAGRAPH_BREAK, false);

        // Get the XParagraphCursor interface of our document cursor
        XParagraphCursor xParaCursor = (XParagraphCursor) 
            UnoRuntime.queryInterface(XParagraphCursor.class, mxDocCursor);

        // Position the cursor in the 2nd paragraph
        xParaCursor.gotoPreviousParagraph(false);

        // Create a RectangleShape using the document factory
        XShape xRect = UnoRuntime.queryInterface(
            XShape.class, mxDocFactory.createInstance(
                "com.sun.star.drawing.RectangleShape"));

```

--------------------------------

### Help Content Provider URL Examples

Source: https://wiki.documentfoundation.org/Documentation/DevGuide/Universal_Content_Providers

Illustrative examples of URLs for the Help Content Provider, demonstrating various query parameters and path structures.

```text
_vnd.sun.star.help://?System=WIN &Language=de_
```

```text
_vnd.sun.star.help://swriter?System=WIN &Language=de&Query=text&HitCount=120&Scope=Heading_
```

```text
_vnd.sun.star.help://portal/4711?System=UNIX &Language=en_US&HelpPrefix=http%3A%2F%2Fportal%2Fportal_
```

--------------------------------

### Template Example: Fill Fields and Bookmarks

Source: https://wiki.documentfoundation.org/Documentation/DevGuide/Text_Documents

Demonstrates filling user text fields and inserting text at a bookmark in a loaded template. Requires a template file with predefined fields and bookmarks.

```java
/** Sample for use of templates
    This sample uses the file TextTemplateWithUserFields.odt from the Samples folder.
    The file contains a number of User text fields (Variables - User) and a bookmark
    which we use to fill in various values
  */
protected void templateExample() throws java.lang.Exception {
    // create a small hashtable that simulates a rowset
    HashMap<String,String> recipient = new HashMap<String,String>();
    recipient.put("Company", "Manatee Books");
    recipient.put("Contact", "Rod Martin");
    recipient.put("ZIP", "34567");
    recipient.put("City", "Fort Lauderdale");
    recipient.put("State", "Florida");

    // load template with User fields and bookmark
    java.io.File sourceFile = new java.io.File("TextTemplateWithUserFields.odt");
    StringBuffer sTemplateFileUrl = new StringBuffer("file:///");
    sTemplateFileUrl.append(sourceFile.getCanonicalPath().replace('\\', '/'));

    XComponent xTemplateComponent =
        newDocComponentFromTemplate( sTemplateFileUrl.toString() );

    // get XTextFieldsSupplier, XBookmarksSupplier interfaces
    XTextFieldsSupplier xTextFieldsSupplier = UnoRuntime.queryInterface(XTextFieldsSupplier.class,

```

--------------------------------

### Get Cell Range Address

Source: https://wiki.documentfoundation.org/Documentation/DevGuide/Spreadsheet_Documents

Retrieves the absolute address of a cell range, including sheet index, start, and end columns/rows. Useful for identifying ranges returned by other methods.

```java
// --- Get cell range address. ---
com.sun.star.sheet.XCellRangeAddressable xRangeAddr = (com.sun.star.sheet.XCellRangeAddressable) 
    UnoRuntime.queryInterface(com.sun.star.sheet.XCellRangeAddressable.class, xCellRange);
aRangeAddress = xRangeAddr.getRangeAddress();
System.out.println("Address of this range: Sheet=" + aRangeAddress.Sheet);
System.out.println(
    "Start column=" + aRangeAddress.StartColumn + "; Start row=" + aRangeAddress.StartRow);
System.out.println(
    "End column =" + aRangeAddress.EndColumn + "; End row =" + aRangeAddress.EndRow);
```

--------------------------------

### Create Writer Document in C++

Source: https://wiki.documentfoundation.org/Documentation/DevGuide/First_Steps

This C++ code snippet is a starting point for creating a new Writer document and manipulating its text. It requires the UNO API and appropriate setup.

```C++
void useWriter()
{
    // create new writer document and get text, then manipulate text

```

--------------------------------

### Getting UNO Type for Optional sal_Unicode

Source: https://wiki.documentfoundation.org/Documentation/DevGuide/Professional_UNO

Example of using getCppuType to obtain the UNO type for a polymorphic struct with sal_Unicode as a type argument. This is relevant when dealing with potential platform-specific type ambiguities.

```cpp
getCppuType(static_cast< com::sun::star::beans::Optional< sal_Unicode > >(0))
```

--------------------------------

### Create Calc Document (C++)

Source: https://wiki.documentfoundation.org/Documentation/DevGuide/First_Steps

C++ example for creating a Calc document and accessing its components using UNO query interfaces. This snippet focuses on initial setup and cell range retrieval.

```C++
void useCalc()
{
    // create new calc document and manipulate cell text
    Reference<XComponent> xCalcComponent = newDocComponent("scalc");
    Reference<XSpreadsheetDocument> xCalcDocument(xCalcComponent, UNO_QUERY_THROW);
    Reference<XSpreadsheetDocument> xSpreadsheetDocument
        = Reference<XSpreadsheetDocument>(xCalcDocument, UNO_QUERY);

    Reference<XIndexAccess> xIndexedSheets(xSpreadsheetDocument->getSheets(), UNO_QUERY);
    Reference<XCellRange> xSpreadsheetCells(xIndexedSheets->getByIndex(0), UNO_QUERY_THROW);

    //get cell A2 in first sheet
    Reference<XCell> xCell = xSpreadsheetCells->getCellByPosition(0, 1);

```

--------------------------------

### Path Substitution Service Example

Source: https://wiki.documentfoundation.org/Documentation/DevGuide/OfficeDev/Frame-Controller-Model_Paradigm_in_OpenOffice.org

Demonstrates how to connect to the OpenOffice service manager, access the path substitution service, and work with predefined path variables. This code is useful for understanding and utilizing path variable substitution within OpenOffice applications.

```Java
import com.sun.star.bridge.XUnoUrlResolver;
import com.sun.star.uno.UnoRuntime;
import com.sun.star.uno.XComponentContext;
import com.sun.star.lang.XMultiComponentFactory;
import com.sun.star.beans.XPropertySet;
import com.sun.star.beans.PropertyValue;

import com.sun.star.util.XStringSubstitution;
import com.sun.star.frame.TerminationVetoException;
import com.sun.star.frame.XTerminateListener;

/*
  * Provides example code how to access and use the
  * path substitution sercvice.
  */
public class PathSubstitutionTest {

    /*
      * List of predefined path variables supported by
      * the path substitution service.
      */
    private static String[] predefinedPathVariables = {
        "$(home)","$(inst)","$(prog)","$(temp)","$(user)", "$(username)",
        "$(work)","$(path)","$(langid)","$(vlang)"
    };

    /*
      * @param args the command line arguments
      */
    public static void main(String[] args) {

        XComponentContext xRemoteContext = null;
        XMultiComponentFactory xRemoteServiceManager = null;
        XStringSubstitution xPathSubstService = null;

        try {
            // connect
            XComponentContext xLocalContext =
                com.sun.star.comp.helper.Bootstrap.createInitialComponentContext(null);
            XMultiComponentFactory xLocalServiceManager = xLocalContext.getServiceManager();
            Object urlResolver = xLocalServiceManager.createInstanceWithContext(
                "com.sun.star.bridge.UnoUrlResolver", xLocalContext );
            XUnoUrlResolver xUnoUrlResolver = UnoRuntime.queryInterface(
                XUnoUrlResolver.class, urlResolver );
            Object initialObject = xUnoUrlResolver.resolve(
                "uno:socket,host=localhost,port=2083;urp;StarOffice.ServiceManager" );
            XPropertySet xPropertySet = UnoRuntime.queryInterface(
                XPropertySet.class, initialObject);
            Object context = xPropertySet.getPropertyValue("DefaultContext");
            xRemoteContext = UnoRuntime.queryInterface(
                XComponentContext.class, context);
            xRemoteServiceManager = xRemoteContext.getServiceManager();

            Object pathSubst = xRemoteServiceManager.createInstanceWithContext(
                "com.sun.star.comp.framework.PathSubstitution", xRemoteContext );
            xPathSubstService = UnoRuntime.queryInterface(
                XStringSubstitution.class, pathSubst);

            /* Work with path variables */
            workWithPathVariables( xPathSubstService );
        }
        catch (java.lang.Exception e) {
            e.printStackTrace();
        }
        finally {
            System.exit(0);
        }
    }

    /*
      * Retrieve, resubstitute path variables
      * @param xPathSubstService the path substitution service
      */
    public static void workWithPathVariables( XStringSubstitution xPathSubstService )
    {
        if ( xPathSubstService != null ) {
            for ( int i=0; i<predefinedPathVariables.length; i++ ) {
                try {
                        /* Retrieve values for predefined path variables */
                        String aPath = xPathSubstService.getSubstituteVariableValue(
                                            predefinedPathVariables[i] );
                        System.out.println( "Variable="+ predefinedPathVariables[i] +
                                            " Path=" + aPath );

                        /* Check resubstitute */
                        String aValue = xPathSubstService.reSubstituteVariables( aPath );
                        System.out.println( "Path=" + aPath +
                                            " Variable=" + aValue );
                }
                catch ( com.sun.star.container.NoSuchElementException e) {
                    System.out.println( "NoSuchElementException has been thrown accessing"
                                        + predefinedPathVariables[i]);
                }
            }
        }
    }
}
```

--------------------------------

### Image Identifier Example

Source: https://wiki.documentfoundation.org/Documentation/DevGuide/Writing_UNO_Components

Defines an optional image URL for menu items. Internal images use `private:image/<number>`, while external images use the `%origin%` placeholder for the component's installation folder.

```xml
%origin%/image
```

--------------------------------

### Create and Insert Text Table Example

Source: https://wiki.documentfoundation.org/Documentation/DevGuide/Text_Documents

Demonstrates creating a text table, initializing its dimensions, inserting it into the document, and setting background colors for rows and the table. Also shows inserting text and values into cells.

```java
/** This method shows how to create and insert a text table, as well as insert text and formulae
    into the cells of the table
  */
protected void TextTableExample ()
{
    try
    {
        // Create a new table from the document's factory
        XTextTable xTable = UnoRuntime.queryInterface(
            XTextTable.class, mxDocFactory .createInstance(
                "com.sun.star.text.TextTable" ) );

        // Specify that we want the table to have 4 rows and 4 columns
        xTable.initialize( 4, 4 );

        // Insert the table into the document
        mxDocText.insertTextContent( mxDocCursor, xTable, false);
        // Get an XIndexAccess of the table rows
        XIndexAccess xRows = xTable.getRows();

        // Access the property set of the first row (properties listed in service description:
        // com.sun.star.text.TextTableRow)
        XPropertySet xRow = UnoRuntime.queryInterface(
            XPropertySet.class, xRows.getByIndex ( 0 ) );
        // If BackTransparant is false, then the background color is visible
        xRow.setPropertyValue( "BackTransparent", Boolean.FALSE);
        // Specify the color of the background to be dark blue
        xRow.setPropertyValue( "BackColor", Integer.valueOf(6710932));

        // Access the property set of the whole table
        XPropertySet xTableProps = UnoRuntime.queryInterface(
            XPropertySet.class, xTable );
        // We want visible background colors
        xTableProps.setPropertyValue( "BackTransparent", Boolean.FALSE);
        // Set the background colour to light blue
        xTableProps.setPropertyValue( "BackColor", Integer.valueOf(13421823));

        // set the text (and text colour) of all the cells in the first row of the table
        insertIntoCell( "A1", "First Column", xTable );
        insertIntoCell( "B1", "Second Column", xTable );
        insertIntoCell( "C1", "Third Column", xTable );
        insertIntoCell( "D1", "Results", xTable );

        // Insert random numbers into the first this three cells of each
        // remaining row
        xTable.getCellByName( "A2" ).setValue( getRandomDouble() );
        xTable.getCellByName( "B2" ).setValue( getRandomDouble() );
        xTable.getCellByName( "C2" ).setValue( getRandomDouble() );

        xTable.getCellByName( "A3" ).setValue( getRandomDouble() );
        xTable.getCellByName( "B3" ).setValue( getRandomDouble() );

```

--------------------------------

### Getting UNO Type for Optional sal_uInt16

Source: https://wiki.documentfoundation.org/Documentation/DevGuide/Professional_UNO

Example of using getCppuType to obtain the UNO type for a polymorphic struct with sal_uInt16 as a type argument. This highlights the need to avoid ambiguous type mappings on certain platforms.

```cpp
getCppuType(static_cast< com::sun::star::beans::Optional< sal_uInt16 > >(0))
```

--------------------------------

### Demonstrate XTextColumns Interface and Text Insertion

Source: https://wiki.documentfoundation.org/Documentation/DevGuide/Text_Documents

This example shows how to use the XTextColumns interface to set up multi-column text sections and insert text content. It requires setup for document cursor, text, and factory objects.

```java
/** This method demonstrates the XTextColumns interface and how to insert a blank paragraph
    using the XRelativeTextContentInsert interface
  */
protected void TextColumnsExample() {
    try {
        // Go to the end of the doucment
        mxDocCursor.gotoEnd(false);
        // insert a new paragraph
        mxDocText.insertControlCharacter(mxDocCursor, ControlCharacter.PARAGRAPH_BREAK, false);

        // insert the string 'I am a fish.' 100 times
        for (int i = 0 ; i < 100 ; ++i) {
            mxDocText.insertString(mxDocCursor, "I am a fish.", false);
        }
        // insert a paragraph break after the text
        mxDocText.insertControlCharacter(mxDocCursor, ControlCharacter.PARAGRAPH_BREAK, false);

        // Get the XParagraphCursor interface of our text cursor
        XParagraphCursor xParaCursor = UnoRuntime.queryInterface(
            XParagraphCursor.class, mxDocCursor);
        // Jump back before all the text we just inserted
        xParaCursor.gotoPreviousParagraph(false);
        xParaCursor.gotoPreviousParagraph(false);

        // Insert a string at the beginning of the block of text
        mxDocText.insertString(mxDocCursor, "Fish section begins:", false);

        // Then select all of the text
        xParaCursor.gotoNextParagraph(true);
        xParaCursor.gotoNextParagraph(true);

        // Create a new text section and get it's XNamed interface
        XNamed xSectionNamed = UnoRuntime.queryInterface(
            XNamed.class, mxDocFactory.createInstance("com.sun.star.text.TextSection"));

        // Set the name of our new section (appropiately) to 'Fish'
        xSectionNamed.setName("Fish");

        // Create the TextColumns service and get it's XTextColumns interface
        XTextColumns xColumns = UnoRuntime.queryInterface(
            XTextColumns.class, mxDocFactory.createInstance("com.sun.star.text.TextColumns"));

        // We want three columns
        xColumns.setColumnCount((short) 3);

        // Get the TextColumns, and make the middle one narrow with a larger margin
        // on the left than the right
        TextColumn[] aSequence = xColumns.getColumns ();
        aSequence[1].Width /= 2;
        aSequence[1].LeftMargin = 350;
        aSequence[1].RightMargin = 200;
        // Set the updated TextColumns back to the XTextColumns
        xColumns.setColumns(aSequence);

        // Get the property set interface of our 'Fish' section
        XPropertySet xSectionProps = UnoRuntime.queryInterface(
            XPropertySet.class, xSectionNamed);

        // Set the columns to the Text Section
        xSectionProps.setPropertyValue("TextColumns", xColumns);

        // Get the XTextContent interface of our 'Fish' section
        mxFishSection = UnoRuntime.queryInterface(
            XTextContent.class, xSectionNamed);

        // Insert the 'Fish' section over the currently selected text
        mxDocText.insertTextContent(mxDocCursor, mxFishSection, true);

        // Get the wonderful XRelativeTextContentInsert interface
        XRelativeTextContentInsert xRelative = (XRelativeTextContentInsert) 
            UnoRuntime.queryInterface(XRelativeTextContentInsert.class, mxDocText);

        // Create a new empty paragraph and get it's XTextContent interface
        XTextContent xNewPara = UnoRuntime.queryInterface(XTextContent.class,
            mxDocFactory.createInstance("com.sun.star.text.Paragraph"));

        // Insert the empty paragraph after the fish Text Section
        xRelative.insertTextContentAfter(xNewPara, mxFishSection);
    } catch (Exception e) {
        e.printStackTrace(System.err);
    }
}
```

--------------------------------

### UCB Folder Child Access Example

Source: https://wiki.documentfoundation.org/Documentation/DevGuide/Universal_Content_Broker

Demonstrates how to open a UCB folder, request specific properties ('Title', 'IsFolder') for its children, and iterate through the results to access child content identifiers and property values. Requires prior setup of XContent and an executeCommand helper method.

```Java
import com.sun.star.uno.UnoRuntime;
import com.sun.star.ucb.*;
import com.sun.star.sdbc.XResultSet;
import com.sun.star.sdbc.XRow;

{
    XContent xContent = ...

    /////////////////////////////////////////////////////////////////////
    // Open a folder content, request property values for the string
    // property Title and the boolean property IsFolder...
    /////////////////////////////////////////////////////////////////////
    // Fill argument structure...

    OpenCommandArgument2 aArg = new OpenCommandArgument2();
    aArg.Mode = OpenMode.ALL;// FOLDER, DOCUMENTS -> simple filter
    aArg.Priority = 32768;// Ignored by most implementations

    // Fill info for the properties wanted.
    Property[] aProps = new Property[2];
    Property prop1 = new Property();
    prop1.Name = "Title";
    prop1.Handle = -1;// n/a
    aProps[0] = prop1;
    Property prop2 = new Property();
    prop2.Name = "IsFolder";
    prop2.Handle = -1;// n/a
    aProps[1] = prop2;

    aArg.Properties = aProps;

    XDynamicResultSet xSet;
    try {
        // Execute command "open".
        // using helper method executeCommand (see [CHAPTER:UCB.Using.Commands]).
        xSet = executeCommand(xContent, "open", aArg);
    }
    catch (com.sun.star.ucb.CommandAbortedException e) {
        ... error ...
    }
    catch (com.sun.star.uno.Exception e) {
        ... error ...
    }

    XResultSet xResultSet = xSet.getStaticResultSet();

    /////////////////////////////////////////////////////////////////////
    // Iterate over children, access children and property values...
    /////////////////////////////////////////////////////////////////////

    try {
        // Move to begin.
        if (xResultSet.first()) {
            // obtain XContentAccess interface for child content access and XRow for properties
            XContentAccess xContentAccess = UnoRuntime.queryInterface(
            XContentAccess.class, xResultSet);
            XRow xRow = UnoRuntime.queryInterface(XRow.class, xResultSet);
            do {
                // Obtain URL of child.
                String aId = xContentAccess.queryContentIdentifierString();

                // First column: Title (column numbers are 1-based!)
                String aTitle = xRow.getString(1);
                if (aTitle.length() == 0 && xRow.wasNull())
                    ... error ...

                // Second column: IsFolder
                boolean bFolder = xRow.getBoolean(2);
                if (!bFolder && xRow.wasNull())
                    ... error ...
            } while (xResultSet.next()) // next child
        }
    }
    catch (com.sun.star.ucb.ResultSetException e) {
        ... error ...
    }
}
```

--------------------------------

### Modify Spreadsheet Columns and Rows

Source: https://wiki.documentfoundation.org/Documentation/DevGuide/Spreadsheet_Documents

Demonstrates how to access and modify properties of spreadsheet columns and rows using UNO API. It shows getting columns by index and name, setting column width and visibility, and setting row height. Also includes examples of creating cell series and inserting/deleting rows.

```java
com.sun.star.beans.XPropertySet xPropSet = null;

// *** Modifying COLUMNS and ROWS ***
// Get column C by index (interface XIndexAccess).
Object aColumnObj = xColumns.getByIndex(2);
xPropSet = (com.sun.star.beans.XPropertySet) 
    UnoRuntime.queryInterface(com.sun.star.beans.XPropertySet.class, aColumnObj);
xPropSet.setPropertyValue("Width", Integer.valueOf(5000));

// Get the name of the column.
com.sun.star.container.XNamed xNamed = (com.sun.star.container.XNamed) 
    UnoRuntime.queryInterface(com.sun.star.container.XNamed.class, aColumnObj);
aText = "The name of this column is " + xNamed.getName() + ".";
xRange.getCellByPosition(2, 2).setFormula(aText);

// Get column D by name (interface XNameAccess).
com.sun.star.container.XNameAccess xColumnsName = (com.sun.star.container.XNameAccess) 
    UnoRuntime.queryInterface(com.sun.star.container.XNameAccess.class, xColumns);

aColumnObj = xColumnsName.getByName("D");
xPropSet = (com.sun.star.beans.XPropertySet) 
    UnoRuntime.queryInterface(com.sun.star.beans.XPropertySet.class, aColumnObj);
xPropSet.setPropertyValue("IsVisible", Boolean.FALSE);

// Get row 7 by index (interface XIndexAccess)
Object aRowObj = xRows.getByIndex(6);
xPropSet = (com.sun.star.beans.XPropertySet) 
    UnoRuntime.queryInterface(com.sun.star.beans.XPropertySet.class, aRowObj);
xPropSet.setPropertyValue("Height", Integer.valueOf(5000));

// Create a cell series with the values 1 ... 7.
for (int nRow = 8; nRow < 15; ++nRow)
    xRange.getCellByPosition( 0, nRow ).setValue( nRow - 7 );
// Insert a row between 1 and 2
xRows.insertByIndex(9, 1);
// Delete the rows with the values 3 and 4.
xRows.removeByIndex(11, 2);
```

--------------------------------

### Check LibreOffice Installation

Source: https://wiki.documentfoundation.org/Documentation/Install/Linux

Verify if LibreOffice is installed by attempting to run its executable. If the splash screen appears, it's still installed.

```bash
$ libreoffice

```

```bash
$ soffice

```

--------------------------------

### Start LibreOffice in Listening Mode via Command Line

Source: https://wiki.documentfoundation.org/Documentation/DevGuide/Professional_UNO

Use this command to start LibreOffice and make it listen on a specific socket for incoming connections. Ensure the command is quoted on Unix-like shells.

```bash
soffice --accept=socket,host=0,port=2002;urp;
```

--------------------------------

### Create Known URI Example

Source: https://wiki.documentfoundation.org/Documentation/DevGuide/Office_Development

Demonstrates creating a URI using a known constant from the com.sun.star.rdf.URIs constant group, such as for ODF content files.

```uno
rdf.XURI xContentFile = rdf.URI.createKnown(rdf.URIs.ODF_CONTENTFILE);
```
Tokens:
Raw