CommonMessagePump 类

允许调用方会阻止当前线程，直到处理或处理发出其事件信号。

继承层次结构

System.Object
  Microsoft.VisualStudio.Shell.CommonMessagePump

命名空间：  Microsoft.VisualStudio.Shell
程序集：  Microsoft.VisualStudio.Shell.11.0（在 Microsoft.VisualStudio.Shell.11.0.dll 中）

语法

声明
Public Class CommonMessagePump _
    Implements IVsCommonMessagePump, IOleComponent2Private, IOleComponent

public class CommonMessagePump : IVsCommonMessagePump, 
    IOleComponent2Private, IOleComponent

CommonMessagePump 类型公开以下成员。

构造函数

	名称	说明
	CommonMessagePump	初始化 CommonMessagePump 的新实例。

页首

属性

	名称	说明
	AllowCancel	确定等待对话框是否已启用 " 取消 " 按钮。
	CurrentStep	获取等待对话框的进度控件的当前阶跃。
	EnableRealProgress	在等待对话框确定进度的类型使用。
	ProgressText	获取进度文本。
	StatusBarText	在等待期间，则获取或设置状态栏的文本。
	Timeout	获取或设置模式等待的超时值。
	TotalSteps	获取步骤的总数等待对话框的进度。
	WaitText	获取或设置等待对话框文本。
	WaitTitle	获取或设置等待对话框的标题。

页首

方法

	名称	说明
	Equals	确定指定的对象是否等于当前对象。 （继承自 Object。）
	Finalize	允许对象在“垃圾回收”回收之前尝试释放资源并执行其他清理操作。 （继承自 Object。）
	GetHashCode	用作特定类型的哈希函数。 （继承自 Object。）
	GetType	获取当前实例的 Type。 （继承自 Object。）
	MemberwiseClone	创建当前 Object 的浅表副本。 （继承自 Object。）
	ModalWaitForHandles(WaitHandle)	通过发送直到或超时的消息块当前线程或指定的句柄集收到信号。
	ModalWaitForHandles(array<WaitHandle[], IVsCommonMessagePumpClientEvents)	通过发送直到或超时的消息块当前线程或之一指定的句柄集收到信号。
	ModalWaitForHandles(array<WaitHandle[], Int32%)	通过发送直到或超时的消息块当前线程或之一指定的句柄集收到信号。
	ToString	返回表示当前对象的字符串。 （继承自 Object。）

页首

显式接口实现

	名称	说明
	IOleComponent.FContinueMessageLoop	对消息循环的每次迭代时。
	IOleComponent.FDoIdle	将该元素的机会执行空闲时间任务。
	IOleComponent.FPreTranslateMessage	，它将转换和调度之前，处理消息。
	IOleComponent.FQueryTerminate	调用，当组件管理器希望知道元素是否在它可以终止状态。
	IOleComponent.FReserved1	保留。
	IOleComponent.HwndGetWindow	检索窗口与组件关联。
	IOleComponent.OnActivationChange	激活时，时，请注意元素新的对象。
	IOleComponent.OnAppActivate	，在宿主应用程序获取或丢失启动时，请注意元素。
	IOleComponent.OnEnterState	，在应用程序进入或退出该指定的状态时，请注意元素。
	IOleComponent.OnLoseActivation	通知有效部分它将丢失其活动状态，因为宿主或其他元素变为活动状态。
	IOleComponent.Terminate	终止消息循环。
	IOleComponent2Private.FContinueMessageLoop	对消息循环的每次迭代时。
	IOleComponent2Private.FDoIdle	执行闲置处理。
	IOleComponent2Private.FPreTranslateMessage	处理消息。
	IOleComponent2Private.FQueryTerminate	调用，当组件管理器希望知道元素是否在它可以终止状态。
	IOleComponent2Private.FReserved1	保留。
	IOleComponent2Private.GetWaitHandlesAndTimeout	获取等待句柄和超时值。
	IOleComponent2Private.HwndGetWindow	获取关联的窗口。
	IOleComponent2Private.OnActivationChange	调用激活时，新的对象。
	IOleComponent2Private.OnAppActivate	调用，当激活应用程序或停用。
	IOleComponent2Private.OnEnterState	调用，当环境已进入或离开状态。
	IOleComponent2Private.OnHandleSignaled	调用，当等待句柄集收到信号。
	IOleComponent2Private.OnLoseActivation	调用，当元素只丢失其活动状态，因为宿主或其他元素变为活动状态。
	IOleComponent2Private.OnTimeout	调用，当在消息循环的超时。
	IOleComponent2Private.Terminate	终止消息循环。
	IVsCommonMessagePump.EnableRealProgress	确定要显示的进度。
	IVsCommonMessagePump.ModalWaitForObjects	通过发送直到或超时的消息块当前线程或之一指定的句柄集收到信号。
	IVsCommonMessagePump.ModalWaitForObjectsWithClient	通过发送直到或超时的消息块当前线程或之一指定的句柄集收到信号。
	IVsCommonMessagePump.SetAllowCancel	确定等待对话框是否已启用 " 取消 " 按钮。
	IVsCommonMessagePump.SetProgressInfo	设置消息的进度信息。
	IVsCommonMessagePump.SetStatusBarText	在等待期间，设置状态栏的文本。
	IVsCommonMessagePump.SetTimeout	设置模式等待的超时值。
	IVsCommonMessagePump.SetWaitText	设置等待对话框文本。
	IVsCommonMessagePump.SetWaitTitle	设置等待对话框的标题使用指定的标题。

页首

备注

在等待期间， IDE 在一个模式状态将阻止进入。如果等待需要大于 2 秒，等待对话框向可撤消的用户 (默认情况下)。调用方可以使用默认行为，在等待此时将显示默认文本，也可用于与对话框文本，状态栏文本，超时值的内容提供自定义值，依此类推。

调用方还可以提供 IVsCommonMessagePumpClientEvents的自定义实现，以允许客户端运行代码，在某些事件发生 (如处理的消息，超时或终止的句柄。此接口还可用于确定等待是否应继续或返回。

线程安全

此类型的任何公共 static（在 Visual Basic 中为 Shared） 成员都是线程安全的。但不保证所有实例成员都是线程安全的。

请参见

参考

Microsoft.VisualStudio.Shell 命名空间