ProvideToolboxItemsAttribute クラス

リファレンス

定義

名前空間:: Microsoft.VisualStudio.Shell

アセンブリ:: Microsoft.VisualStudio.Shell.14.0.dll

アセンブリ:: Microsoft.VisualStudio.Shell.15.0.dll

パッケージ:: Microsoft.VisualStudio.Shell.15.0 v17.9.37000

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

VSPackage を実装するクラスにこの属性を適用して、一連の項目を Visual Studio ツールボックスに提供するかどうかを宣言します。

public ref class ProvideToolboxItemsAttribute : Microsoft::VisualStudio::Shell::RegistrationAttribute

[System.AttributeUsage(System.AttributeTargets.Class, Inherited=true)]
public class ProvideToolboxItemsAttribute : Microsoft.VisualStudio.Shell.RegistrationAttribute

[<System.AttributeUsage(System.AttributeTargets.Class, Inherited=true)>]
type ProvideToolboxItemsAttribute = class
    inherit RegistrationAttribute

Public Class ProvideToolboxItemsAttribute
Inherits RegistrationAttribute

継承: Attribute

RegistrationAttribute
ProvideToolboxItemsAttribute

属性: AttributeUsageAttribute

例

次の例では、クラス MyPackage に適用される属性は、のバージョン 1 の ツールボックス 項目をサポートし、2 つのクリップボード形式 "CF_XMLCODE" と "InPlaceMenuEditorMenu" をサポートしていることを示しています。

[DefaultRegistryRoot("Software\\Microsoft\\VisualStudio\\8.0")]  
[ProvideToolboxItems(true, 1)]  
[ProvideToolboxFormat("CF_XMLCODE")]  
[ProvideToolboxFormat("InPlaceMenuEditorMenu")]  
[Guid("XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX")]  
internal sealed class MyPackage : Package

注釈

属性コンテキスト


適用対象	を実装IVsPackage Packageして VSPackage を提供するクラス。
反復可能	いいえ
必須属性	ProvideToolboxFormatAttribute
無効な属性	なし

ユーザーがこの形式のデータオブジェクトを Packageツールボックスにドラッグできるようにするために必要な、派生クラスまたはを実装 IVsPackage するクラスにこの属性を適用 します。この実装クラスは、ドロップ通知自体を処理する必要があります。

この属性は登録目的でのみ使用され、実行時のコードの動作には影響しません。

コンストラクターで指定された引数に応じて、この属性は VSPackage が ツールボックス 項目を提供しないことを示すことができます。属性 ProvideToolboxFormatAttribute が ツールボックス 項目を提供することを示すためにクラスに追加される場合は、の 1 つ以上の ProvideToolboxFormatAttribute インスタンスも追加する必要があります。

この属性は、を使用 ProvideToolboxFormatAttribute して、指定された形式の ツールボックス 項目を提供するように VSPackage を登録します。

この属性でツールボックス項目が指定されている場合、VSPackage はイベントと ToolboxUpgraded イベントをToolboxInitialized処理する必要があります。

この属性を使用する VSPackage では、イベントと ToolboxUpgraded イベントのハンドラーをToolboxInitialized提供する必要があります。

コンストラクター

ProvideToolboxItemsAttribute(Int32)	VSPackage を実装するクラスがツールボックス項目を提供しているかどうかを示すの新しいインスタンス ProvideToolboxItemsAttribute を作成します。
ProvideToolboxItemsAttribute(Int32, Boolean)	指定したバージョンのの ProvideToolboxItemsAttribute 新しいインスタンスを初期化します。

プロパティ

NeedsCallBackAfterReset	これを true に設定すると、ツールボックスがリセットされるたびに、ToolboxInitialized イベントが強制されます。これは、パッケージを開発するときに使用して、ツールボックスが毎回パッケージに項目の一覧を要求するように強制できます (変更された場合)。出荷された製品の場合は、パフォーマンスを向上させるためにキャッシュを使用できるように false のままにすることをお勧めします。一部のシナリオ (キャッシュに保持できない項目リストなど) では、このフラグを true に設定する必要がある場合があります
TypeId	RegistrationAttribute 派生クラスが System.ComponentModel.TypeDescriptor.GetAttributes(...) と連携できるように、TypeID プロパティをオーバーライドします。このプロパティから派生した属性は、クラスに適用できるインスタンスをより適切に制御する必要がある場合にのみ、このプロパティをオーバーライドする必要があります。 (継承元 RegistrationAttribute)
Version	VSPackage が提供するツールボックス項目のバージョンを返すプロパティ。

メソッド

GetPackageRegKeyPath(Guid)	VSPackage のレジストリパス (アプリケーションのレジストリルートに対する相対パス) を取得します。 (継承元 RegistrationAttribute)
Register(RegistrationAttribute+RegistrationContext)	regpkg.exe などの外部登録ツールによって呼び出されたときに、指定した形式のツールボックス項目プロバイダーとして VSPackage を登録します。詳細については、「VSPackage の登録」を参照してください。
Unregister(RegistrationAttribute+RegistrationContext)	メソッドがレジストリに適用した変更 Register(RegistrationAttribute+RegistrationContext) を元に戻します。

適用対象