DispatcherTimer Class
[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]
A timer that is integrated into a dispatcher queue.
Inheritance Hierarchy
System. . :: . .Object
Microsoft.SPOT..::..DispatcherTimer
Namespace: Microsoft.SPOT
Assembly: Microsoft.SPOT.TinyCore (in Microsoft.SPOT.TinyCore.dll)
Syntax
'Declaration
Public Class DispatcherTimer _
Implements IDisposable
public class DispatcherTimer : IDisposable
public ref class DispatcherTimer : IDisposable
type DispatcherTimer =
class
interface IDisposable
end
public class DispatcherTimer implements IDisposable
The DispatcherTimer type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
DispatcherTimer() () () () | Initializes a new instance of the DispatcherTimer class. |
|
DispatcherTimer(Dispatcher) | Initializes a new instance of the DispatcherTimer class and associates it with a specified Dispatcher object. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
Dispatcher | Gets the Dispatcher object associated with the current DispatcherTimer object. |
|
Interval | Gets or sets the current DispatcherTimer object's defined time interval. |
|
IsEnabled | Gets or sets a value that indicates whether a particular DispatcherTimer object is currently running. |
|
Tag | Gets or sets a user-defined data object that is passed to the Tick event handler. |
Top
Methods
| Name | Description | |
|---|---|---|
|
Close | Releases the unmanaged and managed resources used by the DispatcherTimer. |
|
Dispose() () () () | Releases the unmanaged and managed resources used by the DispatcherTimer. |
.gif "Protected method") |
Dispose(Boolean) | Releases the unmanaged resources used by the DispatcherTimer and optionally releases the managed resources. |
|
Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
|
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
|
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
Start | Starts a DispatcherTimer object's timer. |
|
Stop | Stops a DispatcherTimer object's timer. |
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
Top
Events
| Name | Description | |
|---|---|---|
.gif "Public event") |
Tick | Occurs when the specified time interval for the current DispatcherTimer object has elapsed and the timer is enabled. |
Top
Remarks
When your program inserts a DispatcherTimer object (timer) into the queue of a Dispatcher object, the dispatcher processes the timer at a specified time interval. If the dispatcher is processing a large number of messages, the timer might not be evaluated at the expected time.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.