activate (EmbeddedObject - Java)

Causes an embedded object or object link to be loaded by OLE.

Defined in



public int activate(boolean show)
    throws NotesException


boolean show

If true, the OLE server application displays its user interface. If false, the server application hides its user interface.

Return value


The OLE handle to the object. Returns null if the embedded object or object link does not support OLE automation.


Agents running on a server must set the show parameter to false.

This method throws an exception if you invoke it on an EmbeddedObject that is a file attachment.

This method may or may not return a valid OLE handle for object links, depending upon the application used to create the object link.