Create a presentation step in which a popup window is displayed containing simple text.
|
JavaScript |
|
|
CreateCaptionStep( AdvancedType, WaitTime, Description, CaptionText, CaptionTimeout) |
|
|
C# |
|
|
IPresentationStep66 CreateCaptionStep( PresentationStepContinue AdvancedType, int WaitTime, string Description, string CaptionText, int CaptionTimeout) |
|
|
C++ |
|
|
HRESULT CreateCaptionStep( PresentationStepContinue AdvancedType, long WaitTime, BSTR Description, BSTR CaptionText, long CaptionTimeout, IPresentationStep66** 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 displaying the caption, 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.
CaptionText
The text message to be displayed when the caption step is reached in the presentation.
CaptionTimeout
The length of time the caption should display before it disappears.
Return Value
Step
An IPresentationStep66 representing the caption step that was created.
Exceptions
See: HRESULT Return Values for a list of possible values returned by the HRESULT.