AsyncPackage Klasse

Definition

Namespace:

Microsoft.VisualStudio.Shell

Assembly:

Microsoft.VisualStudio.Shell.15.0.dll

Paket:

Microsoft.VisualStudio.Shell.15.0 v17.9.37000

Stellt ein VSPackage dar, das asynchrone Dienste verarbeiten kann.

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

Vererbung

Object

Package

AsyncPackage

Abgeleitet

Microsoft.VisualStudio.Modeling.Shell.AsyncModelingPackage

Microsoft.VisualStudio.Shell.ExtensionPointAsyncPackage

Attribute

ComVisibleAttribute

Implementiert

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

Konstruktoren

AsyncPackage()

AsyncPackage-Standardkonstruktor.

Eigenschaften

ApplicationRegistryRoot	Ruft den Stammregistrierungsschlüssel der aktuellen Visual Studio-Registrierungsstruktur ab. (Geerbt von Package)
DisposalToken	Macht eine CancellationToken verfügbar, mit der überprüft werden kann, ob das Paket verworfen wurde. Dies kann bei asynchronen Aufgaben auftreten, die in einem Hintergrundthread ausgeführt werden, wenn Visual Studio mit dem Herunterfahren begonnen hat. Verwenden Sie ShutdownToken für einen früheren Hinweis darauf, dass VS heruntergefahren wird.
JoinableTaskCollection	Ruft die Auflistung der asynchronen Aufgaben ab, die von diesem Paket gestartet wurden.
JoinableTaskFactory	Ruft die Factory ab, die für asynchrone Aufgaben verwendet werden soll, die von diesem Paket gestartet werden.
UserDataPath	Ruft den Pfad zum Benutzerdatenspeicher für Visual Studio ab. (Geerbt von Package)
UserLocalDataPath	Ruft den Pfad zum lokalen Benutzerdatenspeicher für Visual Studio ab. (Geerbt von Package)
UserRegistryRoot	Ruft einen Registrierungsschlüssel ab, der verwendet werden kann, um Benutzerdaten zu speichern. (Geerbt von Package)
Zombied	Ruft einen Wert ab, der angibt, ob das Paket heruntergefahren wird. (Geerbt von Package)

Methoden

