Home > Working with SGWorld > Creator (ICreator6) > CreatePopupMessage

CreatePopupMessage

This method displays an HTML pop-up window that contains Microsoft Internet Explorer browser. or simple text.

 

JavaScript

 

CreatePopupMessage(

      Caption ,

      Src ,

      Left ,

      Top ,

      Width ,

      Height ,

      Timeout )

 

C#

 

IPopupMessage6 CreatePopupMessage(

      string Caption = "",

      string Src = "",

      int Left = 0,

      int Top = 0,

      int Width = 0,

      int Height = 0,

      int Timeout = -1)

 

C++

 

HRESULT CreatePopupMessage(

      BSTR Caption,

      BSTR Src,

      long Left,

      long Top,

      long Width,

      long Height,

      long Timeout,

      IPopupMessage6** pIPopupMessage6)

 

Parameters:

Caption

A caption string which is displayed on the pop-up window caption area. This parameter is also used as the pop-up window identifier. When using the same Caption names, the new content replaces the content of the window with the same name.

Src

A URL that is the source HTML to be displayed in the pop-up window. If this property is undefined, the pop-up is assumed to be a simple text string.

Left

The window top left X position (in pixels) relative to the 3D Window top left position.

Top

The window top left Y position (in pixels) relative to the 3D Window top left position.

Width

The width of the pop-up window (in pixels). This value includes all captions and borders.

Height

The pop-up window height (in pixels). This value includes all captions and borders.

Timeout

Sets the timeout in seconds for closing the pop-up window. Use -1 to disable this feature.

Return Value

pIPopupMessage6

An IPopupMessage6, representing the newly created message.

Exceptions

See: HRESULT Return Values for a list of possible values returned by the HRESULT.