EmbedObject (NotesRichTextItem - LotusScript®)

Given the name of a file or an application, does one of the following:

  • Attaches the file you specify to a rich text item.
  • Embeds an object in a rich text item. The object is created using either the application or the file you specify.
  • Places an object link in a rich text item. The link is created using the file you specify.
Note: Embedded objects and object links are not supported for UNIX™, and the Macintosh. File attachments are.

Defined in

NotesRichTextItem

Syntax

Set notesEmbeddedObject = notesRichTextItem .EmbedObject( type% , class$ , source$ , [ name$ ] )

Parameters

type%

Constant. Indicates if you want to create an attachment, an embedded object, or an object link. May be any of the following:

EMBED_ATTACHMENT (1454)

EMBED_OBJECT (1453)

EMBED_OBJECTLINK (1452)

class$

String.

  • If you are using EMBED_OBJECT and want to create an empty embedded object from an application, use this parameter to specify the name of the application (for example, "1-2-3® Worksheet") and specify an empty string ("") for source$. Case-sensitive.
  • If you are using EMBED_OBJECTLINK or EMBED_ATTACHMENT, specify an empty string ("").

source$

String.

  • If you are using EMBED_OBJECT and want to create an embedded object from a file, use this parameter to specify the name of the file, and specify an empty string ("") for class$.
  • If you are using EMBED_ATTACHMENT or EMBED_OBJECTLINK, use this parameter to specify the name of the file to attach or link.

name$

String. Optional. Name by which you can reference the NotesEmbeddedObject later. This parameter is only used for OLE/2 objects and does not include attachments.

Return value

notesEmbeddedObject

The newly attached file, embedded object, or linked object.

Usage

For this method to work you must set a default view in the database.

Files can be attached on any Notes® platform, but objects and links can only be created on platforms supporting OLE.

Files can be embedded as OLE/2 objects only on platforms supporting OLE, but they can be embedded as OLE/1 objects on any Notes® platform (if the file is of a supported type, such as a Domino® application data file).

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