IPopupMessage80
A popup message is an HTML pop-up window that contains Microsoft Internet Explorer browser or simple text. This interface enables you to set properties for the popup message, including size and position, and display time.
|
|
Properties |
|
|
|
Get and sets an alignment string that specifies the position of the pop-up window. |
|
|
|
Gets and sets a Boolean that enables/disables dragging of the pop-up window. |
|
|
|
Gets and sets a Boolean that enables/disables resizing of the pop-up window. |
|
|
|
Gets and sets a Boolean that determines whether the pop-up window jumps back to its original top, left position whenever the user resizes the 3D Window. |
|
|
|
Gets and sets the caption of the pop-up. |
|
|
|
Gets and sets HTML popup properties including allow drag, use last size, and use default position. |
|
|
|
Gets and sets a Boolean that determines whether the focus is set to the 3D Window after the message is triggered. |
|
|
|
Gets and sets the height of the pop-up window, in pixels or in percentage of the 3D Window. |
|
|
|
Gets the ID of the object. (Inherited from ITerraExplorerObject80) |
|
|
|
If the src property is undefined, the pop-up window utilizes an HTML page and lets the user modify its InnerHTML as in a regular HTML web page. |
|
|
|
If both src and InnerHTML properties are undefined, the pop-up window is a simple text string. The text string is determined via this property. |
|
|
|
Gets and sets the left x-coordinate where the pop-up will be displayed relative to the 3D Window. |
|
|
|
Gets an enum that identifies the type of the object. (Inherited from ITerraExplorerObject80) |
|
|
|
Gets and sets a Boolean that determines whether the object is saved in the Fly file. (Inherited from ITerraExplorerObject80) |
|
|
|
Gets and sets a URL that is the source HTML to be displayed in the pop-up window. |
|
|
|
Gets and sets the time in milliseconds that the pop-up window is displayed. |
|
|
|
Gets and sets the top y-coordinate where the pop-up will be displayed relative to the 3D Window. |
|
|
|
Gets and sets a Boolean that determines if a caption is used for the popup message. |
|
|
|
Gets and sets the width of the pop-up window, in pixels or in percentage of the 3D Window. |
|
|
|
Methods |
|
|
|
Gets an array of text strings assigned to each object global namespace. (Inherited from ITerraExplorerObject80) |
|
|
|
GetParam |
Reserved. Currently not used. |
|
|
Sets an array of text strings assigned to each object global namespace. (Inherited from ITerraExplorerObject80) |
|
|
|
SetParam |
Reserved. Currently not used. |
Align
Gets and sets an alignment string that specifies the position of the popup window. This string can be a combination of “Top/Bottom” and/or “Left/Right” e.g. “Top Right”.
Note: The alignment value applies to the 3D Window as it is sized when the alignment property is set, and does not update if the 3D Window is resized. If this property is undefined, the top left position is taken from the Top and Left properties.
|
JavaScript |
|
|
Align |
|
|
C# |
|
|
string Align { get; set; } |
|
|
C++ |
|
|
HRESULT Align([out, retval] BSTR* pVal) HRESULT Align([in] BSTR pVal) |
|
AllowDrag
Gets and sets a Boolean that enables/disables dragging of the pop-up window. If FALSE, the user will not be able change the position of the pop-up window.
|
JavaScript |
|
|
AllowDrag |
|
|
C# |
|
|
bool AllowDrag { get; set; } |
|
|
C++ |
|
|
HRESULT AllowDrag([out, retval] VARIANT_BOOL* pVal) HRESULT AllowDrag([in] VARIANT_BOOL pVal) |
|
AllowResize
Gets and sets a Boolean that enables/disables resizing of the pop-up window. If FALSE, the user will not be able to resize the pop-up window.
|
JavaScript |
|
|
AllowResize |
|
|
C# |
|
|
bool AllowResize { get; set; } |
|
|
C++ |
|
|
HRESULT AllowResize([out, retval] VARIANT_BOOL* pVal) HRESULT AllowResize([in] VARIANT_BOOL pVal) |
|
AnchorToView
Gets and sets a Boolean that determines whether the pop-up window jumps back to its original top, left position whenever the user resizes the 3D Window. If TRUE (default), the pop-up window jumps back to its original position.
|
JavaScript |
|
|
AnchorToView |
|
|
C# |
|
|
bool AnchorToView { get; set; } |
|
|
C++ |
|
|
HRESULT AnchorToView([out, retval] VARIANT_BOOL* pVal) HRESULT AnchorToView([in] VARIANT_BOOL pVal) |
|
Caption
Gets and sets the caption of the pop-up. If the caption is undefined, the pop-up will have no caption.
|
JavaScript |
|
|
Caption |
|
|
C# |
|
|
string Caption { get; set; } |
|
|
C++ |
|
|
HRESULT Caption([out, retval] BSTR* pVal) HRESULT Caption([in] BSTR pVal) |
|
Flags
Gets and sets an enum that determines the HTML popup’s properties. The following are the possible values:
§ HTML_POPUP_NONE = 0
§ HTML_POPUP_ANCHOR_3D_WINDOW = 1
§ HTML_POPUP_ALLOW_DRAG = 2
§ HTML_POPUP_NO_CAPTION = 4
§ HTML_POPUP_USE_DEFAULT_POS = 8
§ HTML_POPUP_USE_LAST_SIZE = 16
§ HTML_POPUP_ALLOW_RESIZE = 32
§ HTML_POPUP_ADD_SHADOW = 64
§ HTML_POPUP_NO_BORDER = 128
§ HTML_POPUP_SET_FOCUS_TO_RENDER = 256
§ HTML_POPUP_NOT_USE_POINTER = 512
§ HTML_POPUP_ALWAYS_VISIBLE = 1024
§ HTML_POPUP_USE_LAST_POS = 2048
§ HTML_POPUP_USE_TEXT_AS_INNER_HTML = 4096
§ HTML_POPUP_USE_AUTO_SIZE = 8192
§ HTML_POPUP_OPEN_LINK_IN_EXTERNAL_BROWSER = 16384
Opens in Internet Explorer browser if available.
§ HTML_POPUP_BRING_TO_FRONT = 32768
§ HTML_POPUP_ROUNDED_CORNERS = 65536
§ HTML_POPUP_USE_EDGE = 131072
Opens in Edge browser if available.
§ HTML_POPUP_MODAL_STYLE = 262144
This flag is not supported by TerraExplorer Fusion.
|
JavaScript |
|
|
Flags |
|
|
C# |
|
|
_HTML_POPUP_FLAGS Flags { get; set; } |
|
|
C++ |
|
|
HRESULT Flags([out, retval] _HTML_POPUP_FLAGS* pVal) HRESULT Flags([in] _HTML_POPUP_FLAGS pVal) |
|
FocusToRender
Gets and sets a Boolean that determines whether the focus is set to the 3D Window after the message is triggered.
|
JavaScript |
|
|
FocusToRender |
|
|
C# |
|
|
bool FocusToRender { get; set; } |
|
|
C++ |
|
|
HRESULT FocusToRender([out, retval] VARIANT_BOOL* pVal) HRESULT FocusToRender([in] VARIANT_BOOL pVal) |
|
Height
Gets and sets the height of the pop-up window, in pixels or in percentage of the 3D Window.
|
JavaScript |
|
|
Height |
|
|
C# |
|
|
int Height { get; set; } |
|
|
C++ |
|
|
HRESULT Height([out, retval] long* pVal) HRESULT Height([in] long pVal) |
|
InnerHTML
If the src property is undefined, the pop-up window utilizes a HTML page and lets the user modify its InnerHTML as in a regular HTML web page. This property gets and sets this InnerHTML.
|
JavaScript |
|
|
InnerHTML |
|
|
C# |
|
|
string InnerHTML { get; set; } |
|
|
C++ |
|
|
HRESULT InnerHTML([out, retval] BSTR* pVal) HRESULT InnerHTML([in] BSTR pVal |
|
InnerText
If both src and InnerHTML properties are undefined, the pop-up window is a simple text string. This property gets and sets this text string.
|
JavaScript |
|
|
InnerText |
|
|
C# |
|
|
string InnerText { get; set; } |
|
|
C++ |
|
|
HRESULT InnerText([out, retval] BSTR* pVal) HRESULT InnerText([in] BSTR pVal) |
|
Left
Gets and sets the left x-coordinate where the pop-up will be displayed relative to the 3D Window.
|
JavaScript |
|
|
Left |
|
|
C# |
|
|
int Left { get; set; } |
|
|
C++ |
|
|
HRESULT Left([out, retval] long* pVal) HRESULT Left([in] long pVal) |
|
Src
Gets and sets 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.
|
JavaScript |
|
|
Src |
|
|
C# |
|
|
string Src { get; set; } |
|
|
C++ |
|
|
HRESULT Src([out, retval] BSTR* pVal) HRESULT Src([in] BSTR pVal) |
|
Timeout
Gets and sets the time in milliseconds, the pop-up window is displayed. If this property is undefined, the pop-up is always displayed.
|
JavaScript |
|
|
Timeout |
|
|
C# |
|
|
int Timeout { get; set; } |
|
|
C++ |
|
|
HRESULT Timeout([out, retval] long* pVal) HRESULT Timeout([in] long pVal) |
|
Top
Gets and sets the top y-coordinate where the pop-up will be displayed relative to the 3D Window.
|
JavaScript |
|
|
Top |
|
|
C# |
|
|
int Top { get; set; } |
|
|
C++ |
|
|
HRESULT Top([out, retval] long* pVal) HRESULT Top([in] long pVal) |
|
ShowCaption
Gets and sets a Boolean that determines if a caption is used for the popup message.
|
JavaScript |
|
|
ShowCaption |
|
|
C# |
|
|
bool ShowCaption { get; set; } |
|
|
C++ |
|
|
HRESULT ShowCaption([out, retval] VARIANT_BOOL* pVal) HRESULT ShowCaption([in] VARIANT_BOOL pVal) |
|
Width
Gets and sets the width of the pop-up window, in pixels or in percentage of the 3D Window.
|
JavaScript |
|
|
Width |
|
|
C# |
|
|
int Width { get; set; } |
|
|
C++ |
|
|
HRESULT Width([out, retval] long* pVal) HRESULT Width([in] long pVal) |
|