IMessageObject80
Message objects in TerraExplorer are triggered when the user double-clicks the Project Tree entry that represents that 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 any of those objects.
When using TerraExplorer Viewer, the properties for the message object are read-only.
|
|
Properties |
|
|
|
Gets and sets the ID of the message object. |
|
|
|
Methods |
|
|
|
Activates the message object directly without triggering the associated object. |
|
|
|
Returns the interface of the message object directly from its owner object. |
MessageID
Gets and sets the ID of the message object.
|
JavaScript |
|
|
MessageID |
|
|
C# |
|
|
string MessageID { get; set; } |
|
|
C++ |
|
|
HRESULT MessageID([out, retval] BSTR* pVal) HRESULT MessageID([in] BSTR pVal) |
|
Activate
Activates a message object directly without triggering the associated owner object.
|
JavaScript |
|
|
Activate() |
|
|
C# |
|
|
void Activate() |
|
|
C++ |
|
|
HRESULT Activate() |
|
GetMessageObject
Returns the interface of the message object directly from its owner object.
Note: The returning ITerraExplorerObject80 object can be either of the following:
§ ITerraExplorerMessage80 (ObjectType is OT_MESSAGE = 22)
§ IPopupMessage80 (ObjectType is OT_POPUP_MESSAGE = 32)
|
JavaScript |
|
|
GetMessageObject() |
|
|
C# |
|
|
ITerraExplorerObject80 GetMessageObject() |
|
|
C++ |
|
|
HRESULT GetMessageObject( ITerraExplorerObject80** pITerraExplorerObject80) |
|
Return Value
ITerraExplorerObject80
An ITerraExplorerObject80, representing the message object.
Exceptions
See: HRESULT Return Values for a list of possible values returned by the HRESULT.