HTMLPopup

This method displays an HTML pop-up window that contains Microsoft Internet Explorer browser. Use this window to display any text or HTML content. It's especially recommended to use the HTML pop-up window when you need the window to float above the 3D window area. Attempting to display an IFrame, Div, or transparent windows above the 3D window may cause flickering.

Unlike IObjectManager51::CreateMessage this method does not create a referencable message object that can be edited after creation.

Note: The HTML pop-up window is a separate browser window.

HRESULT HTMLPopup(

[in] MsgType Type,

[in] int X,

[in] int Y,

[in] int Width,

[in] int Height,

[in] BSTR Caption,

[in] BSTR Content,

[in, optional, defaultvalue(0)] long Flags,

[in, optional, defaultvalue(0)] int Timeout)

Parameters:

• Type – An enum that determines whether the message is a text or a URL. The MessageType enum has the following values:

• TYPE_TEXT = 0

• TYPE_URL = 1

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

• Y – 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.

• Caption – A caption string which is displayed in the pop-up window caption area. This parameter is also used as the pop-up window identifier. When using a PopupCaption name which is used by another window, the new content overrides the content of the window carrying the same name. Use this parameter with the IContainer2.RemoveURL method to remove the pop-up window.

• Content – The displayed data. The MessageType parameter determines how the Content parameter is interpreted. If the MessageType parameter is set to TYPE_TEXT, the parameter value functions as the displayed text or HTML string. If the MessageType parameter is set to TYPE_URL, the parameter value should be a Web page full URL address (or a full path name).

• Flags – The following flags can be used to customize the HTML Pop-up window:

• HTML_POPUP_ANCHOR_3D_WINDOW  = 1
  Defines whether the pop-up window moves when moving the 3D window.

• HTML_POPUP_ALLOW_DRAG         = 2
  Enables users to drag and move the pop-up window.

• HTML_POPUP_NO_CAPTION         = 4
  Removes the caption area. Note – you still need to set a caption string to identify the window and remove it.

• HTML_POPUP_USE_DEFAULT_POS         = 8
  Places the window in default position.

• HTML_POPUP_USE_LAST_SIZE     = 16
  Sets the window size according to the size of the last HTML pop-up window.

• HTML_POPUP_ALLOW_RESIZE         = 32
  Enables the users to resize the pop-up window.

• HTML_POPUP_ADD_SHADOW         = 64
  Adds a shadow to the pop-up window.
  Important – In some hardware and software configurations this feature may dramatically reduce performance.

• HTML_POPUP_NO_BORDER         = 128
  Removes the window border.

• HTML_POPUP_SET_FOCUS_TO_RENDER = 256
  When in embedded mode sets the application focus to the 3D window. If not used the focus is set to the pop-up content.

• HTML_POPUP_NOT_USE_POINTER = 512
  Displays the window without a pointer to the object.

• HTML_POPUP_ALWAYS_VISIBLE = 1024
  Defines whether the pop-up window is automatically hidden when the 3D window is not visible.

• HTML_POPUP_USE_LAST_POS = 2048
  Sets the window size according to the size of the last HTML pop-up window.

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

Return Values:

S_OK if the method call succeeded.