CommonMessagePump, classe

Permet aux appelants pour bloquer le thread actuel jusqu'à ce qu'un handle ou les handles ont été signalé.

Hiérarchie d'héritage

System.Object
  Microsoft.VisualStudio.Shell.CommonMessagePump

Espace de noms :  Microsoft.VisualStudio.Shell
Assembly :  Microsoft.VisualStudio.Shell.11.0 (dans Microsoft.VisualStudio.Shell.11.0.dll)

Syntaxe

'Déclaration
Public Class CommonMessagePump _
    Implements IVsCommonMessagePump, IOleComponent2Private, IOleComponent

public class CommonMessagePump : IVsCommonMessagePump, 
    IOleComponent2Private, IOleComponent

Le type CommonMessagePump expose les membres suivants.

Constructeurs

	Nom	Description
	CommonMessagePump	Initialise une nouvelle instance d'CommonMessagePump.

Début

Propriétés

	Nom	Description
	AllowCancel	Détermine si la boîte de dialogue d'attente a un bouton annuler actif.
	CurrentStep	Obtient l'étape actuelle pour le contrôle de progression de dialogue d'attente.
	EnableRealProgress	Détermine le type de contrôle de progression à utiliser dans la boîte de dialogue d'attente.
	ProgressText	obtient le texte de progression.
	StatusBarText	obtient ou définit le texte de la barre d'état pendant l'attente.
	Timeout	obtient ou définit la valeur du délai d'attente pour l'attente modale.
	TotalSteps	Obtient tout le nombre d'étapes pour le contrôle de progression de dialogue d'attente.
	WaitText	obtient ou définit le texte de dialogue d'attente.
	WaitTitle	Obtient ou définit le titre de la boîte de dialogue d'attente.

Début

Méthodes

	Nom	Description
	Equals	Détermine si l'objet Object spécifié est égal à l'objet Object actuel. (Hérité de Object.)
	Finalize	Autorise un objet à tenter de libérer des ressources et d'exécuter d'autres opérations de nettoyage avant qu'il ne soit récupéré par l'opération garbage collection. (Hérité de Object.)
	GetHashCode	Sert de fonction de hachage pour un type particulier. (Hérité de Object.)
	GetType	Obtient le Type de l'instance actuelle. (Hérité de Object.)
	MemberwiseClone	Crée une copie superficielle de l'objet Object actuel. (Hérité de Object.)
	ModalWaitForHandles(WaitHandle)	Bloque le thread actuel en pompant des messages jusqu'à un délai d'attente ou le handle spécifié a été signalé.
	ModalWaitForHandles(array<WaitHandle[], IVsCommonMessagePumpClientEvents)	Bloque le thread actuel en pompant des messages jusqu'à un délai d'attente ou une des poignées spécifiés a été signalé.
	ModalWaitForHandles(array<WaitHandle[], Int32%)	Bloque le thread actuel en pompant des messages jusqu'à un délai d'attente ou une des poignées spécifiés a été signalé.
	ToString	Retourne une chaîne qui représente l'objet actuel. (Hérité de Object.)

Début

