AsyncPackage Klasse

Definition

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::IAsyncServiceProvider, Microsoft::VisualStudio::Shell::Interop::IAsyncLoadablePackageInitialize, Microsoft::VisualStudio::Shell::Interop::IAsyncServiceProvider
public ref class AsyncPackage abstract : Microsoft::VisualStudio::Shell::Package, Microsoft::VisualStudio::Shell::IAsyncServiceContainer, 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]
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.IAsyncServiceProvider, Microsoft.VisualStudio.Shell.Interop.IAsyncLoadablePackageInitialize, Microsoft.VisualStudio.Shell.Interop.IAsyncServiceProvider
[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.IAsyncLoadablePackageInitialize, Microsoft.VisualStudio.Shell.Interop.IAsyncServiceProvider, 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 IAsyncServiceProvider
    interface IAsyncServiceContainer
[<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, IAsyncServiceProvider
Public MustInherit Class AsyncPackage
Inherits Package
Implements IAsyncLoadablePackageInitialize, IAsyncServiceContainer, IAsyncServiceProvider, IAsyncServiceProvider2, IVsAsyncToolWindowFactory, IVsAsyncToolWindowFactoryProvider
Vererbung
AsyncPackage
Abgeleitet
Attribute
Implementiert

Konstruktoren

AsyncPackage()

Der Standardkonstruktor von asyncpackage.

Eigenschaften

ApplicationRegistryRoot

Ruft den Stamm Registrierungsschlüssel der aktuellen Visual Studio-Registrierungs Struktur ab.

(Geerbt von Package)
DisposalToken

Macht ein verfügbar CancellationToken , das verwendet werden kann, um zu überprüfen, ob das Paket verworfen wurde. Dies kann bei asynchronen Tasks vorkommen, die in einem Hintergrund Thread ausgeführt werden, wenn Visual Studio mit dem Herunterfahren begonnen hat. Verwenden ShutdownToken Sie für einen früheren Hinweis darauf, dass vs heruntergefahren wird.

JoinableTaskCollection

Ruft die Auflistung der asynchronen Tasks ab, die von diesem Paket gestartet werden.

JoinableTaskFactory

Ruft die Factory ab, die für asynchrone Aufgaben verwendet wird, die von diesem Paket gestartet werden.

UserDataPath

Ruft den Pfad zum Benutzerdaten Speicher für Visual Studio ab.

(Geerbt von Package)
UserLocalDataPath

Ruft den Pfad zum lokalen Benutzerdaten Speicher 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 Async-Dienst hinzu. Dieser Dienst wird außerhalb dieses Pakets nicht angezeigt.

AddService(Type, AsyncServiceCreatorCallback, Boolean)

Fügt diesem Paket einen Async-Dienst hinzu. Abhängig vom Wert von kann dieser Dienst außerhalb dieses Pakets sichtbar sein oder nicht angezeigt werden promote .

AddService(Type, AsyncServiceCreatorWithProgressCallback)

Fügt diesem Paket einen Async-Dienst hinzu, der während der Initialisierung Fortschritts Aktualisierungen unterstützt. Dieser Dienst wird außerhalb dieses Pakets nicht angezeigt.

AddService(Type, AsyncServiceCreatorWithProgressCallback, Boolean)

Fügt diesem Paket einen Async-Dienst hinzu, der während der Initialisierung Fortschritts Aktualisierungen unterstützt. Abhängig vom Wert von kann dieser Dienst außerhalb dieses Pakets sichtbar sein oder nicht angezeigt werden promote .

CreateInstance(Guid, Guid, Type)

Erstellt das angegebene COM-Objekt mit dem lokalen Registrierungs-CLSID-Objekt 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)

Erstellen Sie ein Tool Fenster 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)

Erstellen Sie ein Tool Fenster des angegebenen Typs mit der angegebenen ID. Dies ist die einzige Methode, die IVsUIShell. CreateToolWindow () aufrufen sollte.

(Geerbt von Package)
Dispose(Boolean)

Verwirft das-Objekt und das zugeordnete Abbruch Token.

FindToolWindow(Type, Int32, Boolean)

