AsyncPackage Classe

Définition

Espace de noms:

Microsoft.VisualStudio.Shell

Assembly:

Microsoft.VisualStudio.Shell.15.0.dll

Paquet:

Microsoft.VisualStudio.Shell.15.0 v17.9.37000

Représente un VSPackage qui peut gérer des services asynchrones.

public ref class AsyncPackage abstract : Microsoft::VisualStudio::Shell::Package, Microsoft::VisualStudio::Shell::IAsyncServiceContainer, Microsoft::VisualStudio::Shell::IAsyncServiceProvider2, Microsoft::VisualStudio::Shell::Interop::COMAsyncServiceProvider::IAsyncServiceProvider, Microsoft::VisualStudio::Shell::Interop::IAsyncLoadablePackageInitialize, Microsoft::VisualStudio::Shell::Interop::IVsAsyncToolWindowFactory, Microsoft::VisualStudio::Shell::Interop::IVsAsyncToolWindowFactoryProvider

[Windows::Foundation::Metadata::WebHostHidden]
public ref class AsyncPackage abstract : Microsoft::VisualStudio::Shell::Package, Microsoft::VisualStudio::Shell::IAsyncServiceContainer, Microsoft::VisualStudio::Shell::IAsyncServiceProvider, Microsoft::VisualStudio::Shell::IAsyncServiceProvider2, Microsoft::VisualStudio::Shell::Interop::IAsyncLoadablePackageInitialize, Microsoft::VisualStudio::Shell::Interop::IAsyncServiceProvider, Microsoft::VisualStudio::Shell::Interop::IVsAsyncToolWindowFactory, Microsoft::VisualStudio::Shell::Interop::IVsAsyncToolWindowFactoryProvider

[Windows::Foundation::Metadata::WebHostHidden]
class AsyncPackage abstract : Microsoft::VisualStudio::Shell::Package, Microsoft::VisualStudio::Shell::IAsyncServiceContainer, Microsoft::VisualStudio::Shell::IAsyncServiceProvider, Microsoft::VisualStudio::Shell::IAsyncServiceProvider2, Microsoft::VisualStudio::Shell::Interop::IAsyncLoadablePackageInitialize, Microsoft::VisualStudio::Shell::Interop::IAsyncServiceProvider, Microsoft::VisualStudio::Shell::Interop::IVsAsyncToolWindowFactory, Microsoft::VisualStudio::Shell::Interop::IVsAsyncToolWindowFactoryProvider

[System.Runtime.InteropServices.ComVisible(true)]
public abstract class AsyncPackage : Microsoft.VisualStudio.Shell.Package, Microsoft.VisualStudio.Shell.IAsyncServiceContainer, Microsoft.VisualStudio.Shell.IAsyncServiceProvider2, Microsoft.VisualStudio.Shell.Interop.COMAsyncServiceProvider.IAsyncServiceProvider, Microsoft.VisualStudio.Shell.Interop.IAsyncLoadablePackageInitialize, Microsoft.VisualStudio.Shell.Interop.IVsAsyncToolWindowFactory, Microsoft.VisualStudio.Shell.Interop.IVsAsyncToolWindowFactoryProvider

[<System.Runtime.InteropServices.ComVisible(true)>]
type AsyncPackage = class
    inherit Package
    interface IAsyncServiceProvider
    interface IAsyncLoadablePackageInitialize
    interface IAsyncServiceProvider2
    interface IAsyncServiceProvider
    interface IAsyncServiceContainer
    interface IVsAsyncToolWindowFactory
    interface IVsAsyncToolWindowFactoryProvider

Public MustInherit Class AsyncPackage
Inherits Package
Implements IAsyncLoadablePackageInitialize, IAsyncServiceContainer, IAsyncServiceProvider, IAsyncServiceProvider2, IVsAsyncToolWindowFactory, IVsAsyncToolWindowFactoryProvider

Héritage

Object

Package

AsyncPackage

Dérivé

Microsoft.VisualStudio.Modeling.Shell.AsyncModelingPackage

Microsoft.VisualStudio.Shell.ExtensionPointAsyncPackage

Attributs

ComVisibleAttribute

Implémente

IAsyncServiceContainer IAsyncServiceProvider IAsyncLoadablePackageInitialize IAsyncServiceProvider2 IVsAsyncToolWindowFactory IVsAsyncToolWindowFactoryProvider Microsoft.VisualStudio.Shell.Interop.COMAsyncServiceProvider.IAsyncServiceProvider

