CommonMessagePump Class

 

Allows callers to block the current thread until a handle or handles have been signaled.

Namespace:   Microsoft.VisualStudio.Shell
Assembly:  Microsoft.VisualStudio.Shell.14.0 (in Microsoft.VisualStudio.Shell.14.0.dll)

System.Object
  Microsoft.VisualStudio.Shell.CommonMessagePump

public class CommonMessagePump : IVsCommonMessagePump, IOleComponent

NameDescription
System_CAPS_pubmethodCommonMessagePump()

Initializes a new instance of CommonMessagePump.

NameDescription
System_CAPS_pubpropertyAllowCancel

Determines whether the wait dialog has an enabled cancel button.

System_CAPS_pubpropertyCurrentStep

Gets the current step for the progress control of the wait dialog.

System_CAPS_pubpropertyEnableRealProgress

Determines the type of progress control to use in the wait dialog.

System_CAPS_pubpropertyProgressText

Gets the progress text.

System_CAPS_pubpropertyStatusBarText

Gets or sets the text of the status bar during the wait.

System_CAPS_pubpropertyTimeout

Gets or sets the timeout value for the modal wait.

System_CAPS_pubpropertyTotalSteps

Gets the total number of steps for the progress control of the wait dialog.

System_CAPS_pubpropertyWaitText

Gets or sets the wait dialog text.

System_CAPS_pubpropertyWaitTitle

Gets or sets the title of the wait dialog.

NameDescription
System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodModalWaitForHandles(WaitHandle)

Blocks the current thread by pumping messages until either a timeout or the specified handle has been signaled.

System_CAPS_pubmethodModalWaitForHandles(WaitHandle[], Int32)

Blocks the current thread by pumping messages until either a timeout or one of the specified handles has been signaled.

System_CAPS_pubmethodModalWaitForHandles(WaitHandle[], IVsCommonMessagePumpClientEvents)

Blocks the current thread by pumping messages until either a timeout or one of the specified handles has been signaled.

System_CAPS_pubmethodToString()

(Inherited from Object.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIOleComponent.FContinueMessageLoop(UInt32, IntPtr, MSG[])

Called during each iteration of a message loop.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIOleComponent.FDoIdle(UInt32)

Gives the component a chance to do idle time tasks.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIOleComponent.FPreTranslateMessage(MSG[])

Processes the message before it is translated and dispatched.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIOleComponent.FQueryTerminate(Int32)

Called when the component manager wishes to know if the component is in a state in which it can terminate.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIOleComponent.FReserved1(UInt32, UInt32, IntPtr, IntPtr)

Reserved.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIOleComponent.HwndGetWindow(UInt32, UInt32)

Retrieves a window associated with the component.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIOleComponent.OnActivationChange(IOleComponent, Int32, OLECRINFO[], Int32, OLECHOSTINFO[], UInt32)

Notifies the component when a new object is being activated.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIOleComponent.OnAppActivate(Int32, UInt32)

Notifies the component when the host application gains or loses activation.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIOleComponent.OnEnterState(UInt32, Int32)

Notifies the component when the application enters or exits the specified state.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIOleComponent.OnLoseActivation()

Notifies the active component that it has lost its active status because the host or another component has become active.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIOleComponent.Terminate()

Terminates the message loop.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsCommonMessagePump.EnableRealProgress(Boolean)

Determines the kind of progress to be displayed

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsCommonMessagePump.ModalWaitForObjects(IntPtr[], UInt32, UInt32)

Blocks the current thread by pumping messages until either a timeout or one of the specified handles has been signaled.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsCommonMessagePump.ModalWaitForObjectsWithClient(IntPtr[], UInt32, IVsCommonMessagePumpClientEvents)

Blocks the current thread by pumping messages until either a timeout or one of the specified handles has been signaled.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsCommonMessagePump.SetAllowCancel(Boolean)

Determines whether the wait dialog has an enabled cancel button.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsCommonMessagePump.SetProgressInfo(Int32, Int32, String)

Sets progress information for the message.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsCommonMessagePump.SetStatusBarText(String)

Sets the text of the status bar during the wait.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsCommonMessagePump.SetTimeout(UInt32)

Sets the timeout value for the modal wait.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsCommonMessagePump.SetWaitText(String)

Sets the wait dialog text.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIVsCommonMessagePump.SetWaitTitle(String)

Sets the title of the wait dialog with the specified title.

During the wait, the IDE is placed in a modal state to prevent reentrancy. If the wait takes more than 2 seconds, a wait dialog is presented to the user which can be canceled (by default). Callers can use the default behavior, which will show default text in the wait dialog, or they can provide custom values for things like the dialog text, status bar text, timeout values, and so on.

Callers can also provide a custom implementation of IVsCommonMessagePumpClientEvents, which allows the client to run code when certain events occur such as messages being processed, a timeout, or a handle being signaled. This interface can also be used to determine if the wait should continue or return.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: