AsyncPackage Klasa

Definicja

Przestrzeń nazw:

Microsoft.VisualStudio.Shell

Zestaw:

Microsoft.VisualStudio.Shell.15.0.dll

Pakiet:

Microsoft.VisualStudio.Shell.15.0 v17.9.37000

Reprezentuje pakiet VSPackage, który może obsługiwać usługi asynchroniczne.

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

Dziedziczenie

Object

Package

AsyncPackage

Pochodne

Microsoft.VisualStudio.Modeling.Shell.AsyncModelingPackage

Microsoft.VisualStudio.Shell.ExtensionPointAsyncPackage

Atrybuty

ComVisibleAttribute

Implementuje

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

Konstruktory

AsyncPackage()

Domyślny konstruktor AsyncPackage.

Właściwości

ApplicationRegistryRoot	Pobiera główny klucz rejestru bieżącej gałęzi rejestru programu Visual Studio. (Odziedziczone po Package)
DisposalToken	Uwidacznia element CancellationToken , który może służyć do sprawdzania, czy pakiet został usunięty. Może się to zdarzyć w przypadku zadań asynchronicznych uruchomionych w wątku w tle, gdy program Visual Studio zaczął się zamykać. Użyj polecenia ShutdownToken dla wcześniejszego wskazania, że program VS jest zamykany.
JoinableTaskCollection	Pobiera kolekcję zadań asynchronicznych uruchomionych przez ten pakiet.
JoinableTaskFactory	Pobiera fabrykę do użycia na potrzeby zadań asynchronicznych uruchamianych przez ten pakiet.
UserDataPath	Pobiera ścieżkę do magazynu danych użytkownika dla programu Visual Studio. (Odziedziczone po Package)
UserLocalDataPath	Pobiera ścieżkę do magazynu danych użytkownika lokalnego dla programu Visual Studio. (Odziedziczone po Package)
UserRegistryRoot	Pobiera klucz rejestru, który może służyć do przechowywania danych użytkownika. (Odziedziczone po Package)
Zombied	Pobiera wartość wskazującą, czy pakiet w procesie zamykania. (Odziedziczone po Package)

Metody