Constructeurs

AsyncPackage()

Constructeur par défaut AsyncPackage.

Propriétés

ApplicationRegistryRoot	Obtient la clé de Registre racine de la ruche de Registre Visual Studio actuelle. (Hérité de Package)
DisposalToken	Expose un CancellationToken qui peut être utilisé pour case activée si le package a été supprimé. Cela peut se produire pour les tâches asynchrones qui s’exécutent sur un thread d’arrière-plan lorsque Visual Studio a commencé à s’arrêter. Utilisez ShutdownToken pour une indication antérieure que VS est en cours d’arrêt.
JoinableTaskCollection	Obtient la collection de tâches asynchrones démarrées par ce package.
JoinableTaskFactory	Obtient la fabrique à utiliser pour les tâches asynchrones démarrées par ce package.
UserDataPath	Obtient le chemin d’accès au stockage des données utilisateur pour Visual Studio. (Hérité de Package)
UserLocalDataPath	Obtient le chemin d’accès au stockage de données utilisateur local pour Visual Studio. (Hérité de Package)
UserRegistryRoot	Obtient une clé de registre utilisée pour stocker les données de l'utilisateur. (Hérité de Package)
Zombied	Obtient une valeur indiquant si le package en cours d'arrêt. (Hérité de Package)

Méthodes

