DispatcherTimer.Interval Property

Definition

Namespace:

System.Windows.Threading

Assembly:

WindowsBase.dll

Gets or sets the period of time between timer ticks.

public:
 property TimeSpan Interval { TimeSpan get(); void set(TimeSpan value); };

public TimeSpan Interval { get; set; }

member this.Interval : TimeSpan with get, set

Public Property Interval As TimeSpan

Property Value

TimeSpan

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

Exceptions

ArgumentOutOfRangeException

interval is less than 0 or greater than Int32.MaxValue milliseconds.

Examples

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 = TimeSpan.FromSeconds(1);
dispatcherTimer.Start();

'  DispatcherTimer setup
dispatcherTimer = New Threading.DispatcherTimer()
AddHandler dispatcherTimer.Tick, AddressOf dispatcherTimer_Tick
dispatcherTimer.Interval = New TimeSpan(0,0,1)
dispatcherTimer.Start()

Remarks

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.