RichTextItem (Java™)

Syntax

public class RichTextItem extends Item

Base class

Inherits from: Item

Containment

Contained by: Document

Contains: EmbeddedObject

Property

DateTimeValue through getDateTimeValue and setDateTimeValue (from Item)

through getEmbeddedObjects

InputSource through getInputSource (from Item)

InputStream through getInputStream (from Item)

IsAuthors through isAuthors and setAuthors (from Item)

IsEncrypted through isEncrypted and setEncrypted (from Item)

IsNames through isNames and setNames (from Item)

IsProtected through isProtected and setProtected (from Item)

IsReaders through isReaders and setReaders (from Item)

IsSaveToDisk through isSaveToDisk and setSaveToDisk (from Item)

IsSigned through isSigned and setSigned (from Item)

IsSummary through isSummary and setSummary (from Item)

LastModified through getLastModified (from Item)

Name through getName (from Item)

Parent through getParent (from Item)

Reader through getReader (from Item)

Text through getText (from Item)

Type through getType (from Item)

ValueDouble through getValueDouble and setValueDouble (from Item)

ValueInteger through getValueInteger and setValueInteger (from Item)

ValueLength through getValueLength (from Item)

Values through getValues and setValues (from Item)

ValueString through getValueString and setValueString (from Item)

Methods

AbstractText (from Item)

addNewLine

addPageBreak

addTab

appendDocLink

appendParagraphStyle

appendRTItem

appendStyle

appendTable

appendText

appendToTextList (from Item)

beginInsert

beginSection

compact

containsValue (from Item)

copyItemToDocument (from Item)

createNavigator

createRange

embedObject

endInsert

endSection

getEmbeddedObject

getFormattedText

getMIMEEntity (from Item)

getNotesFont

getUnformattedText

getValueCustomData (from Item)

getValueCustomDataBytes (from Item)

parseXML (from Item)

recycle

remove (from Item)

setValueCustomData (from Item)

setValueCustomDataBytes (from Item)

toString (from Item)

transformXML (from Item)

update

Creation

To create a new RichTextItem object, use createRichTextItem in Document.

Access

To access an existing RichTextItem object, use getFirstItem in Document. You must explicitly cast the return value to RichTextItem.

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

When you change the value of a RichTextItem object, the change is not written to disk until you call save for the parent Document object.

Example