CustomControlTimer class

A timer created by CustomControlContext.CreateTimer and owned by the control that created it. The timer raises OnTimer at the rate given by Interval, once it has been started by setting Enabled to True.

The framework returns timers typed as stdole.IUnknown; cast to CustomControlTimer with CType(Of CustomControlTimer)(…) before storing. Declare the field with WithEvents so that the OnTimer event can be handled.

Private WithEvents InternalTimer As CustomControlTimer

Private Sub OnInitialize(ByVal Ctx As CustomControls.CustomControlContext) _
        Implements CustomControls.ICustomControl.Initialize

    Set Me.ControlContext = Ctx
    Set Me.InternalTimer = CType(Of CustomControlTimer)(Ctx.CreateTimer())
    Me.InternalTimer.Interval = 250
    Me.InternalTimer.Enabled = True
End Sub

Private Sub OnTimer() Handles InternalTimer.OnTimer
    ' raised every 250 ms
End Sub

WaynesTimer wraps a single CustomControlTimer and re-exposes its Interval and Enabled as designer-visible properties. WaynesSlider uses one internally for mouse-down auto-repeat.

Properties

Enabled

Whether the timer is currently running. Read/write Boolean. Setting to True starts it; setting to False stops it.

Syntax: object.Enabled [ = value ]

value
A Boolean specifying the running state. True starts the timer; False stops it.

Interval

The number of milliseconds between successive OnTimer events. Read/write Long. A value of 0 prevents the timer from firing.

Syntax: object.Interval [ = value ]

value
A Long specifying the number of milliseconds between timer firings.

Changing Interval while the timer is running takes effect on the next tick — the current tick completes at the old interval before the new one begins.

Events

OnTimer

Raised every Interval milliseconds while the timer is enabled.

Syntax: object_OnTimer( )

See Also