ITerraExplorerMessage80

Message objects in TerraExplorer are triggered when the user double-clicks on the Project Tree entry that represents the object or clicks the object in the 3D Window. The message object defines the content of the message and where it should be displayed when triggered. Currently, the client can choose either a simple text message, HTML page to be displayed (allowing virtually an unlimited set of messages such as sounds or animated GIFs) or a script message. Several objects can simultaneously own the same message object, meaning that the same message is displayed when clicking on those objects.

When using TerraExplorer Viewer, the properties for the message object are read-only.

 

	Properties
	BringToFront	Gets and sets a Boolean that determines whether the message automatically appears in front of any other content that might already be present in the destination container.
	TargetPosition	Gets and sets the location of the message on the screen.
	ID	Gets the ID of the object. (Inherited from ITerraExplorerObject80)
	ObjectType	Gets an enum that identifies the type of the object. (Inherited from ITerraExplorerObject80)
	SaveInFlyFile	Reserved. Do not use.
	Text	Gets and sets a text message to be displayed when the message object is triggered.
	Type	Gets and sets an enum that determines whether the message is text, script, or a URL.
	URL	Gets and sets the URL of the file to be displayed.
	UseEdge	Gets and sets a Boolean that determines whether a container opens in Edge or Internet Explorer web browser.
	Methods
	GetClientData	Gets an array of text strings assigned to each object global namespace. (Inherited from ITerraExplorerObject80)
	GetParam	Reserved. Currently not used. (Inherited from ITerraExplorerObject80)
	SetClientData	Sets an array of text strings assigned to each object global namespace. (Inherited from ITerraExplorerObject80)
	SetParam	Reserved. Currently not used. (Inherited from ITerraExplorerObject80)

BringToFront

Gets and sets a Boolean that determines whether the message automatically appears in front of any other content (i.e. the Project Tree) that might already be present in the destination container. This property is ignored if the message type is set to TYPE_SCRIPT.

 

JavaScript
BringToFront

 

C#
bool BringToFront { get; set; }

 

C++
HRESULT BringToFront([out, retval] VARIANT_BOOL* pVal) HRESULT BringToFront([in] VARIANT_BOOL pVal)

TargetPosition

Gets and sets an enum determining the location of the message on the screen. The MsgTargetPosition enum can use any of the following values:

§   MTP_ LEFT = 0
The message appears in TerraExplorer's left container.

§   MTP_MAIN = 2
The message appears in TerraExplorer's main container.

§   MTP_MESSAGE_BAR = 3
The message appears in TerraExplorer's message bar.

§   MTP_FLOAT = 4
The message appears in the default web browser (outside of TerraExplorer).

§   MTP_POPUP = 5
The message appears in a floating pop-up window.

 

JavaScript
TargetPosition

 

C#
MsgTargetPosition TargetPosition { get; set; }

 

C++
HRESULT TargetPosition([out, retval] MsgTargetPosition* pVal) HRESULT TargetPosition([in] MsgTargetPosition pVal)

Text

Gets and sets a text message to be displayed when the message object is triggered. This parameter has effect on the message only if the Typeproperty is set to TYPE_TEXT or TYPE_SCRIPT.

 

JavaScript
Text

 

C#
string Text { get; set; }

 

C++
HRESULT Text([out, retval] BSTR* pVal) HRESULT Text([in] BSTR pVal)

Type

Gets and sets an enum that determines whether the message is text, script, or a URL. The MsgType enum has the following values:

§   TYPE_TEXT = 0

§   TYPE_URL    = 1

§   TYPE_SCRIPT = 3

 

JavaScript
Type

 

C#
MsgType Type { get; set; }

 

C++
HRESULT Type([out, retval] MsgType* pVal) HRESULT Type([in] MsgType pVal)

URL

Gets and sets the URL of the file to be displayed. This value applies only when Type is set to URL.

 

JavaScript
URL

 

C#
string URL { get; set; }

 

C++
HRESULT URL([out, retval] BSTR* pVal) HRESULT URL([in] BSTR pVal)

 

UseEdge

Gets and sets a Boolean that determines what web browser the message’s URL is opened in: Edge or Internet Explorer.

 

JavaScript
UseEdge

 

C#
bool UseEdge { get; set; }

 

C++
HRESULT UseEdge ([out, retval] VARIANT_BOOL* pVal) HRESULT UseEdge ([in] VARIANT_BOOL pVal)