AddOptionKey(String)	Fügt der Liste der Wahltasten einen Benutzeroptionsschlüsselnamen hinzu. (Geerbt von Package)
AddService(Type, AsyncServiceCreatorCallback)	Fügt diesem Paket einen asynchronen Dienst hinzu. Dieser Dienst ist außerhalb dieses Pakets nicht sichtbar.
AddService(Type, AsyncServiceCreatorCallback, Boolean)	Fügt diesem Paket einen asynchronen Dienst hinzu. Dieser Dienst kann außerhalb dieses Pakets sichtbar sein, abhängig vom Wert von promote.
AddService(Type, AsyncServiceCreatorWithProgressCallback)	Fügt diesem Paket einen asynchronen Dienst hinzu, der Statusupdates während der Initialisierung unterstützt. Dieser Dienst ist außerhalb dieses Pakets nicht sichtbar.
AddService(Type, AsyncServiceCreatorWithProgressCallback, Boolean)	Fügt diesem Paket einen asynchronen Dienst hinzu, der Statusupdates während der Initialisierung unterstützt. Dieser Dienst kann außerhalb dieses Pakets sichtbar sein, abhängig vom Wert von promote.
CreateInstance(Guid, Guid, Type)	Erstellt das angegebene COM-Objekt mithilfe des CLSID-Objekts der lokalen Registrierung von Visual Studio. (Geerbt von Package)
CreateTool(Guid)	Ermöglicht abgeleiteten Klassen ggf. eine Implementierung bereitzustellen. (Geerbt von Package)
CreateToolWindow(Guid, Int32)	Erstellt ein Toolfenster des angegebenen Typs mit der angegebenen ID (Geerbt von Package)
CreateToolWindow(Type, Int32)	Erstellt ein Toolfenster des angegebenen Typs mit der angegebenen ID (Geerbt von Package)
CreateToolWindow(Type, Int32, Object)	Create ein Toolfenster des angegebenen Typs mit der angegebenen ID. (Geerbt von Package)
CreateToolWindow(Type, Int32, UInt32)	Erstellt ein Toolfenster des angegebenen Typs mit der angegebenen ID (Geerbt von Package)
CreateToolWindow(Type, Int32, UInt32, Object, Guid)	Create ein Toolfenster des angegebenen Typs mit der angegebenen ID. Dies ist die einzige Methode, die IVsUiShell.CreateToolWindow() aufrufen sollte. (Geerbt von Package)
Dispose(Boolean)	Entsorgt das -Objekt und das zugeordnete Abbruchtoken.
FindToolWindow(Type, Int32, Boolean)	Ruft das Toolfenster gemäß dem angegebenen Typ und der ID ab. (Geerbt von Package)
FindToolWindowAsync(Type, Int32, Boolean, CancellationToken)	Sucht asynchron das Toolfenster, das dem angegebenen Typ und der angegebenen ID entspricht. Wenn es nicht vorhanden ist, wird eine erstellt und zurückgegeben, wenn create true ist, oder null zurückgegeben, wenn create false ist.
FindWindowPane(Type, Int32, Boolean)	Ruft den Fensterbereich gemäß dem angegebenen Typ und der ID ab; wenn kein Fensterbereich dieses Typs vorhanden ist, wird auf Befehl ein solcher erzeugt. (Geerbt von Package)
FindWindowPaneAsync(Type, Int32, Boolean, CancellationToken)	Sucht asynchron den Fensterbereich, der dem angegebenen Typ und der angegebenen ID entspricht. Wenn es nicht vorhanden ist, wird eine erstellt und zurückgegeben, wenn create true ist, oder null zurückgegeben, wenn create false ist.
GetAsyncToolWindowFactory(Guid)	Gibt die Factoryschnittstelle des asynchronen Toolfensters für das von toolWindowTypeidentifizierte Toolfenster zurück, wenn die asynchrone Erstellung für das Toolfenster unterstützt wird. Wenn die asynchrone Erstellung nicht unterstützt wird, wird NULL zurückgegeben.
GetAutomationObject(String)	Ruft das Automatisierungsobjekt für das VSPackage ab. (Geerbt von Package)
GetDialogPage(Type)	Ruft den angeforderten Dialogfeldbereich ab. (Geerbt von Package)
GetOutputPane(Guid, String)	Ruft das angeforderte Ausgabefenster ab. (Geerbt von Package)
GetProviderLocale()	Gibt das Gebietsschema zurück, das mit diesem Dienstanbieter verknüpft ist. (Geerbt von Package)
GetService(Type)	Ruft einen bei diesem Paket registrierten Dienst ab. Diese Methode ist synchron, und selbst asynchrone Dienste, die auf diese Weise abgerufen werden, werden synchron abgerufen.
GetServiceAsync(Type)	Ruft einen asynchronen Dienst ab.
GetServiceAsync(Type, Boolean)	Ruft einen asynchronen Dienst ab, ermöglicht dem Aufrufer jedoch den Hinweis, dass Ausnahmen möglicherweise nicht geschluckt werden müssen. Es garantiert jedoch nicht, dass Ausnahmen für Fehlerfälle ausgelöst werden.
GetToolboxItemData(String, DataFormats+Format)	Ruft den Inhalt des Datenformats für die angegebene Toolboxelement-ID und das Datenformat ab. (Geerbt von Package)
GetToolboxItemDataAsync(String, DataFormats+Format)	Stellt ein VSPackage dar, das asynchrone Dienste verarbeiten kann. (Geerbt von Package)
GetToolWindowTitle(Type, Int32)	Gibt die Titelzeichenfolge zurück, die für das Toolfenster verwendet werden soll. Wenn NULL zurückgegeben wird, wird der Typname des Toolfensters für den Titel verwendet.
Initialize()	Versiegeln Sie diese Methode. Aufgrund eines fast unvermeidbaren Deadlockrisikos tritt SetSite (was Initialize aufruft) im UI-Thread auch für ein asynchrones Paket weiterhin auf. Da die meisten asynchronen Paketautoren logischerweise davon ausgehen würden, dass die Initialisierung in einem b/g-Thread erfolgt, können sie teure (synchrone) Dinge innerhalb ihrer Überschreibung ausführen, wodurch einige vorteile von asynchronen Ladevorgängen beeinträchtigt werden. Um sie davon wegzuleiten, werden wir es versiegeln und somit können sie nur asynchron initialisieren, was im b/g-Thread aufgerufen wird.
InitializeAsync(CancellationToken, IProgress<ServiceProgressData>)	Der asynchrone Initialisierungsteil des Paketinitialisierungsprozesses. Diese Methode wird aus einem Hintergrundthread aufgerufen.
InitializeToolWindowAsync(Type, Int32, CancellationToken)	Führt die Initialisierung in Vorbereitung für das Erstellen des von identifizierten Toolfensters aus toolWindowType.
InstantiateToolWindow(Type)	Stellt ein VSPackage dar, das asynchrone Dienste verarbeiten kann. (Geerbt von Package)
InstantiateToolWindow(Type, Object)	Erstellen Sie ein Toolfenster des angegebenen Typs. (Geerbt von Package)
IsLocalService(Type)	Bestimmt, ob der angegebene Diensttyp abgerufen werden kann, ohne dass ein RPC-Übergang zum UI-Thread erforderlich ist. (Geerbt von Package)
OnAfterPackageLoadedAsync(CancellationToken)	Wenn sie von einem abgeleiteten Typ überschrieben wird, können Vorgänge mit Nebenwirkungen initiiert werden, die nicht unbedingt Teil der Paketlast sind, InitializeAsync(CancellationToken, IProgress<ServiceProgressData>) die aber bald nach dem Laden des Pakets auftreten sollten (z. B. Aktualisierungsbefehl status).
OnLoadOptions(String, Stream)	Aufgerufen von der Paketklasse, wenn es Optionen gibt, die aus der Projektmappendatei gelesen werden sollen. (Geerbt von Package)
OnSaveOptions(String, Stream)	Aufgerufen durch die Package-Klasse, wenn es Optionen gibt, die in der Projektmappendatei gespeichert werden sollen. (Geerbt von Package)
ParseToolboxResource(TextReader, Guid)	Analysiert eine eingebettete Textressource im entsprechenden Format, um Informationen darüber zu erhalten, welche Elemente der Toolbox hinzugefügt werden sollen. (Geerbt von Package)
ParseToolboxResource(TextReader, ResourceManager)	Analysiert eine eingebettete Textressource im entsprechenden Format, um Informationen darüber zu erhalten, welche Elemente der Toolbox hinzugefügt werden sollen. (Geerbt von Package)
QueryClose(Boolean)	Wird aufgerufen, um das Paket anzufordern, ob die Shell geschlossen werden kann. (Geerbt von Package)
RegisterEditorFactory(IVsEditorFactory)	Registriert eine Editor factory bei Visual Studio. (Geerbt von Package)
RegisterProjectFactory(IVsProjectFactory)	Registriert eine Projektzuordnungsinstanz bei Visual Studio. (Geerbt von Package)
RemoveService(Type)	Entfernt einen für dieses Paket registrierten asynchronen Dienst.
RemoveService(Type, Boolean)	Entfernt einen für dieses Paket registrierten asynchronen Dienst.
ShowOptionPage(Type)	Zeigt eine angegebene Tooloptionen-Seite an. (Geerbt von Package)
ShowToolWindowAsync(Type, Int32, Boolean, CancellationToken)	Zeigt asynchron das Toolfenster an, das dem angegebenen Typ und der angegebenen ID entspricht. Wenn es nicht vorhanden ist, wird eine erstellt und zurückgegeben, wenn create true ist, oder null zurückgegeben, wenn create false ist.

