NotesRichTextItem (LotusScript®)

Represents an item of type rich text.

Base class

Inherits from: NotesItem

Containment

Contained by: NotesDocument

Contains: NotesEmbeddedObject, NotesRichTextDocLink, NotesRichTextNavigator, NotesRichTextRange, NotesRichTextTable

Properties

DateTimeValue (from NotesItem)

EmbeddedObjects

IsAuthors (from NotesItem)

IsEncrypted (from NotesItem)

IsNames (from NotesItem)

IsProtected (from NotesItem)

IsReaders (from NotesItem)

IsSigned (from NotesItem)

IsSummary (from NotesItem)

LastModified (from NotesItem)

Name (from NotesItem)

Parent (from NotesItem)

SaveToDisk (from NotesItem)

Text (from NotesItem)

Type (from NotesItem)

ValueLength (from NotesItem)

Values (from NotesItem)

Methods

Abstract (from NotesItem)

AddNewLine

AddPageBreak

AddTab

AppendDocLink

AppendParagraphStyle

AppendRTItem

AppendStyle

AppendTable

AppendText

BeginInsert

BeginSection

Compact

Contains (from NotesItem)

ConverttoHTML

CopyItemToDocument (from NotesItem)

CreateNavigator

CreateRange

EmbedObject

EndInsert

EndSection

GetEmbeddedObject

GetFormattedText

GetHTMLReferences

GetMIMEEntity (from NotesItem)

GetNotesFont

GetUnformattedText

GetValueDateTimeArray (from NotesItem)

New

Remove (from NotesItem)

Update

Creation

To create a new NotesRichTextItem object, use one of the following:

  • New
Note: The New method is not supported in COM.
  • CreateRichTextItem method in NotesDocument

Given a document, New creates a rich text item on the document, with the name you specify.

Syntax

Dim variableName As New NotesRichTextItem( notesDocument , name$ )

or

Set notesRichTextItem = New NotesRichTextItem( notesDocument , name$ )

Parameters

notesDocument

The document on which to create a new rich text item.

name$

String. The name of the new rich text item.

Access

To access an existing NotesRichTextItem object, use the GetFirstItem method in NotesDocument.

Usage

Because NotesRichTextItem inherits from NotesItem, all of the NotesItem properties and methods can be used on a NotesRichTextItem, too.

When you change the value of a NotesRichTextItem object, the change is not written to disk until you call the Save method for the parent NotesDocument.

If you specify a new NotesRichTextItem object but do not add content to it, an item is not created when the document is saved.

Example