AddOptionKey(String)	Dodaje nazwę klucza opcji użytkownika do listy kluczy opcji. (Odziedziczone po Package)
AddService(Type, AsyncServiceCreatorCallback)	Dodaje usługę asynchronizową do tego pakietu. Ta usługa nie będzie widoczna poza tym pakietem.
AddService(Type, AsyncServiceCreatorCallback, Boolean)	Dodaje usługę asynchronizową do tego pakietu. Ta usługa może być widoczna poza tym pakietem, w zależności od wartości promote.
AddService(Type, AsyncServiceCreatorWithProgressCallback)	Dodaje do tego pakietu usługę asynchronizową, która obsługuje aktualizacje postępu podczas inicjowania. Ta usługa nie będzie widoczna poza tym pakietem.
AddService(Type, AsyncServiceCreatorWithProgressCallback, Boolean)	Dodaje do tego pakietu usługę asynchronizową, która obsługuje aktualizacje postępu podczas inicjowania. Ta usługa może być widoczna poza tym pakietem, w zależności od wartości promote.
CreateInstance(Guid, Guid, Type)	Tworzy określony obiekt COM przy użyciu lokalnego obiektu rejestru programu Visual Studio CLSID. (Odziedziczone po Package)
CreateTool(Guid)	Umożliwia klasom pochodnym zapewnienie implementacji w razie potrzeby. (Odziedziczone po Package)
CreateToolWindow(Guid, Int32)	Tworzy okno narzędzi określonego typu o określonym identyfikatorze. (Odziedziczone po Package)
CreateToolWindow(Type, Int32)	Tworzy okno narzędzi określonego typu o określonym identyfikatorze. (Odziedziczone po Package)
CreateToolWindow(Type, Int32, Object)	Twórca okno narzędzia określonego typu o określonym identyfikatorze. (Odziedziczone po Package)
CreateToolWindow(Type, Int32, UInt32)	Tworzy okno narzędzi określonego typu o określonym identyfikatorze. (Odziedziczone po Package)
CreateToolWindow(Type, Int32, UInt32, Object, Guid)	Twórca okno narzędzia określonego typu o określonym identyfikatorze. Jest to jedyna metoda, która powinna wywoływać interfejs IVsUiShell.CreateToolWindow() (Odziedziczone po Package)
Dispose(Boolean)	Usuwa obiekt i skojarzony token anulowania.
FindToolWindow(Type, Int32, Boolean)	Pobiera okno narzędzia odpowiadające określonemu typowi i identyfikatorowi. (Odziedziczone po Package)
FindToolWindowAsync(Type, Int32, Boolean, CancellationToken)	Asynchronicznie lokalizuje okno narzędzia odpowiadające określonemu typowi i identyfikatorowi. Jeśli nie istnieje, tworzy i zwraca jeden, jeśli create ma wartość true, lub zwraca wartość null, jeśli create ma wartość false.
FindWindowPane(Type, Int32, Boolean)	Pobiera okienko okna odpowiadające określonemu typowi i identyfikatorowi, a jeśli żadne okienko okna tego typu nie istnieje, tworzy je, jeśli zostanie to powiedziane. (Odziedziczone po Package)
FindWindowPaneAsync(Type, Int32, Boolean, CancellationToken)	Asynchronicznie lokalizuje okienko okna odpowiadające określonemu typowi i identyfikatorowi. Jeśli nie istnieje, tworzy i zwraca jeden, jeśli create ma wartość true, lub zwraca wartość null, jeśli create ma wartość false.
GetAsyncToolWindowFactory(Guid)	Zwraca asynchroniczny interfejs fabryki okien narzędzi dla okna narzędzi identyfikowanego przez toolWindowTypeprogram , jeśli tworzenie asynchroniczne jest obsługiwane w oknie narzędzi. Jeśli tworzenie asynchroniczne nie jest obsługiwane, zwracana jest wartość null.
GetAutomationObject(String)	Pobiera obiekt automatyzacji dla pakietu VSPackage. (Odziedziczone po Package)
GetDialogPage(Type)	Pobiera żądaną stronę okna dialogowego. (Odziedziczone po Package)
GetOutputPane(Guid, String)	Pobiera żądane okno danych wyjściowych. (Odziedziczone po Package)
GetProviderLocale()	Zwraca ustawienia regionalne skojarzone z tym dostawcą usług. (Odziedziczone po Package)
GetService(Type)	Pobiera usługę zarejestrowaną w tym pakiecie. Ta metoda jest synchroniczna, a nawet usługi asynchroniczne pobierane w ten sposób będą pobierane synchronicznie.
GetServiceAsync(Type)	Pobiera usługę asynchronizową.
GetServiceAsync(Type, Boolean)	Pobiera usługi asynchroniczne, ale umożliwia wywołującym wskazówkę, że wyjątki mogą nie być połykane. Nie gwarantuje, że wyjątki zostaną zgłoszone w przypadku awarii.
GetToolboxItemData(String, DataFormats+Format)	Pobiera zawartość formatu danych dla określonego identyfikatora elementu przybornika i formatu danych. (Odziedziczone po Package)
GetToolboxItemDataAsync(String, DataFormats+Format)	Reprezentuje pakiet VSPackage, który może obsługiwać usługi asynchroniczne. (Odziedziczone po Package)
GetToolWindowTitle(Type, Int32)	Zwraca ciąg tytułu do użycia w oknie narzędzi. Jeśli jest zwracana wartość null, nazwa typu okna narzędzi jest używana dla tytułu.
Initialize()	Przypieczętuj tę metodę. Z powodu niemal nieuniknionego ryzyka zakleszczenia funkcja SetSite (co wywołuje metodę Initialize) nadal występuje w wątku interfejsu użytkownika nawet w przypadku pakietu asynchronicznego. Ponieważ większość autorów pakietów asynchronicznych, logicznie zakłada, że inicjowanie ma miejsce w wątku b/g, które mogą wykonywać kosztowne (synchroniczne) rzeczy wewnątrz ich zastąpienia, pokonując niektóre korzyści z obciążeń asynchronicznych. Aby pomóc w odprowadzeniu ich od tego, że przypieczętujemy go, a tym samym wszystko, co mogą przesłonić, jest inicjalizacja asynchroniczną, która jest wywoływana na wątku b/g.
InitializeAsync(CancellationToken, IProgress<ServiceProgressData>)	Część inicjowania asynchronicznego procesu inicjowania pakietu. Ta metoda jest wywoływana z wątku w tle.
InitializeToolWindowAsync(Type, Int32, CancellationToken)	Wykonuje inicjowanie w ramach przygotowań do utworzenia okna narzędzi zidentyfikowanych przez toolWindowTypeprogram .
InstantiateToolWindow(Type)	Reprezentuje pakiet VSPackage, który może obsługiwać usługi asynchroniczne. (Odziedziczone po Package)
InstantiateToolWindow(Type, Object)	Skonstruuj okno narzędzi określonego typu. (Odziedziczone po Package)
IsLocalService(Type)	Określa, czy określony typ usługi można pobrać bez konieczności przejścia RPC do wątku interfejsu użytkownika. (Odziedziczone po Package)
OnAfterPackageLoadedAsync(CancellationToken)	Po zastąpieniu przez typ pochodny może inicjować operacje z efektami ubocznymi, które nie są ściśle częścią obciążenia pakietu, które mogłyby należeć, InitializeAsync(CancellationToken, IProgress<ServiceProgressData>) ale które powinny nastąpić wkrótce po załadowaniu pakietu (np. aktualizowanie stanu polecenia).
OnLoadOptions(String, Stream)	Wywoływana przez klasę pakietu, gdy istnieją opcje, które mają zostać odczytane z pliku rozwiązania. (Odziedziczone po Package)
OnSaveOptions(String, Stream)	Wywoływana przez klasę Package , gdy istnieją opcje, które mają zostać zapisane w pliku rozwiązania. (Odziedziczone po Package)
ParseToolboxResource(TextReader, Guid)	Analizuje osadzony zasób tekstowy o odpowiednim formacie, aby uzyskać informacje o elementach, które należy dodać do przybornika. (Odziedziczone po Package)
ParseToolboxResource(TextReader, ResourceManager)	Analizuje osadzony zasób tekstowy o odpowiednim formacie, aby uzyskać informacje o elementach, które należy dodać do przybornika. (Odziedziczone po Package)
QueryClose(Boolean)	Wywołaj polecenie , aby zapytać pakiet, czy można zamknąć powłokę. (Odziedziczone po Package)
RegisterEditorFactory(IVsEditorFactory)	Rejestruje fabrykę edytora w programie Visual Studio. (Odziedziczone po Package)
RegisterProjectFactory(IVsProjectFactory)	Rejestruje fabrykę projektu w programie Visual Studio. (Odziedziczone po Package)
RemoveService(Type)	Usuwa usługę asynchronizową zarejestrowaną w tym pakiecie.
RemoveService(Type, Boolean)	Usuwa usługę asynchronizową zarejestrowaną w tym pakiecie.
ShowOptionPage(Type)	Wyświetla określoną stronę opcji narzędzi. (Odziedziczone po Package)
ShowToolWindowAsync(Type, Int32, Boolean, CancellationToken)	Asynchronicznie pokazuje okno narzędzia odpowiadające określonemu typowi i identyfikatorowi. Jeśli nie istnieje, tworzy i zwraca jeden, jeśli create ma wartość true, lub zwraca wartość null, jeśli create ma wartość false.

