Lotus Symphony Object Model API in Lotus Symphony 1.3

Jin Hua, Chen, Symphony Programmability lead  |  Jul 21, 2009 10:17 PM
Profile image for Jin Hua, Chen In Lotus Symphony Toolkit 1.3. The biggest improvement is Lotus Symphony Object Model APIs. The APIs provide rich and easy to use API model for Lotus Symphony Spreadsheet, Document and Presentation. With the new API model, it is much more easier and quicker for developers to learn and to develop solutions compared with OpenOffice UNO model.

The Lotus Symphony Object Model provides APIs to control Lotus Symphony, such as opening documents, presentations and spreadsheets, or manipulating tables, paragraphs, sections of a document. The Lotus Symphony Object Model supports both Java and LotusScript on Windows and Linux. LotusScript support for Lotus Symphony object model is only available on embedded Lotus Symphony since Lotus Notes 8.5.1, which is coming soon.

Lotus Symphony Spreadsheet:

  • Open, save, close spreadsheet, both Microsoft Office format and ODF
  • Open spreadsheet in silent mode
  • Export to PDF
  • Import data from other format, like csv, ods or xls
  • Manipulate and format cell, range, named range
  • Create datapilot or chart


  • Lotus Symphony Document:

  • Open, save, close document, both Microsoft Office format and ODF
  • Open document in silent mode
  • Export to PDF
  • Manipulate and format table, table cell, section, user field, text range etc.


  • Lotus Symphony Presentation:

  • Open, save, close presentation document, both Microsoft Office format and ODF
  • Open presentation in silent mode
  • Export to PDF


  • The APIs will be continuously enhanced in future releases. We are working with more than a hundred design partners who are building their solutions to identify the important APIs. Your comments are always highly appreciated.

    The following diagrams are object model diagram for Document, Spreadsheet and Presentation. For more details, please download the Symphony Toolkit 1.3, and start to build your solutions on Lotus Symphony.

    3 Comments
    • Kavita Malani said on Sep 15, 2009 8:16 AM:

      I have got Lotus Notes 8.5.1 installed from tap but I could not find LotusScript support for Lotus Symphony embedded in Lotus Notes 8.5.1. Can you please help me to understand the same?
    • Sujeet said on Sep 18, 2011 5:03 PM:

      Hi Kavita, Check this out ...

      (Options)

      %INCLUDE "symphonylsx.lss"

      Dim symphony As New SymphonyApplication

      ‘These next lines will represent the

      ‘Documents collection and a Document object

      Dim symDocuments As SymphonyDocuments

      Option Public

      Option Declare

      %Include "symphonylsx.lss"

      Sub Initialize()

      'Declare the Notes object variables

      Dim sess As New NotesSession

      Dim db As NotesDatabase

      Dim v As NotesView

      Dim vnav As NotesViewNavigator

      Dim entry As NotesViewEntry

      Dim row As long

      'These lines obtain a handle to the 'Orders' view,

      'and the first entry in it.

      Set db = sess.Currentdatabase

      Set v = db.GetView("Orders")

      Set vnav = v.Createviewnav()

      Set entry = vnav.Getfirstdocument()

      If entry Is Nothing Then

      MsgBox "No do
    • david said on Jun 12, 2012 3:06 PM:

      alguein me podria decir que es API???
    Add Your Comment

    Comments are not monitored for the purpose of providing support. If you have issues with Lotus Symphony, visit the Support Forums.

    * indicates required fields

    Optionally include your email address so that if we need to, we can follow up your comment for more clarity. After you submit your comment, your email address will not be displayed and only your name will be displayed on the web.


    750 Character maximum