This documentation is archived and is not being maintained.

DispatcherTimer.Interval Property

Gets or sets the period of time between timer ticks.

Namespace:  System.Windows.Threading
Assembly:  WindowsBase (in WindowsBase.dll)

public TimeSpan Interval { get; set; }
You cannot set this property in XAML.

Property Value

Type: System.TimeSpan
The period of time between ticks. The default is 00:00:00.

ExceptionCondition
ArgumentOutOfRangeException

interval is less than 0 or greater than MaxValue milliseconds.

Timers are not guaranteed to execute exactly when the time interval occurs, but they are guaranteed to not execute before the time interval occurs. This is because DispatcherTimer operations are placed on the Dispatcher queue like other operations. When the DispatcherTimer operation executes is dependent on the other jobs in the queue and their priorities.

The following example creates a DispatcherTimer. A new DispatcherTimer object named dispatcherTimer is created. The event handler dispatcherTimer_Tick is added to the Tick event. The Interval is set to 1 second using a TimeSpan object.

//  DispatcherTimer setup
dispatcherTimer = new System.Windows.Threading.DispatcherTimer();
dispatcherTimer.Tick += new EventHandler(dispatcherTimer_Tick);
dispatcherTimer.Interval = new TimeSpan(0,0,1);
dispatcherTimer.Start();

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0
Show: