AsyncPackage クラス

定義

名前空間:

Microsoft.VisualStudio.Shell

アセンブリ:

Microsoft.VisualStudio.Shell.15.0.dll

パッケージ:

Microsoft.VisualStudio.Shell.15.0 v17.9.37000

非同期サービスを処理できる VSPackage を表します。

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

継承

Object

Package

AsyncPackage

派生

Microsoft.VisualStudio.Modeling.Shell.AsyncModelingPackage

Microsoft.VisualStudio.Shell.ExtensionPointAsyncPackage

属性

ComVisibleAttribute

実装

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

コンストラクター

AsyncPackage()

AsyncPackage の既定のコンストラクター。

プロパティ

ApplicationRegistryRoot	現在の Visual Studio レジストリ ハイブのルート レジストリ キーを取得します。 (継承元 Package)
DisposalToken	CancellationTokenパッケージが破棄された場合にチェックするために使用できる を公開します。 これは、Visual Studio のシャットダウンが開始されたときにバックグラウンド スレッドで実行されている非同期タスクで発生する可能性があります。 VS がシャットダウンしていることを以前に示す場合に使用 ShutdownToken します。
JoinableTaskCollection	このパッケージによって開始される非同期タスクのコレクションを取得します。
JoinableTaskFactory	このパッケージによって開始される非同期タスクに使用するファクトリを取得します。
UserDataPath	Visual Studio のユーザー データ ストレージへのパスを取得します。 (継承元 Package)
UserLocalDataPath	Visual Studio のローカル ユーザー データ ストレージへのパスを取得します。 (継承元 Package)
UserRegistryRoot	ユーザー データの格納に使用できるレジストリ キーを取得します。 (継承元 Package)
Zombied	シャットダウン処理中のパッケージかどうかを示す値を取得します。 (継承元 Package)

メソッド