Ruft das Toolfenster gemäß dem angegebenen Typ und der ID ab.

(Geerbt von Package)
FindToolWindowAsync(Type, Int32, Boolean, CancellationToken)

Löst asynchron das Tool Fenster entsprechend dem angegebenen Typ und der ID aus. Wenn Sie nicht vorhanden ist, wird eine erstellt und zurückgegeben create , wenn true ist, oder gibt NULL zurück, 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)

Ordnet den Fensterbereich, der dem angegebenen Typ und der ID entspricht, asynchron nach. Wenn Sie nicht vorhanden ist, wird eine erstellt und zurückgegeben create , wenn true ist, oder gibt NULL zurück, wenn create false ist.

GetAsyncToolWindowFactory(Guid)

Gibt die asynchrone toolwindowsfactory-Schnittstelle für das Tool Fenster zurück, das durch identifiziert wird toolWindowType , wenn die asynchrone Erstellung für das Tool Fenster 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 Dienst ab, der bei diesem Paket registriert ist. Diese Methode ist synchron, und auch asynchrone Dienste, die auf diese Weise abgerufen werden, werden synchron abgerufen.

GetServiceAsync(Type)

Ruft einen Async-Dienst ab.

GetServiceAsync(Type, Boolean)

Ruft asynchrone Dienste ab, ermöglicht dem Aufrufer jedoch, anzuweisen, dass Ausnahmen möglicherweise nicht verschluckt werden müssen. Es wird jedoch nicht garantiert, 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) (Geerbt von Package)
GetToolWindowTitle(Type, Int32)

Gibt die für das Tool Fenster zu verwendende Titel Zeichenfolge zurück. Wenn NULL zurückgegeben wird, wird der Typname des Tool Fensters für den Titel verwendet.

Initialize()

Versiegeln Sie diese Methode. Aufgrund eines fast unvermeidbaren deadlockrisikos findet SetSite (der Aufruf initialisieren) immer noch im UI-Thread auch für ein Async-Paket statt. Da die meisten asynchronen Paket Autoren logisch davon ausgehen, dass die Initialisierung in einem b/g-Thread stattfindet, führen Sie möglicherweise in ihrer außer Kraft Setzung teure (synchrone) Dinge aus, die einen Teil des Vorteils der asynchronen Lasten Verb zwingen. Um dies zu erleichtern, werden wir das versiegeln und können daher alle überschreiben, wenn die asynchrone Initialisierung durchgeführt wird, die für den b/g-Thread aufgerufen wird.

InitializeAsync(CancellationToken, IProgress<ServiceProgressData>)

Der asynchrone Initialisierungs Teil des Paket Initialisierungs Prozesses. Diese Methode wird von einem Hintergrund Thread aufgerufen.

InitializeToolWindowAsync(Type, Int32, CancellationToken)

Führt die Initialisierung aus, um das von identifizierte Tool Fenster zu erstellen toolWindowType .

InstantiateToolWindow(Type) (Geerbt von Package)
InstantiateToolWindow(Type, Object)

Erstellen Sie ein Tool Fenster vom angegebenen Typ.

(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)

Beim Überschreiben durch einen abgeleiteten Typ können Vorgänge mit Nebeneffekten initiiert werden, die nicht unbedingt Teil der Paket Auslastung sind, die zu gehören, InitializeAsync(CancellationToken, IProgress<ServiceProgressData>) aber unmittelbar nach dem Laden des Pakets auftreten sollten (z. b. beim Aktualisieren des Befehlsstatus).

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 Text Ressource des entsprechenden Formats, um Informationen darüber zu geben, welche Elemente der Toolbox hinzugefügt werden sollen.

(Geerbt von Package)
ParseToolboxResource(TextReader, ResourceManager)

Analysiert eine eingebettete Text Ressource des entsprechenden Formats, um Informationen darüber zu geben, 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 Editorfactory bei Visual Studio.

(Geerbt von Package)
RegisterProjectFactory(IVsProjectFactory)

Registriert eine Projektzuordnungsinstanz bei Visual Studio.

(Geerbt von Package)
RemoveService(Type)

Entfernt einen Async-Dienst, der bei diesem Paket registriert ist.

