CreateMessageStep

The CreateMessageStep method creates a presentation step in which a message object is displayed in a container or floating popup. The message can be a text string, HTML page, image, script code, multiple links or any other file.

 

JavaScript
CreateMessageStep(       AdvancedType,       WaitTime,       Description,       MessageID)

 

C#
IPresentationStep6 CreateMessageStep(       PresentationStepContinue AdvancedType,       int WaitTime,       string Description,       string MessageID)

 

C++
HRESULT CreateMessageStep(       PresentationStepContinue AdvancedType,       long WaitTime,       BSTR Description,       BSTR MessageID,       IPresentationStep6** Step

 

Parameters

AdvancedType

An enum that determines how the presentation advances to the next step. The following are its possible values:

·         PSC_MOUSECLICK = 0
On Mouse click.

·         PSC_WAIT = 1
Automatically after the preset wait time.

WaitTime

After performing the step, the number of seconds to wait before the presentation should advance to the next step.

Description

A string describing the step that displays in the Presentation Editor. If an empty string is passed into this parameter, TerraExplorer assigns it a unique name.

MessageID

The ID of the message object to activate when this step is reached.

Return Value

Step

An IPresentationStep6 representing the message step that was created.

Exceptions

See: HRESULT Return Values for a list of possible values returned by the HRESULT.