AddOptionKey(String)	ユーザー オプション キー名をオプション キーの一覧に追加します。 (継承元 Package)
AddService(Type, AsyncServiceCreatorCallback)	このパッケージに非同期サービスを追加します。 このサービスは、このパッケージの外部には表示されません。
AddService(Type, AsyncServiceCreatorCallback, Boolean)	このパッケージに非同期サービスを追加します。 このサービスは、 の値 promoteに応じて、このパッケージの外部で表示される場合と表示されない場合があります。
AddService(Type, AsyncServiceCreatorWithProgressCallback)	初期化中の進行状況の更新をサポートする非同期サービスをこのパッケージに追加します。 このサービスは、このパッケージの外部には表示されません。
AddService(Type, AsyncServiceCreatorWithProgressCallback, Boolean)	初期化中の進行状況の更新をサポートする非同期サービスをこのパッケージに追加します。 このサービスは、 の値 promoteに応じて、このパッケージの外部で表示される場合と表示されない場合があります。
CreateInstance(Guid, Guid, Type)	Visual Studio のローカル レジストリ CLSID オブジェクトを使用して、指定した COM オブジェクトを作成します。 (継承元 Package)
CreateTool(Guid)	必要に応じて、派生クラスが実装を提供できるようにします。 (継承元 Package)
CreateToolWindow(Guid, Int32)	指定した ID を使用して、指定した型のツール ウィンドウを作成します。 (継承元 Package)
CreateToolWindow(Type, Int32)	指定した ID を使用して、指定した型のツール ウィンドウを作成します。 (継承元 Package)
CreateToolWindow(Type, Int32, Object)	指定した ID を持つ、指定した型のツール ウィンドウをCreateします。 (継承元 Package)
CreateToolWindow(Type, Int32, UInt32)	指定した ID を使用して、指定した型のツール ウィンドウを作成します。 (継承元 Package)
CreateToolWindow(Type, Int32, UInt32, Object, Guid)	指定した ID を持つ、指定した型のツール ウィンドウをCreateします。 これは、IVsUiShell.CreateToolWindow() を呼び出す唯一のメソッドです。 (継承元 Package)
Dispose(Boolean)	オブジェクトと関連付けられているキャンセル トークンを破棄します。
FindToolWindow(Type, Int32, Boolean)	指定した型と ID に対応するツール ウィンドウを取得します。 (継承元 Package)
FindToolWindowAsync(Type, Int32, Boolean, CancellationToken)	指定した型と ID に対応するツール ウィンドウを非同期的に検索します。 存在しない場合は、 が true の場合 create は 1 つを作成して返し、 が false の場合 create は null を返します。
FindWindowPane(Type, Int32, Boolean)	指定した型と ID に対応するウィンドウ ウィンドウを取得します。その種類のウィンドウ ウィンドウが存在しない場合は、そのウィンドウ ウィンドウが作成されます。 (継承元 Package)
FindWindowPaneAsync(Type, Int32, Boolean, CancellationToken)	指定した型と ID に対応するウィンドウ ウィンドウを非同期的に検索します。 存在しない場合は、 が true の場合 create は 1 つを作成して返し、 が false の場合 create は null を返します。
GetAsyncToolWindowFactory(Guid)	ツール ウィンドウで非同期作成がサポートされている場合は、 で toolWindowType識別されるツール ウィンドウの非同期ツール ウィンドウ ファクトリ インターフェイスを返します。 非同期作成がサポートされていない場合は、null が返されます。
GetAutomationObject(String)	VSPackage のオートメーション オブジェクトを取得します。 (継承元 Package)
GetDialogPage(Type)	要求されたダイアログ ページを取得します。 (継承元 Package)
GetOutputPane(Guid, String)	要求された出力ウィンドウを取得します。 (継承元 Package)
GetProviderLocale()	このサービス プロバイダーに関連付けられているロケールを返します。 (継承元 Package)
GetService(Type)	このパッケージに登録されているサービスを取得します。 このメソッドは同期的であり、この方法で取得された非同期サービスも同期的に取得されます。
GetServiceAsync(Type)	非同期サービスを取得します。
GetServiceAsync(Type, Boolean)	非同期サービスを取得しますが、呼び出し元は例外を飲み込む必要がない可能性があることを示唆できます。 ただし、失敗した場合に例外がスローされることは保証されません。
GetToolboxItemData(String, DataFormats+Format)	指定したツールボックス項目 ID とデータ形式のデータ形式の内容を取得します。 (継承元 Package)
GetToolboxItemDataAsync(String, DataFormats+Format)	非同期サービスを処理できる VSPackage を表します。 (継承元 Package)
GetToolWindowTitle(Type, Int32)	ツール ウィンドウに使用するタイトル文字列を返します。 null が返された場合、ツール ウィンドウの型名がタイトルに使用されます。
Initialize()	このメソッドをシールします。 デッドロックのリスクはほとんど避けられないため、非同期パッケージの場合でも、SetSite (Initialize を呼び出す) は UI スレッドで引き続き発生します。 ほとんどの非同期パッケージ作成者は、論理的には、Initialize が b/g スレッドで発生すると仮定するため、オーバーライドの内部でコストの高い (同期的な) 処理を行う可能性があり、非同期読み込みの利点の一部を打ち負かす可能性があります。 それを封印するので、オーバーライドできるのは非同期初期化であり、b/g スレッドで呼び出されます。
InitializeAsync(CancellationToken, IProgress<ServiceProgressData>)	パッケージ初期化プロセスの非同期初期化部分。 このメソッドは、バックグラウンド スレッドから呼び出されます。
InitializeToolWindowAsync(Type, Int32, CancellationToken)	によって toolWindowType識別されるツール ウィンドウを作成するための準備として初期化を実行します。
InstantiateToolWindow(Type)	非同期サービスを処理できる VSPackage を表します。 (継承元 Package)
InstantiateToolWindow(Type, Object)	指定した型のツール ウィンドウを作成します。 (継承元 Package)
IsLocalService(Type)	UI スレッドへの RPC 遷移を必要とせずに、指定したサービスの種類を取得できるかどうかを判断します。 (継承元 Package)
OnAfterPackageLoadedAsync(CancellationToken)	派生型によってオーバーライドされると、パッケージの読み込みの一部ではないが、パッケージの読み込み InitializeAsync(CancellationToken, IProgress<ServiceProgressData>) 後すぐに発生する必要がある副作用 (コマンドの状態の更新など) で操作が開始される場合があります。
OnLoadOptions(String, Stream)	ソリューション ファイルから読み取るオプションがある場合に、パッケージ クラスによって呼び出されます。 (継承元 Package)
OnSaveOptions(String, Stream)	ソリューション ファイルに Package 保存するオプションがある場合に、 クラスによって呼び出されます。 (継承元 Package)
ParseToolboxResource(TextReader, Guid)	ツールボックスに追加する項目に関する情報を得るために、適切な形式の埋め込みテキスト リソースを解析します。 (継承元 Package)
ParseToolboxResource(TextReader, ResourceManager)	ツールボックスに追加する項目に関する情報を得るために、適切な形式の埋め込みテキスト リソースを解析します。 (継承元 Package)
QueryClose(Boolean)	シェルを閉じることができるかどうかをパッケージに確認するために呼び出されます。 (継承元 Package)
RegisterEditorFactory(IVsEditorFactory)	エディター ファクトリを Visual Studio に登録します。 (継承元 Package)
RegisterProjectFactory(IVsProjectFactory)	プロジェクト ファクトリを Visual Studio に登録します。 (継承元 Package)
RemoveService(Type)	このパッケージに登録されている非同期サービスを削除します。
RemoveService(Type, Boolean)	このパッケージに登録されている非同期サービスを削除します。
ShowOptionPage(Type)	指定したツール オプション ページを表示します。 (継承元 Package)
ShowToolWindowAsync(Type, Int32, Boolean, CancellationToken)	指定した型と ID に対応するツール ウィンドウを非同期に表示します。 存在しない場合は、 が true の場合 create は 1 つを作成して返し、 が false の場合 create は null を返します。