RemoveService(Type, Boolean)

Entfernt einen Async-Dienst, der bei diesem Paket registriert ist.

ShowOptionPage(Type)

Zeigt eine angegebene Tooloptionen-Seite an.

(Geerbt von Package)
ShowToolWindowAsync(Type, Int32, Boolean, CancellationToken)

Zeigt das Tool Fenster, das dem angegebenen Typ und der ID entspricht, asynchron an. Wenn Sie nicht vorhanden ist, wird eine erstellt und zurückgegeben create , wenn true ist, oder gibt NULL zurück, wenn create false ist.

Ereignisse

ToolboxInitialized

Das Ereignis wird generiert, wenn Visual Studio die 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)

Async-Version von SetSite, die von einem b/g-Thread aufgerufen wird.

IAsyncServiceProvider.QueryServiceAsync(Guid)

Hiermit erhalten Sie einen asynchronen Initialisierungs Dienst, 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 für das Tool Fenster zu verwendende Titel Zeichenfolge zurück. Wenn NULL zurückgegeben wird, wird der Typname des Tool Fensters für den Titel verwendet.

IVsAsyncToolWindowFactory.InitializeToolWindowAsync(Guid, UInt32)

Führt die Initialisierung aus, um das von identifizierte Tool Fenster zu erstellen 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[])

Proffes für den Zugriff auf die Menü Optionen Extras und die Eigenschaften Seiten der Dialogfelder Toolbox anpassen.

(Geerbt von Package)
IVsPackage.QueryClose(Int32)

Wird aufgerufen, um das VSPackage anzufordern, wenn 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) (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 eine VSPackage-Konfiguration mithilfe des Visual Studio-Einstellungs Mechanismus ab, wenn ein Benutzer die Import Option der Funktion zum Importieren/Exportieren von Einstellungen 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 Einstellungen geändert haben und erneut exportiert werden sollen.

(Geerbt von Package)

Erweiterungsmethoden

ProfferService<TService>(IAsyncServiceContainer, Func<CancellationToken,Task<Object>>)

Stellt einen Dienst, der durch den angegebenen Typ implementiert ist, in einen asynchronen Dienst Container ein. Wenn der Dienst erstmalig abgefragt wird, wird die- creator Funktion aufgerufen. Der bereitgestellte Dienst wird zum übergeordneten Async-Dienst Container herauf gestuft.

ProfferService<TService>(IAsyncServiceContainer, Func<CancellationToken,Task<Object>>, Boolean)

Stellt einen Dienst, der durch den angegebenen Typ implementiert ist, in einen asynchronen Dienst Container ein. Wenn der Dienst erstmalig abgefragt wird, wird die- creator Funktion aufgerufen.

ProfferService<TService>(IAsyncServiceContainer, Func<Task<Object>>)

Stellt einen Dienst, der durch den angegebenen Typ implementiert ist, in einen asynchronen Dienst Container ein. Wenn der Dienst erstmalig abgefragt wird, wird die- creator Funktion aufgerufen. Der bereitgestellte Dienst wird zum übergeordneten Async-Dienst Container herauf gestuft.

ProfferService<TService>(IAsyncServiceContainer, Func<Task<Object>>, Boolean)

Stellt einen Dienst, der durch den angegebenen Typ implementiert ist, in einen asynchronen Dienst Container ein. Wenn der Dienst erstmalig abgefragt wird, wird die- creator Funktion aufgerufen.

QueryService(IServiceProvider, Guid)

Ruft einen Dienst ab, der von einem Dienstanbieter auf Grundlage seines Dienst Typs verfügbar gemacht wird.

QueryService<TService>(IServiceProvider)

Ruft einen Dienst ab, der von einem Dienstanbieter auf Grundlage seines Dienst Typs verfügbar gemacht wird.

GetServiceAsync<TService,TInterface>(IAsyncServiceProvider)

Ruft eine Dienst Schnittstelle asynchron von einem Dienstanbieter ab.

GetServiceAsync<TService,TInterface>(IAsyncServiceProvider, Boolean)

Ruft eine Dienst Schnittstelle asynchron von einem Dienstanbieter ab.

Gilt für