To get started with the Lotus Symphony LotusScript API, let's write our first code sample - the ever popular "Hello World" sample.
To start, create a new button in a Rich Text field in a document. Change the code selection drop-down to "LotusScript" and enter the (Options) section. To begin, every time you want to use the Lotus Symphony LotusScript API, you need to call the LSX. You do that with the following code:
%INCLUDE "symphonylsx.lss"
This tells LotusScript to load the Symphony LSX. It also enables LotusScript to do cool things like provide type-ahead for the custom LSX - even in buttons or in actions on a form or view.
Now let's write some code. Go into the Click section of the button and enter the following:
Dim application As SymphonyApplication Set application = New SymphonyApplication
To begin, we are creating an application variable and setting it to the SymphonyApplication class. We then set that variable to a new instance of that class. So how did I know what the object model for the API is? In that Toolkit download that I talked about in my last blog, if you go into the lsxapidoc folder, open the Index.html file. Click the Document API Link.
This gives you a complete roadmap for the Symphony LotusScript API for Documents. You can click on each class to get all of the properties, methods, and description of each class and some samples.
We are starting with SymphonyApplication. Think of this like the NotesSession class. You will call this class no matter which of the three Symphony applications you are using. You will not see anything on screen at this point. Symphony has loaded into memory. Next, we call the SymphonyDocuments class
Dim documents As SymphonyDocuments Set documents = application.Documents
We are defining and setting an instance of a class that defines the Symphony Application type. At this point, you will see Lotus Symphony load on your screen. Next, we set up a single document instance to work with:
Dim document As SymphonyDocument Set document = documents.AddDocument("",True,True)
Here, we have told Symphony to load a blank new document. The AddDocument method has the following properties: Set document = documents.AddDocument(Template, AsTemplate, Visible)
Since we are not using a template, we leave the first parameter blank. And since there is no template, you must set the AsTemplate property to False. The documentation will tell you that you can use True or False here when Template is blank, but trust me - use False. Otherwise you will crash Notes. I know by experience!. We are also setting Visible to true. This will display the blank new document within Lotus Symphony Documents in your Notes client. We then need to setup a range to work with:
Dim range As SymphonyTextRange Set range = document.content.End
If you are not working with a named object, like a bookmark or table cell, you have to work with a range. Since this is a blank document, the easiest range to work with is the entire document. So after defining our range variable, we set the range to the entire document contents using the document.content.End property. There is nothing in the document, so this is really just getting the cursor location, but it will work for our purpose. Last, we enter some text:
Call range.InsertBefore("Hello World")
Using the range.InsertBefore method, we enter our "Hello World" text. Here is the code in a copy and paste format:
%INCLUDE "symphonylsx.lss"
Dim application As SymphonyApplication Dim documents As SymphonyDocuments Dim document As SymphonyDocument Dim range As SymphonyTextRange
Set application = New SymphonyApplication Set documents = application.Documents Set document = documents.AddDocument("",True,True) Set range = document.content.End
Call range.InsertBefore("Hello World")
Once you exit the button, save the Notes document, change to Edit mode; click the button. You should see this:
You might have noticed that Symphony took a bit to load up. Leave the Symphony Document open and go back to the button. Click it again. You will notice that it is quite a bit faster. Symphony caches after the first load - and also uses a start-up procedure to speed itself up. In preference, you can set if this should load at startup. You can see that option here:
If you click that, you will notice a process called soffice.exe loads at Windows startup. Here is a view of that from Windows Task Manager:
If you disable that, the first time load will be significantly longer than without the startup pre-load. If you use Symphony regularly, I recommend you turn this on.
There you go - your first piece of Lotus Symphony LotusScript API code written!
New Media Tuesday - 8/31/2010
Tue, Aug 31st 2010 12:30p John Head Here is what's coming out today ... Movies Beatdown Best Of Soul Train Brainjacked Brothers & Sisters: Season #4 Ca$h Cemetery Junction Final Girl FlashForward: The Complete Series Forbidden Dreams Harry Brown House: Season #6 Lonesome Dove: The Series: Season #1 Marmaduke Middle, The: Season #1 NCIS: Los Angeles: Season #1 Naked Cities One Tree Hill: Season #7 Parenthood: Season #1 Persons Unknown: Season #1 Sexy Radio Sons Of Anarchy: Season #2 Thriller: The Complete Series (#18 in [read] Keywords: vista
wireless
44
Happy 20th Birthday to PSC!
Fri, Aug 27th 2010 10:20a John D Head Tomorrow, August 28th, marks the 20th birthday of PSC Group. The founders, Andrew Lauter and Bruce Bellak started the company out of a desire to do provide superior service and great technology consulting to their customers. I have personally been with PSC for 10 years and am proud to be part of this great company. And at 10 years, I am in the middle of the pack in terms of seniority ... we have one member of the team that has been here for 19 years and another for 18! Pretty incredible [read] Keywords: consulting
29
New Media Tuesday - 8/24/2010
Tue, Aug 24th 2010 12:30p John Head Here is what's coming out today ... Movies 90210: Season #2 Ax Men: Season #3 Black Orpheus: 2 Disc Edition: The Criterion Collection Days That Shook The World: The Complete Series Dexter: Season #4 (Blu-Ray) (#15 in the DVDPS Top 40) Dexter: Season #4 (#6 in the DVDPS Top 40) First Four Films Of Akira Kurosawa, The: Eclipse From The Criterion Collection Flight Of The Conchords: The Complete Collection Gangland: Season #5 Gossip Girl: Season #3 Jim Henson's Dinosaur Train: Dinosaurs Under [read] Keywords: symphony
eclipse
vista
70
MWLUG 2010 - Thoughts
Mon, Aug 23rd 2010 5:50p John D Head Last week, in Cleveland, Ohio, the second MWLUG took place. MWLUG 2010 was bigger and better than the first last year. Here are some thoughts on the conference: 1. The conference really came into it's own this year. As much as I liked being in Chicago last year - and being at the IBM Innovation Center - being a hotel in another city took MWLUG to it's user group roots. It felt like a user group conference - not something IBM ran. This was a good thing. 2. The attitude of the user group menta [read] Keywords: connections
ibm
lotusphere
community
networking
New Media Tuesday - 8/17/2010
Tue, Aug 17th 2010 10:20a John Head Here is what's coming out today ... Movies Black Orpheus: 2 Disc Edition: The Criterion Collection Ca$h Cemetery Junction Cougar Town: Season #1d Dark Oracle: The Complete Series Dexter: Season #4 (#8 in the DVDPS Top 40) Friday Night Lights: Season #4 Keeping Up With The Kardashians: Season #3 L'Enfance Nue: The Criterion Collection Last Song, The Max Headroom: The Complete Series (#3 in the DVDPS Top 40) One Tree Hill: Season #7 Orlando: SE Red Shoes, The: 2-Disc Edition: Criterion Coll [read] Keywords: mac
oracle
vista
wireless
PSC built BarillaUS.com featured on topsharepoint.com
Mon, Aug 16th 2010 10:10a John D Head PSC's Microsoft practice has gotten a great accolade: the Barilla website (www.barillaus.com) has been featured on topsharepoint.com Congratulations to the team at PSC for developing such a great site and being selected for topsharepoint.com! [read] Keywords: microsoft
40
New Media Tuesday - 8/10/2010
Wed, Aug 11th 2010 7:00a John Head Here is what's coming out today ... Movies 187: One Eight Seven Adam-12: Season #5 Casper's Scare School: Season #1 Crumb: The Criterion Collection Date Night Joneses Louie Bluie: The Criterion Collection Max Headroom: The Complete Series (#2 in the DVDPS Top 40) Mercy: Season #1 Minder: Season 3 Numb3rs: Season #6 Titan Maximum: Season #1 Trauma: Season #1 UFC 114: Rampage Vs. Evans: Ultimate 2 Disc Edition Computer Games Madden NFL 11 ( Xbox 360) Tritton AX Pro Dolby Digital Precis [read] Keywords: vista
113
Yellow Day Release: Updated OpenNTF.org Contacts Experience
Wed, Aug 11th 2010 6:50a John D Head In honor of Yellow Day, I am going to post a new version of the OpenNTF.org Contacts Experience. Here is what is new: - Support for Microsoft Office 2010 - Updates to Microsoft Office Label and Envelope Functionality - Started work on adding Label functionality - The beginnings of custom field functionality: The goal is to have custom templates that the user can select, but first we need custom fields. The first release just defines the basic fields and a way to customize them. More to com [read] Keywords: notes
symphony
microsoft
office
openntf