イベント

ToolboxInitialized	Visual Studio がツールボックスを初期化するたびに生成されるイベント。 (継承元 Package)
ToolboxUpgraded	Visual Studio がツールボックスをアップグレードするたびに生成されるイベント。 (継承元 Package)

明示的なインターフェイスの実装

IAsyncLoadablePackageInitialize.Initialize(IAsyncServiceProvider, IProfferAsyncService, IAsyncProgressCallback)	B/g スレッドから呼び出される SetSite の非同期バージョン。
IAsyncServiceProvider.QueryServiceAsync(Guid)	このパッケージによって提供される非同期初期化サービスを取得します。
IOleCommandTarget.Exec(Guid, UInt32, UInt32, IntPtr, IntPtr)	指定したコマンドを実行するか、コマンドのヘルプを表示します。 (継承元 Package)
IOleCommandTarget.QueryStatus(Guid, UInt32, OLECMD[], IntPtr)	ユーザー インターフェイスのイベントによって生成された 1 つ以上のコマンドの状態のオブジェクトを照会します。 (継承元 Package)
IServiceContainer.AddService(Type, Object)	指定されたサービスを VSPackage のサービス コンテナーに追加します。 (継承元 Package)
IServiceContainer.AddService(Type, Object, Boolean)	指定されたサービスを VSPackage のサービス コンテナーに追加します。 (継承元 Package)
IServiceContainer.AddService(Type, ServiceCreatorCallback)	指定されたサービスを VSPackage のサービス コンテナーに追加します。 (継承元 Package)
IServiceContainer.AddService(Type, ServiceCreatorCallback, Boolean)	指定した を使用して、指定されたサービスをサービス コンテナーに追加します ServiceCreatorCallback。 (継承元 Package)
IServiceContainer.RemoveService(Type)	指定されたサービスの種類をサービス コンテナーから削除します。 (継承元 Package)
IServiceContainer.RemoveService(Type, Boolean)	指定したサービスの種類をサービス コンテナーから削除し、必要に応じて、サービスの削除を親サービス コンテナーに昇格させます。 (継承元 Package)
IServiceProvider.GetService(Type)	指定した型のサービスを取得します。 (継承元 Package)
IServiceProvider.QueryService(Guid, Guid, IntPtr)	IServiceProvider の内部実装。 (継承元 Package)
IVsAsyncToolWindowFactory.CreateToolWindow(Guid, UInt32, Object)	指定した ID を使用して、指定した型のツール ウィンドウを作成します。
IVsAsyncToolWindowFactory.GetToolWindowTitle(Guid, UInt32)	ツール ウィンドウに使用するタイトル文字列を返します。 null が返された場合、ツール ウィンドウの型名がタイトルに使用されます。
IVsAsyncToolWindowFactory.InitializeToolWindowAsync(Guid, UInt32)	によって toolWindowType識別されるツール ウィンドウを作成するための準備として初期化を実行します。
IVsPackage.Close()	パッケージを閉じて破棄します。 (継承元 Package)
IVsPackage.GetAutomationObject(String, Object)	このパッケージのオートメーションに適したオブジェクトを取得します。 (継承元 Package)
IVsPackage.GetPropertyPage(Guid, VSPROPSHEETPAGE[])	[ツール] メニューの [オプション] および [ツールボックスのカスタマイズ] ダイアログ ボックスのプロパティ ページにアクセスできます。 (継承元 Package)
IVsPackage.QueryClose(Int32)	Visual Studio シェルを閉じることができるかどうかを VSPackage に確認するために呼び出されます。 (継承元 Package)
IVsPackage.ResetDefaults(UInt32)	ツールボックスの既定値をリセットします。 (継承元 Package)
IVsPackage.SetSite(IServiceProvider)	Visual Studio 環境で VSPackage を初期化します。 (継承元 Package)
IVsPersistSolutionOpts.LoadUserOptions(IVsSolutionPersistence, UInt32)	特定のソリューションのユーザー オプションを読み込みます。 (継承元 Package)
IVsPersistSolutionOpts.ReadUserOptions(IStream, String)	特定のソリューションのユーザー オプションを読み取ります。 (継承元 Package)
IVsPersistSolutionOpts.SaveUserOptions(IVsSolutionPersistence)	特定のソリューションのユーザー オプションを保存します。 (継承元 Package)
IVsPersistSolutionOpts.WriteUserOptions(IStream, String)	特定のソリューションのユーザー オプションを書き込みます。 (継承元 Package)
IVsToolboxItemProvider.GetItemContent(String, UInt16, IntPtr)	項目を取得します。 (継承元 Package)
IVsToolboxItemProvider2.GetItemContentAsync(String, UInt16)	非同期サービスを処理できる VSPackage を表します。 (継承元 Package)
IVsToolWindowFactory.CreateToolWindow(Guid, UInt32)	指定した ID を使用して、指定した型のツール ウィンドウを作成します。 (継承元 Package)
IVsUserSettings.ExportSettings(String, IVsSettingsWriter)	このメソッドは、プロファイルの IVsUserSettings 管理と XML ファイルへの設定のインポート/エクスポートに使用されるインターフェイスを実装します。 (継承元 Package)
IVsUserSettings.ImportSettings(String, IVsSettingsReader, UInt32, Int32)	ユーザーが IDE の [ツール] メニューの [設定のインポート/エクスポート] 機能のインポート オプションを選択したときに、Visual Studio 設定メカニズムを使用して VSPackage の構成を取得します。 このメソッドは、プロファイルの管理と XML ファイルへの設定の IVsUserSettings インポート/エクスポートに使用されるインターフェイスの実装の一部です。 (継承元 Package)
IVsUserSettingsMigration.MigrateSettings(IVsSettingsReader, IVsSettingsWriter, String)	以前のバージョンから設定を移行します。 (継承元 Package)
IVsUserSettingsQuery.NeedExport(String, Int32)	設定が変更されたかどうかを判断し、再エクスポートする必要があります。 (継承元 Package)

