getEmbeddedObject (RichTextItem - Java™)

Given the name of a file attachment, embedded object, or object link in a rich text item, returns the corresponding EmbeddedObject.

Note: Embedded objects and object links are not supported for OS/2, UNIX™, and the Macintosh. File attachments are.

Defined in

RichTextItem

Syntax

public EmbeddedObject getEmbeddedObject(String name)
    throws NotesException

Parameters

String name

String. The name of the object to find.

  • To find a file attachment, specify its file name. Specify just the file name not the full path.
  • To find an embedded object or object link, use the name of the object or link as it appears in the InfoBox, or as designated in the embedObject method.

Return value

EmbeddedObject

The object, if found. Otherwise, returns null.

Usage

If you modify the object returned by getEmbeddedObject, the changes are saved but the rendering of the object in the Domino® document is not updated until you manually activate the object.

In an open document in edit mode (the NotesDocument via NotesUIDocument.Document), changes made to rich text will not appear on screen immediately as they would with fields of other types. There is no method to cause this update to occur. You must close and reopen the document to see changes.

Example