IVsCfgProviderEventsHelper 接口

实现通过环境,调用由项目用作实现 IVsCfgProvider2的帮助器。

命名空间:  Microsoft.VisualStudio.Shell.Interop
程序集:  Microsoft.VisualStudio.Shell.Interop(在 Microsoft.VisualStudio.Shell.Interop.dll 中)

语法

声明
<InterfaceTypeAttribute()> _
<GuidAttribute("0D6D480C-894F-48E4-98D2-E0A7127750E4")> _
Public Interface IVsCfgProviderEventsHelper
[InterfaceTypeAttribute()]
[GuidAttribute("0D6D480C-894F-48E4-98D2-E0A7127750E4")]
public interface IVsCfgProviderEventsHelper

IVsCfgProviderEventsHelper 类型公开以下成员。

方法

  名称 说明
公共方法 AdviseCfgProviderEvents 调用将配置事件的侦听器添加到数组。
公共方法 NotifyOnCfgNameAdded 激发接收配置名称添加所有侦听器的事件数组的。
公共方法 NotifyOnCfgNameDeleted 激发接收配置名称删除所有侦听器的事件数组的。
公共方法 NotifyOnCfgNameRenamed 激发接收配置名称。所有侦听器的事件重命名该数组的。
公共方法 NotifyOnPlatformNameAdded 激发接收平台名称添加所有侦听器的事件数组的。
公共方法 NotifyOnPlatformNameDeleted 激发接收平台名称删除所有侦听器的事件数组的。
公共方法 UnadviseCfgProviderEvents 调用从相关配置事件的侦听器移除侦听器。

页首

备注

IVsCfgProvider 可以支持平台和编辑该项目的配置。如果该项目实现 IVsCfgProvider2,还必须执行其 AdviseCfgProviderEventsUnadviseCfgProviderEvents 方法接收与侦听配置的客户端事件激发的 IVsCfgProviderEvents

是项目的负责维护侦听项目配置的事件相关的客户端。此外,您还需要通知的每一个 framework 配置事件激发的侦听器,因此,您必须具有处理,供您将数组循环并调用每个请求激发的事件。

IVsCfgProviderEventsHelper 是为您提供该功能通过管理相关该项的侦听器的帮助器对象,然后将从 IVsCfgProvider2 到帮助器激发事件在正确时给每个列表。您知道作为配置提供程序,当添加,删除或重命名一个配置重命名,而您调用帮助器通知项和事件的环境中的其他对象。因此需要在+合适+的+时候引发这些事件。使用此帮助器对象,您只需通过该条件新的客户端侦听地定位到帮助器,或客户端可以从数组中移除。然后,那么,当事件激发时,您必须执行的全都通过事件的通知给帮助器对象,将采用通知所有的职责侦听器。

通过使用帮助器对象,可以通过调用来更改到 AdviseCfgProviderEvents 行调用 AdviseCfgProviderEvents —的一个请实例化帮助对象它尚未存在),并使用 helper 例程生成的数组将通知的侦听器对象配置事件。

IVsCfgProviderEventsHelper 通过调用 ILocalRegistryCreateInstance 方法并向其传递 CLSID_VsCfgProviderEventsHelper实例化。在 IVsCfgProviderEventsHelper 实例启动, AdviseCfgProviderEventsUnadviseCfgProviderEvents 将添加和移除事件的侦听器设置为数组。

同样,通过 UnadviseCfgProviderEvents 通过实现于帮助器方法采用侦听器的 UnadviseCfgProviderEvents 在外部数组。

然后,那么,当应激发时配置事件,实现通知接收事件将成为一行的问题从 IVsCfgProviderEvents 调用到相应通知将通知所有数组的侦听器的 IVsCfgProviderEventsHelper 的方法。这样,您可以通过一个通知配置名称从 AddCfgsOfCfgName已添加,例如,在中,通过 OnCfgNameAdded到,然后负责通知都将负责事件的侦听器的 NotifyOnCfgNameAdded

可以,当然,直接实现此 IVsCfgProvider2 功能和管理此一些接收器,但是,帮助器使简单通过使用一行调用实现建议, Unadvise,并通知事件。

对实现者的说明

实现通过环境提供配置相关激发的事件的通知。

对调用者的说明

调用使用此对象作为帮助器为 IVsCfgProvider2实现的项目,它维护侦听事件相关的客户端,并配置激发事件的通知。这些客户端。

请参见

参考

Microsoft.VisualStudio.Shell.Interop 命名空间