DispatcherQueueTimer Class

Definition

Namespace:

Microsoft.UI.Dispatching

Executes a task in a DispatcherQueue periodically after a time interval has elapsed.

public ref class DispatcherQueueTimer sealed

/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.ContractVersion(Microsoft.Foundation.WindowsAppSDKContract, 65536)]
class DispatcherQueueTimer final

[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.ContractVersion(typeof(Microsoft.Foundation.WindowsAppSDKContract), 65536)]
public sealed class DispatcherQueueTimer

Public NotInheritable Class DispatcherQueueTimer

Inheritance

Object Platform::Object IInspectable DispatcherQueueTimer

Attributes

ContractVersionAttribute MarshalingBehaviorAttribute

Examples

public void ConfigureRepeatingTimer()
{
    _queueController = DispatcherQueueController.CreateOnDedicatedThread();
    _queue = _queueController.DispatcherQueue;

    _repeatingTimer = _queue.CreateTimer ();
    _repeatingTimer.Interval = TimeSpan.FromSeconds(5);

    // The tick handler will be invoked repeatedly after every 5
    // seconds on the dedicated thread.
    _repeatingTimer.Tick += (s, e) =>
    {
        DoWork();
    };

    // Start the Timer
    _repeatingTimer.Start();
}

private DispatcherQueue _queue;
private DispatcherQueueController _queueController;
private DispatcherQueueTimer _repeatingTimer;

Remarks

The system guarantees to invoke the event handler only after the specified duration expires. However, there may be some delay before the tick handler is invoked if there are other pending work items in the queue.

Timer tasks run at a priority lower than idle.

Timers don’t keep the DispatcherQueue event loop alive. Timers created after the DispatcherQueue event loop has stopped will not be processed.

Properties

Interval	Gets and sets the interval for the timer.
IsRepeating	Gets or sets a value that indicates whether the timer is repeating.
IsRunning	Indicates whether the timer is currently running.

Methods

Start()	Starts the DispatcherQueue timer.
Stop()	Stops the DispatcherQueue timer.

Events

Tick	Event that fires when the DispatcherQueue timer Interval elapses.