Zdarzenia

ToolboxInitialized	Zdarzenie generowane za każdym razem, gdy program Visual Studio inicjuje jego przybornik. (Odziedziczone po Package)
ToolboxUpgraded	Zdarzenie generowane za każdym razem, gdy program Visual Studio uaktualnia przybornik. (Odziedziczone po Package)

Jawne implementacje interfejsu

IAsyncLoadablePackageInitialize.Initialize(IAsyncServiceProvider, IProfferAsyncService, IAsyncProgressCallback)	Asynchronizuj wersję polecenia SetSite wywoływaną z wątku b/g.
IAsyncServiceProvider.QueryServiceAsync(Guid)	Pobierz asynchronizuj usługę inicjowania oferowaną przez ten pakiet.
IOleCommandTarget.Exec(Guid, UInt32, UInt32, IntPtr, IntPtr)	Wykonuje określone polecenie lub wyświetla pomoc dla polecenia. (Odziedziczone po Package)
IOleCommandTarget.QueryStatus(Guid, UInt32, OLECMD[], IntPtr)	Wysyła zapytanie do obiektu o stan co najmniej jednego polecenia wygenerowanego przez zdarzenia interfejsu użytkownika. (Odziedziczone po Package)
IServiceContainer.AddService(Type, Object)	Dodaje daną usługę do kontenera usługi VSPackage. (Odziedziczone po Package)
IServiceContainer.AddService(Type, Object, Boolean)	Dodaje daną usługę do kontenera usługi VSPackage. (Odziedziczone po Package)
IServiceContainer.AddService(Type, ServiceCreatorCallback)	Dodaje daną usługę do kontenera usługi VSPackage. (Odziedziczone po Package)
IServiceContainer.AddService(Type, ServiceCreatorCallback, Boolean)	Dodaje daną usługę do kontenera usługi za pomocą określonego ServiceCreatorCallbackelementu . (Odziedziczone po Package)
IServiceContainer.RemoveService(Type)	Usuwa dany typ usługi z kontenera usługi. (Odziedziczone po Package)
IServiceContainer.RemoveService(Type, Boolean)	Usuwa dany typ usługi z kontenera usługi i opcjonalnie promuje usunięcie usługi do kontenerów usługi nadrzędnej. (Odziedziczone po Package)
IServiceProvider.GetService(Type)	Pobiera usługę określonego typu. (Odziedziczone po Package)
IServiceProvider.QueryService(Guid, Guid, IntPtr)	Implementacja wewnętrznego dostawcy IServiceProvider. (Odziedziczone po Package)
IVsAsyncToolWindowFactory.CreateToolWindow(Guid, UInt32, Object)	Tworzy okno narzędzi określonego typu o określonym identyfikatorze.
IVsAsyncToolWindowFactory.GetToolWindowTitle(Guid, UInt32)	Zwraca ciąg tytułu do użycia w oknie narzędzi. Jeśli jest zwracana wartość null, nazwa typu okna narzędzi jest używana dla tytułu.
IVsAsyncToolWindowFactory.InitializeToolWindowAsync(Guid, UInt32)	Wykonuje inicjowanie w ramach przygotowań do utworzenia okna narzędzi zidentyfikowanych przez toolWindowTypeprogram .
IVsPackage.Close()	Zamyka i usuwa pakiet. (Odziedziczone po Package)
IVsPackage.GetAutomationObject(String, Object)	Pobiera przyjazny dla automatyzacji obiekt dla tego pakietu. (Odziedziczone po Package)
IVsPackage.GetPropertyPage(Guid, VSPROPSHEETPAGE[])	Dostęp do opcji menu Narzędzia i stron właściwości okna dialogowego Dostosowywanie przybornika. (Odziedziczone po Package)
IVsPackage.QueryClose(Int32)	Wywołanie polecenia , aby zapytać pakiet VSPackage, jeśli można zamknąć powłokę programu Visual Studio. (Odziedziczone po Package)
IVsPackage.ResetDefaults(UInt32)	Resetuje ustawienia domyślne przybornika. (Odziedziczone po Package)
IVsPackage.SetSite(IServiceProvider)	Inicjuje pakiet VSPackage w środowisku programu Visual Studio. (Odziedziczone po Package)
IVsPersistSolutionOpts.LoadUserOptions(IVsSolutionPersistence, UInt32)	Ładuje opcje użytkownika dla danego rozwiązania. (Odziedziczone po Package)
IVsPersistSolutionOpts.ReadUserOptions(IStream, String)	Odczytuje opcje użytkownika dla danego rozwiązania. (Odziedziczone po Package)
IVsPersistSolutionOpts.SaveUserOptions(IVsSolutionPersistence)	Zapisuje opcje użytkownika dla danego rozwiązania. (Odziedziczone po Package)
IVsPersistSolutionOpts.WriteUserOptions(IStream, String)	Zapisuje opcje użytkownika dla danego rozwiązania. (Odziedziczone po Package)
IVsToolboxItemProvider.GetItemContent(String, UInt16, IntPtr)	Pobiera element. (Odziedziczone po Package)
IVsToolboxItemProvider2.GetItemContentAsync(String, UInt16)	Reprezentuje pakiet VSPackage, który może obsługiwać usługi asynchroniczne. (Odziedziczone po Package)
IVsToolWindowFactory.CreateToolWindow(Guid, UInt32)	Tworzy okno narzędzi określonego typu o określonym identyfikatorze. (Odziedziczone po Package)
IVsUserSettings.ExportSettings(String, IVsSettingsWriter)	Ta metoda implementuje IVsUserSettings interfejs używany do zarządzania profilami i importowania/eksportowania ustawień do plików XML. (Odziedziczone po Package)
IVsUserSettings.ImportSettings(String, IVsSettingsReader, UInt32, Int32)	Pobiera konfigurację pakietu VSPackage przy użyciu mechanizmu ustawień programu Visual Studio, gdy użytkownik wybierze opcję importu funkcji Importuj/Eksportuj ustawienia w menu Narzędzia środowiska IDE. Ta metoda jest częścią implementacji interfejsu używanego IVsUserSettings do zarządzania profilami i importowania/eksportowania ustawień do plików XML. (Odziedziczone po Package)
IVsUserSettingsMigration.MigrateSettings(IVsSettingsReader, IVsSettingsWriter, String)	Migruje ustawienia z poprzedniej wersji. (Odziedziczone po Package)
IVsUserSettingsQuery.NeedExport(String, Int32)	Określa, czy ustawienia zostały zmienione i powinny zostać ponownie wyeksportowane. (Odziedziczone po Package)