AddOptionKey(String)	Ajoute un nom de clé d'option utilisateur à la liste des clés d'option. (Hérité de Package)
AddService(Type, AsyncServiceCreatorCallback)	Ajoute un service asynchrone à ce package. Ce service ne sera pas visible en dehors de ce package.
AddService(Type, AsyncServiceCreatorCallback, Boolean)	Ajoute un service asynchrone à ce package. Ce service peut ou non être visible en dehors de ce package, en fonction de la valeur de promote.
AddService(Type, AsyncServiceCreatorWithProgressCallback)	Ajoute un service asynchrone à ce package qui prend en charge les mises à jour de progression pendant l’initialisation. Ce service ne sera pas visible en dehors de ce package.
AddService(Type, AsyncServiceCreatorWithProgressCallback, Boolean)	Ajoute un service asynchrone à ce package qui prend en charge les mises à jour de progression pendant l’initialisation. Ce service peut ou non être visible en dehors de ce package, en fonction de la valeur de promote.
CreateInstance(Guid, Guid, Type)	Crée l’objet COM spécifié à l’aide de l’objet CLSID du Registre local de Visual Studio. (Hérité de Package)
CreateTool(Guid)	Permet aux classes dérivées de fournir une implémentation si nécessaire. (Hérité de Package)
CreateToolWindow(Guid, Int32)	Crée une fenêtre Outil du type spécifié avec l'ID spécifié. (Hérité de Package)
CreateToolWindow(Type, Int32)	Crée une fenêtre Outil du type spécifié avec l'ID spécifié. (Hérité de Package)
CreateToolWindow(Type, Int32, Object)	Create une fenêtre d’outil du type spécifié avec l’ID spécifié. (Hérité de Package)
CreateToolWindow(Type, Int32, UInt32)	Crée une fenêtre Outil du type spécifié avec l'ID spécifié. (Hérité de Package)
CreateToolWindow(Type, Int32, UInt32, Object, Guid)	Create une fenêtre d’outil du type spécifié avec l’ID spécifié. Il s’agit de la seule méthode qui doit appeler IVsUiShell.CreateToolWindow() (Hérité de Package)
Dispose(Boolean)	Supprime l’objet et le jeton d’annulation associé.
FindToolWindow(Type, Int32, Boolean)	Obtient la fenêtre Outil correspondant au type et à l'ID spécifiés (Hérité de Package)
FindToolWindowAsync(Type, Int32, Boolean, CancellationToken)	Localise de manière asynchrone la fenêtre d’outil correspondant au type et à l’ID spécifiés. S’il n’existe pas, il en crée et retourne un si create a la valeur true, ou retourne null si create est false.
FindWindowPane(Type, Int32, Boolean)	Obtient le volet de fenêtre correspondant au type et à l'ID spécifiés, et si aucun volet de fenêtre de ce type n'existe, en crée un s'il en reçoit l'ordre. (Hérité de Package)
FindWindowPaneAsync(Type, Int32, Boolean, CancellationToken)	Localise de manière asynchrone le volet de fenêtre correspondant au type et à l’ID spécifiés. S’il n’existe pas, il en crée et retourne un si create a la valeur true, ou retourne null si create est false.
GetAsyncToolWindowFactory(Guid)	Retourne l’interface de fabrique de fenêtre d’outils asynchrone pour la fenêtre d’outils identifiée par toolWindowType, si la création asynchrone est prise en charge pour la fenêtre d’outil. Si la création asynchrone n’est pas prise en charge, la valeur Null est retournée.
GetAutomationObject(String)	Obtient l'objet Automation pour le VSPackage. (Hérité de Package)
GetDialogPage(Type)	Obtient la page de dialogue demandée. (Hérité de Package)
GetOutputPane(Guid, String)	Obtient la fenêtre Sortie demandée. (Hérité de Package)
GetProviderLocale()	Retourne les paramètres régionaux associés à ce fournisseur de contexte. (Hérité de Package)
GetService(Type)	Récupère un service inscrit auprès de ce package. Cette méthode est synchrone et même les services asynchrones récupérés de cette façon seront récupérés de manière synchrone.
GetServiceAsync(Type)	Récupère un service asynchrone.
GetServiceAsync(Type, Boolean)	Récupère un service asynchrone, mais permet à l’appelant d’indiquer que les exceptions peuvent ne pas avoir à être avalées. Il ne garantit pas que des exceptions seront levées toutefois pour les cas d’échec.
GetToolboxItemData(String, DataFormats+Format)	Obtient le contenu du format de données pour le format de données et l'ID d'élément de boîte à outils spécifiés. (Hérité de Package)
GetToolboxItemDataAsync(String, DataFormats+Format)	Représente un VSPackage qui peut gérer des services asynchrones. (Hérité de Package)
GetToolWindowTitle(Type, Int32)	Retourne la chaîne de titre à utiliser pour la fenêtre d’outil. Si null est retourné, le nom de type de la fenêtre d’outil est utilisé pour le titre.
Initialize()	Scellez cette méthode. En raison d’un risque d’interblocage presque inévitable, SetSite (ce qui est ce qu’appelle Initialize) se produit toujours sur le thread d’interface utilisateur, même pour le package asynchrone. Étant donné que la plupart des auteurs de packages asynchrones supposent logiquement que l’initialisation se produit sur un thread b/g, ils peuvent effectuer des tâches (synchrones) coûteuses à l’intérieur de leur remplacement, ce qui élimine certains des avantages des charges asynchrones. Pour les éloigner de ce que nous allons sceller et donc tout ce qu’ils peuvent remplacer est initialiser asynchrone, qui est appelé sur le thread b/g.
InitializeAsync(CancellationToken, IProgress<ServiceProgressData>)	Partie d’initialisation asynchrone du processus d’initialisation du package. Cette méthode est appelée à partir d’un thread en arrière-plan.
InitializeToolWindowAsync(Type, Int32, CancellationToken)	Effectue l’initialisation en préparation de la création de la fenêtre d’outil identifiée par toolWindowType.
InstantiateToolWindow(Type)	Représente un VSPackage qui peut gérer des services asynchrones. (Hérité de Package)
InstantiateToolWindow(Type, Object)	Construisez une fenêtre d’outil du type spécifié. (Hérité de Package)
IsLocalService(Type)	Détermine si le type de service spécifié peut être récupéré sans nécessiter de transition RPC vers le thread d’interface utilisateur. (Hérité de Package)
OnAfterPackageLoadedAsync(CancellationToken)	En cas de substitution par un type dérivé, peut lancer des opérations avec des effets secondaires qui ne font pas strictement partie de la charge du package qui appartiendrait àInitializeAsync(CancellationToken, IProgress<ServiceProgressData>), mais qui devraient se produire peu après le chargement du package (par exemple, mise à jour de status de commande).
OnLoadOptions(String, Stream)	Appelée par la classe de package lorsqu'il existe des options à lire en dehors du fichier solution. (Hérité de Package)
OnSaveOptions(String, Stream)	Appelée par la classe Package lorsqu'il existe des options à enregistrer dans le fichier solution. (Hérité de Package)
ParseToolboxResource(TextReader, Guid)	Analyse une ressource de texte incorporée au format approprié pour obtenir des informations sur les éléments à ajouter à la boîte à outils. (Hérité de Package)
ParseToolboxResource(TextReader, ResourceManager)	Analyse une ressource de texte incorporée au format approprié pour obtenir des informations sur les éléments à ajouter à la boîte à outils. (Hérité de Package)
QueryClose(Boolean)	Appelé pour demander au package si l'interpréteur de commandes peut être fermé. (Hérité de Package)
RegisterEditorFactory(IVsEditorFactory)	Inscrit une fabrique d’éditeur auprès de Visual Studio. (Hérité de Package)
RegisterProjectFactory(IVsProjectFactory)	Inscrit une fabrique de projet dans Visual Studio. (Hérité de Package)
RemoveService(Type)	Supprime un service asynchrone inscrit auprès de ce package.
RemoveService(Type, Boolean)	Supprime un service asynchrone inscrit auprès de ce package.
ShowOptionPage(Type)	Affiche une page d'options d'outils spécifiée. (Hérité de Package)
ShowToolWindowAsync(Type, Int32, Boolean, CancellationToken)	Affiche de manière asynchrone la fenêtre d’outil correspondant au type et à l’ID spécifiés. S’il n’existe pas, il en crée et retourne un si create a la valeur true, ou retourne null si create est false.

