loadSimpleIframe

Loads a simple iFrame into a location within Workspace.

Syntax

loadSimpleIframe(interfaceObject, source, location);

Parameters

  • interfaceObject - (Object) Object that launches the custom interface.
  • source - (string) A source URL for the simple Iframe. If null or an empty string, the source specified in customInterfaces.xml is used.
  • location - (string) (Optional) Either "areaD", "dialog", or "browser". If null or an empty string, the location specified in customInterfaces.xml is used, however, if "script" was specified in the definition, this parameter must be supplied, and an exception is thrown if location is not provided.

    The method throws an exception if the specified location is not valid, given the location of the menu item or toolbar button (interfaceObject) that launches the interface (see Valid Custom Interface Locations).

Returns

Returns the parent container for the iFrame that has been loaded, as follows:

  • jsx3.gui.Dialog (if 'dialog' location is specified)
  • jsx3.gui.Window (if 'browser' location is specified)
  • jsx3.gui.Block (if 'areaD' location is specified)