Ereignisse

ToolboxInitialized	Das Ereignis wird generiert, wenn Visual Studio seine Toolbox initialisiert. (Geerbt von Package)
ToolboxUpgraded	Das Ereignis wird generiert, wenn Visual Studio die Toolbox aktualisiert. (Geerbt von Package)

Explizite Schnittstellenimplementierungen

IAsyncLoadablePackageInitialize.Initialize(IAsyncServiceProvider, IProfferAsyncService, IAsyncProgressCallback)	Asynchrone Version von SetSite, aufgerufen aus einem b/g-Thread.
IAsyncServiceProvider.QueryServiceAsync(Guid)	Rufen Sie einen asynchronen Initialisierungsdienst ab, der von diesem Paket angeboten wird.
IOleCommandTarget.Exec(Guid, UInt32, UInt32, IntPtr, IntPtr)	Führt den angegebenen Befehl aus oder zeigt die Hilfe für den Befehl an. (Geerbt von Package)
IOleCommandTarget.QueryStatus(Guid, UInt32, OLECMD[], IntPtr)	Fragt das Objekt nach dem Status eines oder mehrerer Befehle ab, die von Benutzeroberflächenereignissen generiert wurden. (Geerbt von Package)
IServiceContainer.AddService(Type, Object)	Fügt den angegebenen Dienst dem Dienstcontainer von VSPackage hinzu. (Geerbt von Package)
IServiceContainer.AddService(Type, Object, Boolean)	Fügt den angegebenen Dienst dem Dienstcontainer von VSPackage hinzu. (Geerbt von Package)
IServiceContainer.AddService(Type, ServiceCreatorCallback)	Fügt den angegebenen Dienst dem Dienstcontainer von VSPackage hinzu. (Geerbt von Package)
IServiceContainer.AddService(Type, ServiceCreatorCallback, Boolean)	Fügt dem Dienstcontainer den angegebenen Dienst mithilfe des angegebenen ServiceCreatorCallback hinzu. (Geerbt von Package)
IServiceContainer.RemoveService(Type)	Entfernt den gegebenen Diensttyp aus dem Dienstcontainer. (Geerbt von Package)
IServiceContainer.RemoveService(Type, Boolean)	Entfernt den gegebenen Diensttyp aus dem Dienstcontainer und führt optional das Entfernen des Dienstes in übergeordneten Dienstcontainer durch. (Geerbt von Package)
IServiceProvider.GetService(Type)	Ruft den Dienst des angegebenen Typs ab. (Geerbt von Package)
IServiceProvider.QueryService(Guid, Guid, IntPtr)	Interne IServiceProvider-Implementierung. (Geerbt von Package)
IVsAsyncToolWindowFactory.CreateToolWindow(Guid, UInt32, Object)	Erstellt ein Toolfenster des angegebenen Typs mit der angegebenen ID
IVsAsyncToolWindowFactory.GetToolWindowTitle(Guid, UInt32)	Gibt die Titelzeichenfolge zurück, die für das Toolfenster verwendet werden soll. Wenn NULL zurückgegeben wird, wird der Typname des Toolfensters für den Titel verwendet.
IVsAsyncToolWindowFactory.InitializeToolWindowAsync(Guid, UInt32)	Führt die Initialisierung in Vorbereitung für das Erstellen des von identifizierten Toolfensters aus toolWindowType.
IVsPackage.Close()	Schließt das Paket und stellt es bereit. (Geerbt von Package)
IVsPackage.GetAutomationObject(String, Object)	Ruft ein automatisierungsfreundliches Objekt für dieses Paket ab. (Geerbt von Package)
IVsPackage.GetPropertyPage(Guid, VSPROPSHEETPAGE[])	Proffers Zugriff auf das Menü Extras Optionen und die Eigenschaftenseiten des Dialogfelds Toolbox anpassen. (Geerbt von Package)
IVsPackage.QueryClose(Int32)	Wird aufgerufen, um das VSPackage zu fragen, ob die Visual Studio-Shell geschlossen werden kann. (Geerbt von Package)
IVsPackage.ResetDefaults(UInt32)	Setzt Toolbox-Standardwerte zurück. (Geerbt von Package)
IVsPackage.SetSite(IServiceProvider)	Initialisiert das VSPackage in der Visual Studio-Umgebung. (Geerbt von Package)
IVsPersistSolutionOpts.LoadUserOptions(IVsSolutionPersistence, UInt32)	Lädt Benutzeroptionen für eine angegebene Projektmappe. (Geerbt von Package)
IVsPersistSolutionOpts.ReadUserOptions(IStream, String)	Liest Benutzeroptionen für eine angegebene Projektmappe. (Geerbt von Package)
IVsPersistSolutionOpts.SaveUserOptions(IVsSolutionPersistence)	Speichert Benutzeroptionen für eine angegebene Projektmappe. (Geerbt von Package)
IVsPersistSolutionOpts.WriteUserOptions(IStream, String)	Schreibt Benutzeroptionen für eine angegebene Projektmappe. (Geerbt von Package)
IVsToolboxItemProvider.GetItemContent(String, UInt16, IntPtr)	Ruft einen Element ab. (Geerbt von Package)
IVsToolboxItemProvider2.GetItemContentAsync(String, UInt16)	Stellt ein VSPackage dar, das asynchrone Dienste verarbeiten kann. (Geerbt von Package)
IVsToolWindowFactory.CreateToolWindow(Guid, UInt32)	Erstellt ein Toolfenster des angegebenen Typs mit der angegebenen ID (Geerbt von Package)
IVsUserSettings.ExportSettings(String, IVsSettingsWriter)	Diese Methode implementiert die IVsUserSettings-Schnittstelle, die verwendet wird, um Profile sowie Import- und/Exporteinstellungen für XML-Dateien zu verwalten. (Geerbt von Package)
IVsUserSettings.ImportSettings(String, IVsSettingsReader, UInt32, Int32)	Ruft die Konfiguration eines VSPackage mithilfe des Visual Studio-Einstellungsmechanismus ab, wenn ein Benutzer die Importoption des Features Import/Export Settings im Menü Extras der IDE auswählt. Diese Methode ist Teil der Implementierung der IVsUserSettings-Schnittstelle, die verwendet wird, um Profile sowie Import- und Exporteinstellungen für XML-Dateien zu verwalten. (Geerbt von Package)
IVsUserSettingsMigration.MigrateSettings(IVsSettingsReader, IVsSettingsWriter, String)	Migriert Einstellungen aus einer früheren Version. (Geerbt von Package)
IVsUserSettingsQuery.NeedExport(String, Int32)	Bestimmt, ob sich die Einstellungen geändert haben und erneut exportiert werden sollen. (Geerbt von Package)

