AsyncPackage クラス

定義

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

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
継承
AsyncPackage
派生
属性
実装

コンストラクター

AsyncPackage()

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

プロパティ

ApplicationRegistryRoot

現在の Visual Studio レジストリハイブのルートレジストリキーを取得します。

(継承元 Package)
DisposalToken

CancellationTokenパッケージが破棄されたかどうかを確認するために使用できるを公開します。 これは、Visual Studio がシャットダウンを開始したときにバックグラウンドスレッドで実行されている非同期タスクで発生する可能性があります。 ShutdownTokenVS がシャットダウンしていることを前に示した場合は、を使用します。

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 を使用して、指定した種類のツールウィンドウを作成します。

(継承元 Package)
CreateToolWindow(Type, Int32, UInt32)

指定した ID を使用して、指定した型のツールウィンドウを作成します。

(継承元 Package)
CreateToolWindow(Type, Int32, UInt32, Object, Guid)

指定した ID を使用して、指定した種類のツールウィンドウを作成します。 これは、IVsUiShell Windows.createtoolwindow () を呼び出す必要がある唯一のメソッドです。

(継承元 Package)
Dispose(Boolean)

オブジェクトおよび関連付けられているキャンセルトークンを破棄します。

FindToolWindow(Type, Int32, Boolean)

指定した型と ID に対応するツールウィンドウを取得します。

(継承元 Package)
FindToolWindowAsync(Type, Int32, Boolean, CancellationToken)

指定した型と ID に対応するツールウィンドウを非同期に検索します。 存在しない場合は、が true の場合はを作成して返し、 create が false の場合は null を返し create ます。

FindWindowPane(Type, Int32, Boolean)

指定した型と ID に対応するウィンドウペインを取得します。その型のウィンドウペインが存在しない場合は、その種類のウィンドウウィンドウが作成されます。

(継承元 Package)
FindWindowPaneAsync(Type, Int32, Boolean, CancellationToken)

指定された型と ID に対応するウィンドウウィンドウを非同期に検索します。 存在しない場合は、が true の場合はを作成して返し、 create が false の場合は null を返し create ます。

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) (継承元 Package)
GetToolWindowTitle(Type, Int32)

ツールウィンドウに使用するタイトル文字列を返します。 Null が返された場合は、ツールウィンドウの型名がタイトルに使用されます。

Initialize()

このメソッドを封印します。 デッドロックが発生する可能性はほとんどありませんが、非同期パッケージであっても UI スレッドで SetSite (Initialize を呼び出すこと) が引き続き発生します。 ほとんどの非同期パッケージの作成者は、論理的には、b/g スレッドで初期化が行われると想定しているため、オーバーライドの内部では高負荷な (同期的な) 処理を実行し、非同期読み込みの利点の一部を無効にします。 そのようなことを防ぐために、これを封印します。これによりオーバーライドできるのは、b/g スレッドで呼び出される async initialize だけです。

InitializeAsync(CancellationToken, IProgress<ServiceProgressData>)

パッケージ初期化プロセスの非同期初期化部分。 このメソッドは、バックグラウンドスレッドから呼び出されます。

InitializeToolWindowAsync(Type, Int32, CancellationToken)

で識別されるツールウィンドウを作成する準備として、初期化を実行 toolWindowType します。

InstantiateToolWindow(Type) (継承元 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 が false の場合は null を返し create ます。

イベント

ToolboxInitialized

Visual Studio がツールボックスを初期化するたびに生成されるイベントです。

(継承元 Package)
ToolboxUpgraded

Visual Studio がツールボックスをアップグレードするたびに生成されるイベントです。

(継承元 Package)

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

IAsyncLoadablePackageInitialize.Initialize(IAsyncServiceProvider, IProfferAsyncService, IAsyncProgressCallback)

SetSite の非同期バージョン。 b/g スレッドから呼び出されます。

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[])

Proffers、[ツールボックスのカスタマイズ] ダイアログボックスの [ツール] メニューオプションと [プロパティ] ページにアクセスします。

(継承元 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) (継承元 Package)
IVsToolWindowFactory.CreateToolWindow(Guid, UInt32)

指定した ID を使用して、指定した型のツールウィンドウを作成します。

(継承元 Package)
IVsUserSettings.ExportSettings(String, IVsSettingsWriter)

このメソッドは、 IVsUserSettings プロファイルの管理および XML ファイルへの設定のインポート/エクスポートに使用されるインターフェイスを実装します。

(継承元 Package)
IVsUserSettings.ImportSettings(String, IVsSettingsReader, UInt32, Int32)

IDE の [ツール] メニューの [設定のインポートとエクスポート] 機能の [インポート] オプションをユーザーが選択したときに、Visual Studio の設定メカニズムを使用して VSPackage の構成を取得します。 このメソッドは、 IVsUserSettings プロファイルの管理および XML ファイルへの設定のインポート/エクスポートに使用されるインターフェイスの実装の一部です。

(継承元 Package)
IVsUserSettingsMigration.MigrateSettings(IVsSettingsReader, IVsSettingsWriter, String)

以前のバージョンから設定を移行します。

(継承元 Package)
IVsUserSettingsQuery.NeedExport(String, Int32)

設定が変更されたかどうかを判断し、再エクスポートする必要があります。

(継承元 Package)

拡張メソッド

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

指定した型によって実装されたサービスを非同期サービスコンテナーに proffers ます。 サービスが初めて照会されると、 creator 関数が呼び出されます。 Proffered サービスは、親の async service コンテナーに昇格されます。

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

指定した型によって実装されたサービスを非同期サービスコンテナーに proffers ます。 サービスが初めて照会されると、 creator 関数が呼び出されます。

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

指定した型によって実装されたサービスを非同期サービスコンテナーに proffers ます。 サービスが初めて照会されると、 creator 関数が呼び出されます。 Proffered サービスは、親の async service コンテナーに昇格されます。

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

指定した型によって実装されたサービスを非同期サービスコンテナーに proffers ます。 サービスが初めて照会されると、 creator 関数が呼び出されます。

QueryService(IServiceProvider, Guid)

サービスプロバイダーによって公開されるサービスの種類に基づいてサービスを取得します。

QueryService<TService>(IServiceProvider)

サービスプロバイダーによって公開されるサービスの種類に基づいてサービスを取得します。

GetServiceAsync<TService,TInterface>(IAsyncServiceProvider)

サービスプロバイダーからサービスインターフェイスを非同期的に取得します。

GetServiceAsync<TService,TInterface>(IAsyncServiceProvider, Boolean)

サービスプロバイダーからサービスインターフェイスを非同期的に取得します。

適用対象