IToolTimerSink.OnToolTimer Method
Called when a MapControl tool timer fires.
Thread safety: This method does not have to be thread-safe, it will only be called by Carmenta Engine from the GUI thread.
OnToolTimer(System.Int32 deltaTime)
Called when a MapControl tool timer fires.Syntax
public System.Int32 OnToolTimer (
System.Int32 deltaTime
)Parameters
deltaTime
Type: System.Int32
The time in milliseconds since the last tool timer event.
The time in milliseconds since the last tool timer event.
Return Value
Type: System.Int32
The number of milliseconds to wait until the next call. If zero or less than zero is returned a default interval of 20 milliseconds is used.
The number of milliseconds to wait until the next call. If zero or less than zero is returned a default interval of 20 milliseconds is used.
Remarks
If a MapControl is connected to two tools (one normal and one touch tool) and both tools implement IToolTimerSink then the minimum requested timeout interval is used.
Platforms
Windows, Linux, Android