Implémentations d'interface explicite

	Nom	Description
	IOleComponent.FContinueMessageLoop	appelé pendant chaque itération d'une boucle de message.
	IOleComponent.FDoIdle	Permet au composant la possibilité d'effectuer des tâches de durée d'inactivité.
	IOleComponent.FPreTranslateMessage	Gère le message avant d'être traduit et expédié.
	IOleComponent.FQueryTerminate	Appelé lorsque le gestionnaire composant souhaite connaître si le composant est dans un état dans lequel il peut s'arrêter.
	IOleComponent.FReserved1	Réservé.
	IOleComponent.HwndGetWindow	Extrait une fenêtre associée au composant.
	IOleComponent.OnActivationChange	Informe le composant lorsqu'un nouvel objet est activé.
	IOleComponent.OnAppActivate	Informe le composant lorsque l'application hôte a gagné ou perd l'activation.
	IOleComponent.OnEnterState	Informe le composant lorsque l'application passe dans ou quitte l'état spécifié.
	IOleComponent.OnLoseActivation	Informe le composant actif qu'il a perdu son état actif car un hôte ou un autre composant est devenu actif.
	IOleComponent.Terminate	termine la boucle de message.
	IOleComponent2Private.FContinueMessageLoop	appelé pendant chaque itération d'une boucle de message.
	IOleComponent2Private.FDoIdle	Effectue le traitement des temps d'inactivité.
	IOleComponent2Private.FPreTranslateMessage	Gère le message.
	IOleComponent2Private.FQueryTerminate	Appelé lorsque le gestionnaire composant souhaite connaître si le composant est dans un état dans lequel il peut s'arrêter.
	IOleComponent2Private.FReserved1	Réservé.
	IOleComponent2Private.GetWaitHandlesAndTimeout	obtient les handles d'attente et la valeur du délai d'attente.
	IOleComponent2Private.HwndGetWindow	obtient la fenêtre associée.
	IOleComponent2Private.OnActivationChange	Appelé lorsqu'un nouvel objet est activé.
	IOleComponent2Private.OnAppActivate	Appelé lorsqu'une application est activée ou désactivée.
	IOleComponent2Private.OnEnterState	Appelé lorsque l'environnement est entré dans ou a quitté un rapport.
	IOleComponent2Private.OnHandleSignaled	Appelé lorsqu'un handle d'attente a été signalé.
	IOleComponent2Private.OnLoseActivation	Appelé lorsque le composant a perdu son état actif car un hôte ou un autre composant est devenu actif.
	IOleComponent2Private.OnTimeout	Appelé lorsqu'il y a un délai d'attente sur une boucle de messages.
	IOleComponent2Private.Terminate	termine la boucle de message.
	IVsCommonMessagePump.EnableRealProgress	Détermine le type de progression à afficher
	IVsCommonMessagePump.ModalWaitForObjects	Bloque le thread actuel en pompant des messages jusqu'à un délai d'attente ou une des poignées spécifiés a été signalé.
	IVsCommonMessagePump.ModalWaitForObjectsWithClient	Bloque le thread actuel en pompant des messages jusqu'à un délai d'attente ou une des poignées spécifiés a été signalé.
	IVsCommonMessagePump.SetAllowCancel	Détermine si la boîte de dialogue d'attente a un bouton annuler actif.
	IVsCommonMessagePump.SetProgressInfo	définit les informations de progression pour le message.
	IVsCommonMessagePump.SetStatusBarText	définit le texte de la barre d'état pendant l'attente.
	IVsCommonMessagePump.SetTimeout	définit la valeur du délai d'attente pour l'attente modale.
	IVsCommonMessagePump.SetWaitText	définit le texte de dialogue d'attente.
	IVsCommonMessagePump.SetWaitTitle	Définit le titre de la boîte de dialogue d'attente avec le titre spécifié.

Début

Remarques

Pendant l'attente, l'IDE est placé dans un état modal pour empêcher la réentrance.Si l'attente prend plus de 2 secondes, une boîte de dialogue d'attente est présenté à l'utilisateur qui peut être annulé (par défaut).Les appelants peuvent utiliser le comportement par défaut, qui affichera le texte par défaut dans la boîte de dialogue d'attente, ou peuvent fournir des valeurs personnalisées pour les éléments comme le texte de dialogue, texte de la barre d'état, valeurs du délai d'attente, et ainsi de suite.

Les appelants peuvent également fournir une implémentation personnalisée d' IVsCommonMessagePumpClientEvents, qui permet au client pour exécuter le code lorsque certains événements se produisent tels que les messages sont traités, un délai d'attente, ou un handle soit signalé.Cette interface peut également être utilisée pour déterminer si l'attente continue ou retourne.

Sécurité des threads

Tous les membres static (Shared en Visual Basic) publics de ce type sont thread-safe. Il n'est pas garanti que les membres d'instance soient thread-safe.

Voir aussi

Référence

Microsoft.VisualStudio.Shell, espace de noms