CommonMessagePump Members

Include Protected Members
Include Inherited Members

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

The CommonMessagePump type exposes the following members.

Constructors

  Name Description
Public method CommonMessagePump

Top

Methods

  Name Description
Public method Equals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ModalWaitForHandles(WaitHandle) Blocks the current thread by pumping messages until either a timeout or the specified handle has been signaled.
Public method ModalWaitForHandles(array<WaitHandle[], IVsCommonMessagePumpClientEvents) Blocks the current thread by pumping messages until either a timeout or one of the specified handles has been signaled.
Public method ModalWaitForHandles(array<WaitHandle[], Int32%) Blocks the current thread by pumping messages until either a timeout or one of the specified handles has been signaled.
Public method ToString Returns a String that represents the current Object. (Inherited from Object.)

Top

Properties

  Name Description
Public property AllowCancel Controls if the wait dialog has an enabled cancel button.
Public property CurrentStep
Public property EnableRealProgress
Public property ProgressText
Public property StatusBarText Text of the status bar during the wait.
Public property Timeout Set the timeout value for the modal wait. Use TimeSpan.MaxValue for an infinite wait.
Public property TotalSteps
Public property WaitText Wait dialog text for what we are waiting on.
Public property WaitTitle Title of the wait dialog

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IOleComponent.FContinueMessageLoop
Explicit interface implemetationPrivate method IOleComponent.FDoIdle
Explicit interface implemetationPrivate method IOleComponent.FPreTranslateMessage
Explicit interface implemetationPrivate method IOleComponent.FQueryTerminate
Explicit interface implemetationPrivate method IOleComponent.FReserved1
Explicit interface implemetationPrivate method IOleComponent.HwndGetWindow
Explicit interface implemetationPrivate method IOleComponent.OnActivationChange
Explicit interface implemetationPrivate method IOleComponent.OnAppActivate
Explicit interface implemetationPrivate method IOleComponent.OnEnterState
Explicit interface implemetationPrivate method IOleComponent.OnLoseActivation
Explicit interface implemetationPrivate method IOleComponent.Terminate
Explicit interface implemetationPrivate method IOleComponent2Private.FContinueMessageLoop
Explicit interface implemetationPrivate method IOleComponent2Private.FDoIdle
Explicit interface implemetationPrivate method IOleComponent2Private.FPreTranslateMessage
Explicit interface implemetationPrivate method IOleComponent2Private.FQueryTerminate
Explicit interface implemetationPrivate method IOleComponent2Private.FReserved1
Explicit interface implemetationPrivate method IOleComponent2Private.GetWaitHandlesAndTimeout
Explicit interface implemetationPrivate method IOleComponent2Private.HwndGetWindow
Explicit interface implemetationPrivate method IOleComponent2Private.OnActivationChange
Explicit interface implemetationPrivate method IOleComponent2Private.OnAppActivate
Explicit interface implemetationPrivate method IOleComponent2Private.OnEnterState
Explicit interface implemetationPrivate method IOleComponent2Private.OnHandleSignaled
Explicit interface implemetationPrivate method IOleComponent2Private.OnLoseActivation
Explicit interface implemetationPrivate method IOleComponent2Private.OnTimeout
Explicit interface implemetationPrivate method IOleComponent2Private.Terminate
Explicit interface implemetationPrivate method IVsCommonMessagePump.EnableRealProgress
Explicit interface implemetationPrivate method IVsCommonMessagePump.ModalWaitForObjects Blocks the current thread by pumping messages until either a timeout or one of the specified handles has been signaled.
Explicit interface implemetationPrivate method IVsCommonMessagePump.ModalWaitForObjectsWithClient Blocks the current thread by pumping messages until either a timeout or one of the specified handles has been signaled.
Explicit interface implemetationPrivate method IVsCommonMessagePump.SetAllowCancel Controls if the wait dialog has an enabled cancel button.
Explicit interface implemetationPrivate method IVsCommonMessagePump.SetProgressInfo
Explicit interface implemetationPrivate method IVsCommonMessagePump.SetStatusBarText Text of the status bar during the wait.
Explicit interface implemetationPrivate method IVsCommonMessagePump.SetTimeout Set the timeout value for the modal wait. Use 0xFFFFFFFF for an infinite wait.
Explicit interface implemetationPrivate method IVsCommonMessagePump.SetWaitText Wait dialog text for what we are waiting on.
Explicit interface implemetationPrivate method IVsCommonMessagePump.SetWaitTitle Title of the wait dialog

Top

See Also

Reference

CommonMessagePump Class

Microsoft.VisualStudio.Shell Namespace

  • Last updated on