setInterfaceCaption

Sets the image and text that display in the caption area of the container for the custom interface. By default, the image and displayText settings for the custom interface are displayed in the caption. This method provides a means for changing the caption. Note that for interfaces opened in a browser window, only the text parameter is applicable; the image parameter is ignored.

Syntax

setInterfaceCaption(containerObject, text, image);

Parameters

  • containerObject - (Object) The parent container of the custom interface; returned by the loadSimpleIframe, loadSimpleHubIframe, loadSimplePrototype, and loadCustomInterface methods.
  • text - (string) Text that displays in the caption.
  • image - (string) Path to the image that displays in the caption.

Returns

None