Idle |
IdleTimer lets you to take actions after a specified system-wide (related to the whole system) idle time or to check the time interval of user inactivity.
Inheritance HierarchySystemObject
SystemMarshalByRefObject
System.ComponentModelComponent
ZylSoft.TimersCustomTimer
ZylSoft.TimersIdleTimer
SystemMarshalByRefObject
System.ComponentModelComponent
ZylSoft.TimersCustomTimer
ZylSoft.TimersIdleTimer
Namespace: ZylSoft.Timers
Assembly: ZylIdleTimer (in ZylIdleTimer.dll) Version: 1.42.8793.22144
XMLNS for XAML: Not mapped to an xmlns.
SyntaxThe IdleTimer type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | IdleTimer | Constructor. |
| IdleTimer(IContainer) | Constructor. |
| IdleTimer(Int32) | Constructor. |
Properties| Name | Description | |
|---|---|---|
 | Container | Gets the IContainer that contains the Component. (Inherited from Component) |
| Enabled |
Enables or disables the timer.
(Inherited from CustomTimer) |
| IdleInterval | The time interval of idle in milliseconds (1 second = 1000 milliseconds). When this interval of idle is expired then the Idle event is fired. |
| IdleIntervalInMinutes | The time interval of idle in minutes. When this interval of idle is expired then the Idle event is fired. |
| IdleIntervalInSeconds | The time interval of idle in seconds (1 second = 1000 milliseconds). When this interval of idle is expired then the Idle event is fired. |
| Site | Gets or sets the ISite of the Component. (Inherited from Component) |
| WarningInterval | The time interval before idle in milliseconds. When this interval is expired then the IdleWarning event is fired. WarningInterval must be lower than IdleInterval. |
| WarningIntervalInMinutes | The time interval before idle in minutes. When this interval is expired then the IdleWarning event is fired. WarningInterval must be lower than IdleInterval. |
| WarningIntervalInSeconds | The time interval before idle in seconds. When this interval is expired then the IdleWarning event is fired. WarningInterval must be lower than IdleInterval. |
Methods| Name | Description | |
|---|---|---|
| CreateObjRef | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject) |
| Dispose | Releases all resources used by the Component. (Inherited from Component) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetLifetimeService | Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject) |
| GetRelativeSystemIdleTime | Returns the minimum between system-wide idle time and the interval from the latest reset in milliseconds. |
 | GetSystemIdleTime | Returns the system-wide idle time in milliseconds. |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| InitializeLifetimeService | Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject) |
| ResetSystemIdleTime | Resets the idle timer. |
| Start |
Starts the timer. (Enabled = true)
(Inherited from CustomTimer) |
| Stop |
Stops the timer. (Enabled = false)
(Inherited from CustomTimer) |
| ToString | Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component) |
Events| Name | Description | |
|---|---|---|
 | Disposed | Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component) |
| Idle | Occurs when IdleInterval is expired. |
| IdleWarning | Occurs before IdleInterval is expired. The interval is set by WarningInterval property. |
| Resume | Occurs after the idle time interval is expired and the idle time counter is reset due to user intervention. |
See Also