Enabled Property
Collapse the table of content
Expand the table of content

Timer.Enabled Property

 

Gets or sets a value indicating whether the Timer should raise the Elapsed event.

Namespace:   System.Timers
Assembly:  System (in System.dll)

[<TimersDescriptionAttribute("TimerEnabled")>]
member Enabled : bool with get, set

Property Value

Type: System.Boolean

true if the Timer should raise the Elapsed event; otherwise, false. The default is false.

Exception Condition
ObjectDisposedException

This property cannot be set because the timer has been disposed.

ArgumentException

The Interval property was set to a value greater than Int32.MaxValue before the timer was enabled.

Setting Enabled to true is the same as calling Start, while setting Enabled to false is the same as calling Stop.

System_CAPS_noteNote

The signal to raise the Elapsed event is always queued for execution on a ThreadPool thread. This might result in the Elapsed event being raised after the Enabled property is set to false. The code example for the Stop method shows one way to work around this race condition.

If Enabled is set to true and AutoReset is set to false, the Timer raises the Elapsed event only once, the first time the interval elapses.

If the interval is set after the Timer has started, the count is reset. For example, if you set the interval to 5 seconds and then set the Enabled property to true, the count starts at the time Enabled is set. If you reset the interval to 10 seconds when count is 3 seconds, the Elapsed event is raised for the first time 13 seconds after Enabled was set to true.

System_CAPS_noteNote

Some visual designers, such as those in Microsoft Visual Studio, set the Enabled property to true when inserting a new Timer.

The following example instantiates a Timer object that fires its Timer.Elapsed event every two seconds (2000 milliseconds), sets up an event handler for the event, and starts the timer. The event handler displays the value of the ElapsedEventArgs.SignalTime property each time it is raised.

No code example is currently available or this language may not be supported.

.NET Framework
Available since 1.1
Return to top
Show:
© 2016 Microsoft