How to return an HTML representation of a Lotus Notes rich-text field

Get Java code that returns an HTML representation of a Lotus Notes document's rich-text field to the calling routine.

This Java code will return an HTML version of a Lotus Notes rich-text field to the calling routine. Exceptions...

are handled via an excellent logging tool from

This Java code relies on being able to create a Lotus Notes document in the current Domino database using a form called MimeConvert.

The rich-text source field is appended to the RichTextField class on the MimeConvert form. Next, the Lotus Notes document is saved and then read as an InputStream; which gives an HTML representation of the entire page. Finally, the body is split away from the rest of the HTML page, leaving the HTML representation of the original RichTextField.

import lotus.domino.*;

public class HTMLConverter{
// standard logging object 

private OpenLogItem oli = new OpenLogItem();  
  // Method. parameters are the Server & 
Database to open that will be used to do the conversion, 
normally the current db; the NoteID of the document 
and the fieldname to load into our converter
 public String getHTML(Database thisdb, 
Document sourceDoc, String fieldName)
 throws NotesException, IOException {
// get the field that we need to examine
RichTextItem sourceField = (RichTextItem)

// Prepare a simple document in this database 
to store the richtextfield we want to convert to HTML
Document newND = thisdb.createDocument();  
RichTextItem newRTItem = newND.
newRTItem.appendRTItem(sourceField); true,true,true);

// get the URL that will open that document
URL docURL =new URL(newND.getHttpURL());

// Get document as an HTMLstring as seen by
 the current domino server  
BufferedReader bin = new BufferedReader 
( new InputStreamReader(docURL.openStream() )); 
// tidy up

// Convert the datastream into a string...
String line; 
StringBuffer sb = new StringBuffer();

while ( (line = bin.readLine( )) != null ) { 
String fullPage = sb.toString();

// fullPage now contains the HTML of the entire 
page but we only want the bit between the body tags.
String[] passOne = fullPage.split("</body>");
String[] body =passOne[0].
split("<body text="#000000" bgcolor="#FFFFFF">");

return body[1]; // this should contain 
only the text between the body tags.  

catch (Exception e) {
return null;



It is possible to accomplish the same thing with a LotusScript function:

Sub AppendNotesLink(db As notesdatabase,
rtitem As NotesRichTextItem,NotesUrL As String)
'# =================================
 'Auteur : Mostapha El yagoubi
'Date : 14/12/2007
 'Description :  'Sous outlook, 
les liens Notes:// ne sont pas
 cliquables lorsqu'on 
les colle en appendtext dans un 

 'Cette fonction permet de 
contourner le problème
 en créant un champ MIME temporaire
'On colle ensuite son contenu dans le richtext 
initial envoyé 
en paramètre (Methode Appendrtitem)
'# =============================
 '\* Déclarations
Dim tmpDoc As notesdocument
Dim tmpRtitem As NotesRichTextItem
Dim stream As NotesStream      
Dim mime As notesmimeentity
Dim EtatMime As Boolean
On Error Goto TrtErreur
'\* Création du doc temporaire 
(on ne l'enregistre pas)
Dim session As New notessession
Set tmpDoc = db.CreateDocument             
'\* Création du richText 
temporaire au format MIME  = 
on y colle le lien Notes://
Set mime = tmpDoc.
Set stream = session.CreateStream             
Call stream.WriteText(|<u>
<Font size="1" face="Arial" color="0000FF">
<a href="|  & NotesUrL  & |">| & Lcase(NotesUrL) 
& |</a></font></u>|)
Call mime.SetContentFromText(stream,
 "text/html", ENC_NONE)               
 EtatMime = session.ConvertMime
session.ConvertMime =
 True   '\ 
Autoriser la conversion le  MIMEen rich text
Call tmpDoc.
Set tmpRtitem = tmpDoc.GetFirstItem
'\* On colle le
 MIME dans le richtext
Call rtitem.Appendrtitem
session.ConvertMime = 
EtatMime  '\ 
On remet le flag mime a l'etat ou on
 l'avait trouvé
Sortie :
Exit Sub
TrtErreur:  '\* En cas d'erreur on 
ne fait rien on 
sort mâme si le lien doc n'est pas 
                        Print "Erreur " 
& Cstr(Err) & " -> " & 
Error$( Err ) & " à la ligne " 
& Erl & " : AppendNotesLink"
                        Resume Sortie
End Sub

—Mostapha E.


I tried to implement this for a project, but encountered several limitations. The routine worked only in Java (LS2J) and only on the Lotus Domino server.

To obtain the same results faster -- in LotusScript and/or Java and on the local database and/or Lotus Domino server -- set the storage content on the rich-text field of the second tab under "field properties" to "HTML and MIME."

There's no need to fetch the actual page using an HTTP socket, and the extra HTML tags, i.e. <html> and <body>, are parsed out.
—Thierry D.

Do you have comments on this tip? Let us know.

This tip was submitted to the tip library by member Philip West. Please let others know how useful it is via the rating scale below. Do you have a useful Lotus Notes, Domino, Workplace or WebSphere tip or code snippet to share? Submit it to our monthly tip contest and you could win a prize.

This was first published in December 2007

Dig Deeper



Forgot Password?

No problem! Submit your e-mail address below. We'll send you an email containing your password.

Your password has been sent to:




  • iSeries tutorials's tutorials provide in-depth information on the iSeries. Our iSeries tutorials address areas you need to know about...

  • V6R1 upgrade planning checklist

    When upgrading to V6R1, make sure your software will be supported, your programs will function and the correct PTFs have been ...

  • Connecting multiple iSeries systems through DDM

    Working with databases over multiple iSeries systems can be simple when remotely connecting logical partitions with distributed ...