Événements

ToolboxInitialized	Événement généré chaque fois que Visual Studio initialise sa boîte à outils. (Hérité de Package)
ToolboxUpgraded	Événement généré chaque fois que Visual Studio met à niveau sa boîte à outils. (Hérité de Package)

Implémentations d’interfaces explicites

IAsyncLoadablePackageInitialize.Initialize(IAsyncServiceProvider, IProfferAsyncService, IAsyncProgressCallback)	Version asynchrone de SetSite, appelée à partir d’un thread b/g.
IAsyncServiceProvider.QueryServiceAsync(Guid)	Obtenez un service d’initialisation asynchrone proposé par ce package.
IOleCommandTarget.Exec(Guid, UInt32, UInt32, IntPtr, IntPtr)	Exécute une commande spécifiée ou affiche l'aide d'une commande. (Hérité de Package)
IOleCommandTarget.QueryStatus(Guid, UInt32, OLECMD[], IntPtr)	Interroge l'objet sur l'état d'une ou de plusieurs commandes générées par les événements d'interface utilisateur. (Hérité de Package)
IServiceContainer.AddService(Type, Object)	Ajoute le service donné au conteneur du service du package Visual Studio. (Hérité de Package)
IServiceContainer.AddService(Type, Object, Boolean)	Ajoute le service donné au conteneur du service du package Visual Studio. (Hérité de Package)
IServiceContainer.AddService(Type, ServiceCreatorCallback)	Ajoute le service donné au conteneur du service du package Visual Studio. (Hérité de Package)
IServiceContainer.AddService(Type, ServiceCreatorCallback, Boolean)	Ajoute le service donné au conteneur de service au moyen du ServiceCreatorCallback spécifié. (Hérité de Package)
IServiceContainer.RemoveService(Type)	Supprime le type de service donné du conteneur de services. (Hérité de Package)
IServiceContainer.RemoveService(Type, Boolean)	Supprime le type de service donné du conteneur de service et promeut éventuellement la suppression du service vers les conteneurs de service parents. (Hérité de Package)
IServiceProvider.GetService(Type)	Obtient le service du type spécifié. (Hérité de Package)
IServiceProvider.QueryService(Guid, Guid, IntPtr)	Implémentation IServiceProvider interne. (Hérité de Package)
IVsAsyncToolWindowFactory.CreateToolWindow(Guid, UInt32, Object)	Crée une fenêtre Outil du type spécifié avec l'ID spécifié.
IVsAsyncToolWindowFactory.GetToolWindowTitle(Guid, UInt32)	Retourne la chaîne de titre à utiliser pour la fenêtre d’outil. Si null est retourné, le nom de type de la fenêtre d’outil est utilisé pour le titre.
IVsAsyncToolWindowFactory.InitializeToolWindowAsync(Guid, UInt32)	Effectue l’initialisation en préparation de la création de la fenêtre d’outil identifiée par toolWindowType.
IVsPackage.Close()	Ferme et supprime le package. (Hérité de Package)
IVsPackage.GetAutomationObject(String, Object)	Obtient un objet d'automation convivial pour ce package. (Hérité de Package)
IVsPackage.GetPropertyPage(Guid, VSPROPSHEETPAGE[])	Permet d’accéder aux options du menu Outils et aux pages de propriétés des boîtes de dialogue Personnaliser la boîte à outils. (Hérité de Package)
IVsPackage.QueryClose(Int32)	Appelé pour demander au VSPackage si l’interpréteur de commandes Visual Studio peut être fermé. (Hérité de Package)
IVsPackage.ResetDefaults(UInt32)	Réinitialise les valeurs par défaut de la boîte à outils. (Hérité de Package)
IVsPackage.SetSite(IServiceProvider)	Initialise le VSPackage dans l’environnement Visual Studio. (Hérité de Package)
IVsPersistSolutionOpts.LoadUserOptions(IVsSolutionPersistence, UInt32)	Charge les options utilisateur pour une solution donnée. (Hérité de Package)
IVsPersistSolutionOpts.ReadUserOptions(IStream, String)	Lit les options utilisateur pour une solution donnée. (Hérité de Package)
IVsPersistSolutionOpts.SaveUserOptions(IVsSolutionPersistence)	Enregistre les options utilisateur pour une solution donnée. (Hérité de Package)
IVsPersistSolutionOpts.WriteUserOptions(IStream, String)	Écrit les options utilisateur pour une solution donnée. (Hérité de Package)
IVsToolboxItemProvider.GetItemContent(String, UInt16, IntPtr)	Obtient un élément. (Hérité de Package)
IVsToolboxItemProvider2.GetItemContentAsync(String, UInt16)	Représente un VSPackage qui peut gérer des services asynchrones. (Hérité de Package)
IVsToolWindowFactory.CreateToolWindow(Guid, UInt32)	Crée une fenêtre Outil du type spécifié avec l'ID spécifié. (Hérité de Package)
IVsUserSettings.ExportSettings(String, IVsSettingsWriter)	Cette méthode implémente l'interface IVsUserSettings utilisée pour gérer des profils et des paramètres d'exportation/d'exportation des fichiers XML. (Hérité de Package)
IVsUserSettings.ImportSettings(String, IVsSettingsReader, UInt32, Int32)	Récupère la configuration d’un VSPackage à l’aide du mécanisme de paramètres Visual Studio lorsqu’un utilisateur sélectionne l’option d’importation de la fonctionnalité Paramètres d’importation/exportation dans le menu Outils de l’IDE. Cette méthode fait partie de l'implémentation de l'interface IVsUserSettings utilisée pour gérer des profils et importer/exporter des paramètres dans des fichiers XML. (Hérité de Package)
IVsUserSettingsMigration.MigrateSettings(IVsSettingsReader, IVsSettingsWriter, String)	Migre des paramètres d'une version antérieure. (Hérité de Package)
IVsUserSettingsQuery.NeedExport(String, Int32)	Détermine si les paramètres ont changé et doivent être réexporté. (Hérité de Package)

