ComponentDispatcher Class

Enables shared control of the message pump between Win32 and WPF in interoperation scenarios.

System.Object
  System.Windows.Interop.ComponentDispatcher

Namespace:  System.Windows.Interop
Assembly:  WindowsBase (in WindowsBase.dll)

public static class ComponentDispatcher

The ComponentDispatcher type exposes the following members.

  NameDescription
Public propertyStatic memberCurrentKeyboardMessageGets the last message that was raised.
Public propertyStatic memberIsThreadModalGets a value that indicates whether the thread is modal.
Top

  NameDescription
Public methodStatic memberPopModalCalled to indicate that a modal thread is no longer modal.
Public methodStatic memberPushModalCalled to indicate that the thread is modal.
Public methodStatic memberRaiseIdleCalled to indicate that a thread is idle.
Public methodStatic memberRaiseThreadMessageIndicates that a new message is available for possible handling.
Top

  NameDescription
Public eventStatic memberEnterThreadModalOccurs when a thread becomes modal.
Public eventStatic memberLeaveThreadModalOccurs when a modal thread becomes nonmodal.
Public eventStatic memberThreadFilterMessageOccurs when the message pump receives a keyboard message.
Public eventStatic memberThreadIdleOccurs when the thread is idle.
Public eventStatic memberThreadPreprocessMessageOccurs when the message pump receives a keyboard message.
Top

Although the class itself is static, all members of ComponentDispatcher are specific to a particular thread. For example, if you examine the value of IsThreadModal on two different threads, you might get different values.

The methods are static but they are backed by per-thread data structures.  The static methods allow singleton access but the ComponentDispatcher is sorting out the appropriate per-thread operations.

The owner of the message pump is defined by the code that calls the Win32 function GetMessage. The owner calls RaiseThreadMessage for every keyboard message. This method raises the ThreadFilterMessage event with the messages contained in the event data. If that event is not handled, the owner raises the ThreadPreprocessMessage event with the messages contained in the event argument.

NoteNote

Only keyboard messages are supported.

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, 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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft