rtLib — Notes Rich Text Management Library Documentation of rtLib — Notes Rich Text Management Library Download rtLib — Notes Rich Text Management Library FAQ of rtLib — Notes Rich Text Management Library Purchase rtLib — Notes Rich Text Management Library Feedback about rtLib — Notes Rich Text Management Library

rtLibrary classes vs. Domino 6 Rich Text classes

NotesRichTextItem and NotesRichTextNavigator vs. rtContainer

Start search Mail feedback Back to Description


NotesRichTextItem
Property
EmbeddedObjects
Methods
AddNewLine
AddPageBreak
AddTab
AppendDocLink
AppendParagraphStyle
AppendRTItem
AppendStyle
AppendTable
AppendText
BeginInsert
CreateNavigator
CreateRange
EmbedObject
EndInsert
GetEmbeddedObject
GetFormattedText
New
NotesRichTextNavigator
Clone
FindFirstElement
FindLastElement
FindNextElement
FindNthElement
GetElement
GetFirstElement
GetLastElement
GetNextElement
GetNthElement
SetPosition
SetPositionAtEnd

rtContainer
Properties

All As rtCollection
BeginInsert
defineLabel
defineLabelAsText
docLinks As rtEnumeration
hotspots As rtEnumeration
sections As rtEnumeration
As rTextRange
Style As rtStyle
tables As rtEnumeration
textRuns As rtEnumeration
Methods
add
addAfter
addNewLine As rTextParagraph
appendItemValue
appendStyle
appendText As rTextParagraph
AddBefore
AddCollection
contains
createTextRange As rTextRange
Collection As rtCollection
EndInsert
Find As rTextRange
FindNext As rTextRange

getFirstElement
getLastElement
getNextElement
getPrevElement
getRichTextItem
importRTF
New
remove
replaceItemValue

Replace

rtContainer handles methods split over two classes in this section NotesRichTextItem itself and NotesRichTextNavigator.
Differences
The basic difference between rtContainer and NotesRichTextItem classes is that NotesRichTextItem is a part of document, while rtContainer treats rich text objects independent of any particular document or item. In order to save the changes in NotesRichTextItem it is enough to save the document, to save changes in rtContainer it is necessary to use ReplaceItemValue or AppendItemValue methods to associate the rich text fragment with a particular document and item.
NotesRichTextNavigator separates navigation methods from content creation/retrieval methods executed by NotesRichTextItem. rtContainer handles both task groups.
There are also a number of smaller implementation details.
Ommissions
rtLibrary does not deal with embedded objects as well as it does not provide a direct counterpart of several AppendXXX and AddXXX methods. The equivalent for rtContainer is to use constructors (New methods) of the classes and use Add method of rtContainer (or objects that may contain other elements) with object to be appended included as an argument.
Missing are also Clone, SetPosition and GetPosition methods. rtContainer navigation method does not need these as it allows an argument for getXxxElement methods to indicate the relative start position of the search.
FindXxxElement are missing in rtLibrary - instead compare result of getXxxElement method to Nothing to check if search has failed.
Suplementary features
rtContainer provides several alternative ways of navigation both sequential/hierarchical or depending on element type.
rtContainer not only allows to navigate and create rich text item content, but also provides extended text search and replace functionality including wildcards, special characters, search across several paragraphs and optionally searching/replacing other element labels (not only pure text).
There is also a method to import MS RTF file (importRTF). It works in Windows only and may not do 100% fidelity job.