Metody rozszerzania

ProfferService<TService>(IAsyncServiceContainer, Func<CancellationToken,Task<Object>>)	Proffers usługa zaimplementowana przez określony typ do kontenera usługi asynchronicznego. Gdy usługa jest odpytywane po raz pierwszy, creator funkcja zostanie wywołana. Usługa proffered zostanie podwyższona do nadrzędnego kontenera usługi asynchronicznego.
ProfferService<TService>(IAsyncServiceContainer, Func<CancellationToken,Task<Object>>, Boolean)	Proffers usługa zaimplementowana przez określony typ do kontenera usługi asynchronicznego. Gdy usługa jest odpytywane po raz pierwszy, creator funkcja zostanie wywołana.
ProfferService<TService>(IAsyncServiceContainer, Func<Task<Object>>)	Proffers usługa zaimplementowana przez określony typ do kontenera usługi asynchronicznego. Gdy usługa jest odpytywane po raz pierwszy, creator funkcja zostanie wywołana. Usługa proffered zostanie podwyższona do nadrzędnego kontenera usługi asynchronicznego.
ProfferService<TService>(IAsyncServiceContainer, Func<Task<Object>>, Boolean)	Proffers usługa zaimplementowana przez określony typ do kontenera usługi asynchronicznego. Gdy usługa jest odpytywane po raz pierwszy, creator funkcja zostanie wywołana.
QueryService(IServiceProvider, Guid)	Pobiera usługę uwidocznianą przez dostawcę usług na podstawie jego identyfikatora GUID usługi.
QueryService<TService>(IServiceProvider)	Pobiera usługę uwidocznianą przez dostawcę usług na podstawie typu usługi.
GetServiceAsync<TService,TInterface>(IAsyncServiceProvider)	Asynchronicznie pobiera interfejs usługi od dostawcy usług.
GetServiceAsync<TService,TInterface>(IAsyncServiceProvider, Boolean)	Asynchronicznie pobiera interfejs usługi od dostawcy usług.