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; }

Property Value

Type: System.TimeSpan

The period of time between ticks. The default is 00:00:00.

Exception Condition
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();

.NET Framework
Available since 3.0
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Return to top
Show: