IdleDispatchedHandlerArgs IdleDispatchedHandlerArgs IdleDispatchedHandlerArgs IdleDispatchedHandlerArgs Class

Definition

Defines the arguments returned by a IdleDispatchedHandler callback.

public : sealed class IdleDispatchedHandlerArgs : IIdleDispatchedHandlerArgspublic sealed class IdleDispatchedHandlerArgs : IIdleDispatchedHandlerArgsPublic NotInheritable Class IdleDispatchedHandlerArgs Implements IIdleDispatchedHandlerArgs// This API is not available in Javascript.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

Note

: This class is not agile, which means that you need to consider its threading model and marshaling behavior. For more info, see Threading and Marshaling (C++/CX).

Properties

IsDispatcherIdle IsDispatcherIdle IsDispatcherIdle IsDispatcherIdle

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

public : PlatForm::Boolean IsDispatcherIdle { get; }public bool IsDispatcherIdle { get; }Public ReadOnly Property IsDispatcherIdle As bool// This API is not available in Javascript.
Value
PlatForm::Boolean bool bool 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.