Home > All Other Interfaces > ITerraExplorerMessage

ITerraExplorerMessage6

Message objects in TerraExplorer are triggered when the user double-clicks on the Project Tree entry that represents the object. 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

Determines whether the message automatically appears in front of any other content that might already be present in the destination container.

Client

Determines the location of the message on the screen.

ClientData

A text string assigned to each object global namespace. C# exposes this property as get_ClientData and set_ClientData. (Inherited from ITerraExplorerObject6)

ID

The ID of the object. (Inherited from ITerraExplorerObject6)

ObjectType

An enum that identifies the type of the object. (Inherited from ITerraExplorerObject6)

SaveInFlyFile

A Boolean that determines whether the object is saved in the Fly file. (Inherited from ITerraExplorerObject6)

Text

A text message to be displayed once the message object is triggered.

Type

Determines whether the message is text, script, or a URL.

URL

The URL of the file to be displayed.

 

Methods

 

get_ClientData

This method is exposed only in C#. To use from C++ or JavaScript use the ClientData property. (Inherited from ITerraExplorerObject6)

GetParam

Reserved. Currently not used. (Inherited from ITerraExplorerObject6)

set_ClientData

This method is exposed only in C#. To use from C++ or JavaScript use the ClientData property. (Inherited from ITerraExplorerObject6)

SetParam

Reserved. Currently not used. (Inherited from ITerraExplorerObject6)