拡張メソッド

ProfferService<TService>(IAsyncServiceContainer, Func<CancellationToken,Task<Object>>)	指定した型によって実装されたサービスを非同期サービス コンテナーにプロファーします。 サービスのクエリが初めて行われると、関数が creator 呼び出されます。 プロファード サービスは、親の非同期サービス コンテナーに昇格されます。
ProfferService<TService>(IAsyncServiceContainer, Func<CancellationToken,Task<Object>>, Boolean)	指定した型によって実装されたサービスを非同期サービス コンテナーにプロファーします。 サービスのクエリが初めて行われると、関数が creator 呼び出されます。
ProfferService<TService>(IAsyncServiceContainer, Func<Task<Object>>)	指定した型によって実装されたサービスを非同期サービス コンテナーにプロファーします。 サービスのクエリが初めて行われると、関数が creator 呼び出されます。 プロファード サービスは、親の非同期サービス コンテナーに昇格されます。
ProfferService<TService>(IAsyncServiceContainer, Func<Task<Object>>, Boolean)	指定した型によって実装されたサービスを非同期サービス コンテナーにプロファーします。 サービスのクエリが初めて行われると、関数が creator 呼び出されます。
QueryService(IServiceProvider, Guid)	サービス GUID に基づいて、サービス プロバイダーによって公開されるサービスを取得します。
QueryService<TService>(IServiceProvider)	サービス プロバイダーによって公開されるサービスを、そのサービスの種類に基づいて取得します。
GetServiceAsync<TService,TInterface>(IAsyncServiceProvider)	サービス プロバイダーから非同期的にサービス インターフェイスを取得します。
GetServiceAsync<TService,TInterface>(IAsyncServiceProvider, Boolean)	サービス プロバイダーから非同期的にサービス インターフェイスを取得します。