Skip to main content

NotesRichTextItem

Properties

NameDescription
EmbeddedObjects (NotesRichTextItem)Read-only. All the embedded objects, object links, and file attachments contained in a rich text item.

Methods

NameDescription
AddNewLineInserts one or more new lines (carriage returns) in a rich text item.
AddPageBreakInserts a hard page break in a rich text item.
AddTabInserts one or more tabs in a rich text item.
AppendDocLinkInserts a doclink in a rich text item.
AppendParagraphStyleInserts a paragraph style in a rich text item. Text following the paragraph style is rendered using that paragraph style's attributes.
AppendRTItemInserts the contents of one rich text item in another.
AppendStyleInserts a style in a rich text item. Text following the style is rendered using that style's attributes until another style is appended.
AppendTableInserts a table in a rich text item. The table text takes the current style of the item.
AppendTextInserts text in a rich text item. The text is rendered with the current style of the item (such as bold or italics).
BeginInsertChanges the insertion position from the end of the rich text item to the beginning or end of a specified element.
BeginSectionInserts a section in a rich text item.
Compact (NotesRichTextItem)Compacts a rich text item to take up minimum space.
CreateNavigator (NotesRichTextItem)Creates a NotesRichTextNavigator object.
CreateRangeCreates a NotesRichTextRange object.
EmbedObjectGiven the name of a file or an application, does one of the following:
EndInsertResets the insertion position to the end of the rich text item. Must be paired with BeginInsert.
EndSectionEnds a section. Must be paired with BeginSection.
GetEmbeddedObjectGiven the name of an embedded object or an object link in a rich text item, returns the corresponding NotesEmbeddedObject.
GetFormattedTextReturns the contents of a rich text item as plain text.
GetNotesFontReturns an identifier for a font face in a document.
GetUnformattedTextReturns the contents of a rich text item as plain text.
UpdateProcesses all pending operations on a rich text item.

Examples

NameDescription
Examples: Compact method (NotesRichTextItem)This agent compacts the Body item of the current or first selected document after a search and replace.
Examples: CreateNavigator method (NotesRichTextItem)This agent displays the number of elements of each type in the Body item of the selected document.
Examples: EmbeddedObjects property (NotesRichTextItem)This script goes through all the file attachments, object links, and embedded objects in the Body item of a document. Each time it finds a file…
Examples: IsExpanded property1. This agent displays the expansion status of each section in a rich text item.