Application.Idle Event (System.Windows.Forms)

Idle Event

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2010/.NET Framework 4

Other versions are also available for the following:

.NET Framework Class Library

Application..::.Idle Event

Occurs when the application finishes processing and is about to enter the idle state.

Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in System.Windows.Forms.dll)

Syntax

Visual Basic

Public Shared Event Idle As EventHandler

public static event EventHandler Idle

Visual C++

public:
static  event EventHandler^ Idle {
    void add (EventHandler^ value);
    void remove (EventHandler^ value);
}

member Idle : IEvent<EventHandler,
    EventArgs>

Remarks

If you have tasks that you must perform before the thread becomes idle, attach them to this event.

Caution
Because this is a static event, you must detach your event handlers when your application is disposed, or memory leaks will result.

Caution

Because this is a static event, you must detach your event handlers when your application is disposed, or memory leaks will result.

Examples

The following code example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the Idle event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing MessageBox..::.Show with Console..::.WriteLine or appending the message to a multiline TextBox.

To run the example code, paste it into a Windows Form and make sure that the event handler is associated with the Idle event.

Visual Basic

Private Sub Application_Idle(ByVal sender As Object, ByVal e As EventArgs) 

    MessageBox.Show("You are in the Application.Idle event.")

End Sub

private void Application_Idle(Object sender, EventArgs e) {

   MessageBox.Show("You are in the Application.Idle event.");

}

Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

Reference

Application Class

System.Windows.Forms Namespace

Tags

: Add a tag

Community Content

Add new content

Annotations

Better examples do exist

flstfrydr | Edit | Show History

For a better explanation with examples, check out http://msdn.microsoft.com/en-us/library/ms366768.aspx

Tags

: Add a tag

Flag as ContentBug

Proper example

hitesh1407 | Edit | Show History

Check article section "Initializing Controls on Idle " in article http://msdn.microsoft.com/en-us/magazine/cc163630.aspx
for a proper example

Tags

: Add a tag

Flag as ContentBug

Another useless sample

Simple Samples | Edit | Show History

The sample code here is another token sample that serves no purpose except allows the author to say that there is sample code. It should show how to make "the event handler is associated with the Idle event" as well as detach the event handler. Certainly people that know how to do that don't need a sample, in which case there is no need for a sample, but if there is a sample, it should be useful for those that need a sample.

Tags

: sample (x) useless (x) Add a tag

Flag as ContentBug