IdleDispatchedHandlerArgs.IsDispatcherIdle Property

Gets a value that indicates whether the event dispatcher’s message queue is empty or not.

Syntax

public:
property bool IsDispatcherIdle {
         bool get ();
}  

Property value

Type: bool 

  true if the event dispatcher’s message queue is empty; false if it is not.

Remarks

Note

This property must be handled within the code for the event handler. This data becomes stale quickly and cannot be stored or used outside of the handler. If you access this property outside of the IdleDispatchedHandler invoked by the call to CoreDispatcher::RunAsync, your call to IsDispatcherIdle will fail.

When a work item is scheduled with the CoreDispatcher::RunAsync method, the item performs any processing only when there are no message pending in the event queue. However, if the IdleDispatchedHandler delegate returned by the callback has the IsDispatcherIdle property set to false, the work item immediately exits background processing until the event queue is empty again.

Requirements

Namespace: Windows.UI.Core

Metadata: windows.winmd

See also

Reference

IdleDispatchedHandlerArgs Class

IdleDispatchedHandlerArgs Members

Windows.UI.Core Namespace