Erweiterungsmethoden

ProfferService<TService>(IAsyncServiceContainer, Func<CancellationToken,Task<Object>>)	Übergibt einen vom angegebenen Typ implementierten Dienst in einen asynchronen Dienstcontainer. Wenn der Dienst zum ersten Mal abgefragt wird, wird die creator Funktion aufgerufen. Der proffered-Dienst wird zum übergeordneten asynchronen Dienstcontainer heraufgestuft.
ProfferService<TService>(IAsyncServiceContainer, Func<CancellationToken,Task<Object>>, Boolean)	Übergibt einen vom angegebenen Typ implementierten Dienst in einen asynchronen Dienstcontainer. Wenn der Dienst zum ersten Mal abgefragt wird, wird die creator Funktion aufgerufen.
ProfferService<TService>(IAsyncServiceContainer, Func<Task<Object>>)	Übergibt einen vom angegebenen Typ implementierten Dienst in einen asynchronen Dienstcontainer. Wenn der Dienst zum ersten Mal abgefragt wird, wird die creator Funktion aufgerufen. Der proffered-Dienst wird zum übergeordneten asynchronen Dienstcontainer heraufgestuft.
ProfferService<TService>(IAsyncServiceContainer, Func<Task<Object>>, Boolean)	Übergibt einen vom angegebenen Typ implementierten Dienst in einen asynchronen Dienstcontainer. Wenn der Dienst zum ersten Mal abgefragt wird, wird die creator Funktion aufgerufen.
QueryService(IServiceProvider, Guid)	Ruft einen Dienst ab, der von einem Dienstanbieter basierend auf seiner Dienst-GUID verfügbar gemacht wird.
QueryService<TService>(IServiceProvider)	Ruft einen Dienst ab, der von einem Dienstanbieter basierend auf seinem Diensttyp verfügbar gemacht wird.
GetServiceAsync<TService,TInterface>(IAsyncServiceProvider)	Ruft asynchron eine Dienstschnittstelle von einem Dienstanbieter ab.
GetServiceAsync<TService,TInterface>(IAsyncServiceProvider, Boolean)	Ruft asynchron eine Dienstschnittstelle von einem Dienstanbieter ab.