Méthodes d’extension

ProfferService<TService>(IAsyncServiceContainer, Func<CancellationToken,Task<Object>>)	Génère un service implémenté par le type spécifié dans un conteneur de service asynchrone. Lorsque le service est interrogé la première fois, la creator fonction est appelée. Le service proffered est promu au conteneur de service asynchrone parent.
ProfferService<TService>(IAsyncServiceContainer, Func<CancellationToken,Task<Object>>, Boolean)	Génère un service implémenté par le type spécifié dans un conteneur de service asynchrone. Lorsque le service est interrogé la première fois, la creator fonction est appelée.
ProfferService<TService>(IAsyncServiceContainer, Func<Task<Object>>)	Génère un service implémenté par le type spécifié dans un conteneur de service asynchrone. Lorsque le service est interrogé la première fois, la creator fonction est appelée. Le service proffered est promu au conteneur de service asynchrone parent.
ProfferService<TService>(IAsyncServiceContainer, Func<Task<Object>>, Boolean)	Génère un service implémenté par le type spécifié dans un conteneur de service asynchrone. Lorsque le service est interrogé la première fois, la creator fonction est appelée.
QueryService(IServiceProvider, Guid)	Obtient un service exposé par un fournisseur de services en fonction de son GUID de service.
QueryService<TService>(IServiceProvider)	Obtient un service exposé par un fournisseur de services en fonction de son type de service.
GetServiceAsync<TService,TInterface>(IAsyncServiceProvider)	Obtient une interface de service à partir d’un fournisseur de services de façon asynchrone.
GetServiceAsync<TService,TInterface>(IAsyncServiceProvider, Boolean)	Obtient une interface de service à partir d’un fournisseur de services de façon asynchrone.