Export (0) Print
Expand All

Timer.Enabled Property

Gets or sets whether the timer is running.

[Visual Basic]
Public Overridable Property Enabled As Boolean
[C#]
public virtual bool Enabled {get; set;}
[C++]
public: __property virtual bool get_Enabled();
public: __property virtual void set_Enabled(bool);
[JScript]
public function get Enabled() : Boolean;
public function set Enabled(Boolean);

Property Value

true if the timer is currently enabled; otherwise, false. The default is false.

Remarks

The timer is not subject to garbage collection when the value is true.

Example

[Visual Basic, C#, C++] The following example implements a simple interval timer, which sets off an alarm every five seconds. When the alarm occurs, a MessageBox displays a count of the number of times the alarm has activated and asks the user whether the timer should continue running.

[Visual Basic] 
Public Class Class1
    Private Shared myTimer As New System.Windows.Forms.Timer()
    Private Shared alarmCounter As Integer = 1
    Private Shared exitFlag As Boolean = False    
    
    ' This is the method to run when the timer is raised.
    Private Shared Sub TimerEventProcessor(myObject As Object, _
                                           myEventArgs As EventArgs)
        myTimer.Stop()
        
        ' Displays a message box asking whether to continue running the timer.
        If MessageBox.Show("Continue running?", "Count is: " & alarmCounter, _
                            MessageBoxButtons.YesNo) = DialogResult.Yes Then
            ' Restarts the timer and increments the counter.
            alarmCounter += 1
            myTimer.Enabled = True
        Else
            ' Stops the timer.
            exitFlag = True
        End If
    End Sub
    
    Public Shared Sub Main()
        ' Adds the event and the event handler for the method that will
        ' process the timer event to the timer.
        AddHandler myTimer.Tick, AddressOf TimerEventProcessor
        
        ' Sets the timer interval to 5 seconds.
        myTimer.Interval = 5000
        myTimer.Start()
        
        ' Runs the timer, and raises the event.
        While exitFlag = False
            ' Processes all the events in the queue.
            Application.DoEvents()
        End While

    End Sub    

End Class


[C#] 
public class Class1 {
    static System.Windows.Forms.Timer myTimer = new System.Windows.Forms.Timer();
    static int alarmCounter = 1;
    static bool exitFlag = false;
 
    // This is the method to run when the timer is raised.
    private static void TimerEventProcessor(Object myObject,
                                            EventArgs myEventArgs) {
       myTimer.Stop();
 
       // Displays a message box asking whether to continue running the timer.
       if(MessageBox.Show("Continue running?", "Count is: " + alarmCounter, 
          MessageBoxButtons.YesNo) == DialogResult.Yes) {
          // Restarts the timer and increments the counter.
          alarmCounter +=1;
          myTimer.Enabled = true;
       }
       else {
          // Stops the timer.
          exitFlag = true;
       }
    }
 
    public static int Main() {
       /* Adds the event and the event handler for the method that will 
          process the timer event to the timer. */
       myTimer.Tick += new EventHandler(TimerEventProcessor);
 
       // Sets the timer interval to 5 seconds.
       myTimer.Interval = 5000;
       myTimer.Start();
 
       // Runs the timer, and raises the event.
       while(exitFlag == false) {
          // Processes all the events in the queue.
          Application.DoEvents();
       }
    return 0;
    }
 }
    

[C++] 
public __gc class Class1 {
    static System::Windows::Forms::Timer* myTimer = new System::Windows::Forms::Timer();
    static int alarmCounter = 1;
    static bool exitFlag = false;
 
    // This is the method to run when the timer is raised.
private:
    static void TimerEventProcessor(Object* /*myObject*/,
                                    EventArgs* /*myEventArgs*/) {
       myTimer->Stop();
 
       // Displays a message box asking whether to continue running the timer.
       if(MessageBox::Show(S"Continue running?", String::Format( S"Count is: {0}", __box(alarmCounter)), 
          MessageBoxButtons::YesNo) == DialogResult::Yes) {
          // Restarts the timer and increments the counter.
          alarmCounter +=1;
          myTimer->Enabled = true;
       }
       else {
          // Stops the timer.
          exitFlag = true;
       }
    }
 
public:
    static void Main() {
       /* Adds the event and the event handler for the method that will 
          process the timer event to the timer. */
       myTimer->Tick += new EventHandler(0, TimerEventProcessor);
 
       // Sets the timer interval to 5 seconds.
       myTimer->Interval = 5000;
       myTimer->Start();
 
       // Runs the timer, and raises the event.
       while(exitFlag == false) {
          // Processes all the events in the queue.
          Application::DoEvents();
       }
    }
 };

int main() {
    Class1::Main();
}    

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, .NET Compact Framework

See Also

Timer Class | Timer Members | System.Windows.Forms Namespace

Show:
© 2014 Microsoft