Creates a step that sets the presentation to a specific date and time. The date and time that the presentation is set to affects the display of the sun, moon and the sun’s flares since they are displayed and positioned based on the time, date and time zone. The date and time also affect the display of all objects using the timespan property
JavaScript |
|
CreateSetTimeStep( AdvancedType, WaitTime, Time, GroupID) |
C# |
|
IPresentationStep66 CreateSetTimeStep( PresentationStepContinue AdvancedType, int WaitTime, object Time, int GroupID) |
C++ |
|
HRESULT CreateSetTimeStep( PresentationStepContinue AdvancedType, long WaitTime, BSTR Description, VARIANT Time, 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 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.
Time
The date and time that the presentation step is set to. The value can be any of the following:
· Javascript DateTime object
· VT_DATE
Note: DateTime (e.g. in C#) is automatically converted to VT_DATE.
· _time_t
Int or long values representing the number of seconds elapsed since 00:00:00 on January 1, 1970, Coordinated Universal Time.
· double
double values representing the number of milliseconds elapsed since 00:00:00 on January 1, 1970, Coordinated Universal Time.
· C# DateTime object.
Return Value
Step
An IPresentationStep66 representing the create time slider step that was created.
Exceptions
See: HRESULT Return Values for a list of possible values returned by the HRESULT.