IdleDispatchedHandlerArgs.IsDispatcherIdle Property
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Gets a value that indicates whether the event dispatcher's message queue is empty or not.
public:
property bool IsDispatcherIdle { bool get(); };bool IsDispatcherIdle();public bool IsDispatcherIdle { get; }var boolean = idleDispatchedHandlerArgs.isDispatcherIdle;Public ReadOnly Property IsDispatcherIdle As BooleanProperty Value
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 IdleDispatchedHandlerArgs sent to the delegate has the IsDispatcherIdle property set to false, the work item immediately suspends background processing until the event queue is empty again.