Timer.Enabled Свойство

Определение

Пространство имен:

System.Timers

Сборки:

netstandard.dll, System.ComponentModel.TypeConverter.dll

Исходный код:

Timer.cs

Возвращает или задает значение, указывающее, следует ли Timer вызывать Elapsed событие.

public:
 property bool Enabled { bool get(); void set(bool value); };

public bool Enabled { get; set; }

member this.Enabled : bool with get, set

Public Property Enabled As Boolean

Значение свойства

Boolean

true Timer Значение Elapsed, falseесли событие должно вызываться; в противном случае . Значение по умолчанию — false.

Исключения

ObjectDisposedException

Это свойство нельзя задать, так как таймер был удален.

ArgumentException

Для Interval свойства было задано значение, большее, чем Int32.MaxValue до включения таймера.

Примеры

В следующем примере создается экземпляр объекта, который запускает событие Timer.Elapsed каждые две секунды (2000 миллисекунд), настраивает Timer обработчик событий для события и запускает таймер. Обработчик событий отображает значение ElapsedEventArgs.SignalTime свойства при каждом вызове.

using System;
using System.Timers;

public class Example
{
    private static Timer aTimer;

    public static void Main()
    {
        // Create a timer and set a two second interval.
        aTimer = new System.Timers.Timer();
        aTimer.Interval = 2000;

        // Hook up the Elapsed event for the timer. 
        aTimer.Elapsed += OnTimedEvent;

        // Have the timer fire repeated events (true is the default)
        aTimer.AutoReset = true;

        // Start the timer
        aTimer.Enabled = true;

        Console.WriteLine("Press the Enter key to exit the program at any time... ");
        Console.ReadLine();
    }

    private static void OnTimedEvent(Object source, System.Timers.ElapsedEventArgs e)
    {
        Console.WriteLine("The Elapsed event was raised at {0}", e.SignalTime);
    }
}
// The example displays output like the following: 
//       Press the Enter key to exit the program at any time... 
//       The Elapsed event was raised at 5/20/2015 8:48:58 PM 
//       The Elapsed event was raised at 5/20/2015 8:49:00 PM 
//       The Elapsed event was raised at 5/20/2015 8:49:02 PM 
//       The Elapsed event was raised at 5/20/2015 8:49:04 PM 
//       The Elapsed event was raised at 5/20/2015 8:49:06 PM

open System.Timers

let onTimedEvent source (e: ElapsedEventArgs) =
    printfn $"The Elapsed event was raised at {e.SignalTime}"

// Create a timer and set a two second interval.
let aTimer = new Timer()
aTimer.Interval <- 2000

// Hook up the Elapsed event for the timer. 
aTimer.Elapsed.AddHandler onTimedEvent

// Have the timer fire repeated events (true is the default)
aTimer.AutoReset <- true

// Start the timer
aTimer.Enabled <- true

printfn "Press the Enter key to exit the program at any time... "
stdin.ReadLine() |> ignore

// The example displays output like the following: 
//       Press the Enter key to exit the program at any time... 
//       The Elapsed event was raised at 5/20/2015 8:48:58 PM 
//       The Elapsed event was raised at 5/20/2015 8:49:00 PM 
//       The Elapsed event was raised at 5/20/2015 8:49:02 PM 
//       The Elapsed event was raised at 5/20/2015 8:49:04 PM 
//       The Elapsed event was raised at 5/20/2015 8:49:06 PM

Imports System.Timers

Public Module Example
    Private aTimer As Timer

    Public Sub Main()
        ' Create a timer and set a two second interval.
        aTimer = New System.Timers.Timer()
        aTimer.Interval = 2000

        ' Hook up the Elapsed event for the timer.  
        AddHandler aTimer.Elapsed, AddressOf OnTimedEvent

        ' Have the timer fire repeated events (true is the default)
        aTimer.AutoReset = True

        ' Start the timer
        aTimer.Enabled = True

        Console.WriteLine("Press the Enter key to exit the program at any time... ")
        Console.ReadLine()
    End Sub

    Private Sub OnTimedEvent(source As Object, e As System.Timers.ElapsedEventArgs)
        Console.WriteLine("The Elapsed event was raised at {0}", e.SignalTime)
    End Sub
End Module
' The example displays output like the following: 
'       Press the Enter key to exit the program at any time... 
'       The Elapsed event was raised at 5/20/2015 8:48:58 PM 
'       The Elapsed event was raised at 5/20/2015 8:49:00 PM 
'       The Elapsed event was raised at 5/20/2015 8:49:02 PM 
'       The Elapsed event was raised at 5/20/2015 8:49:04 PM 
'       The Elapsed event was raised at 5/20/2015 8:49:06 PM

Комментарии

true Параметр Enabled имеет то же значение, что и вызовStart, а для false параметра Enabled совпадает с вызовомStop.

Замечание

Сигнал для поднятия Elapsed события всегда помещается в очередь для выполнения в потоке ThreadPool . Это может привести к Elapsed возникновению события после Enabled задания falseсвойства. В примере кода для Stop метода показан один из способов обойти это условие гонки.

Если Enabled задано true значение и AutoReset задано falseзначение , Timer событие вызывается Elapsed только один раз, при первом истечении интервала.

Если интервал установлен после Timer запуска, счетчик сбрасывается. Например, если задать интервал в 5 секунд, а затем задать Enabled для свойства trueзначение , число начинается во время Enabled . При сбросе интервала до 10 секунд, если число составляет 3 секунды, Elapsed событие вызывается в первый раз, Enabled когда было установлено значение true13 секунд.

Замечание

Некоторые визуальные конструкторы, такие как в Microsoft Visual Studio, задают Enabled для свойства true значение при вставке нового Timer.

См. также раздел

• Interval
• AutoReset
• Start()
• Stop()
• Elapsed