IVsDataProvider インターフェイス
DDEX のプロバイダーを提供します。
名前空間: Microsoft.VisualStudio.Data.Core
アセンブリ: Microsoft.VisualStudio.Data.Core (Microsoft.VisualStudio.Data.Core.dll 内)
構文
'宣言
Public Interface IVsDataProvider
public interface IVsDataProvider
public interface class IVsDataProvider
type IVsDataProvider = interface end
public interface IVsDataProvider
IVsDataProvider 型で公開されるメンバーは以下のとおりです。
プロパティ
| 名前 | 説明 | |
|---|---|---|
.gif "パブリック プロパティ") |
Description | DDEX のプロバイダーの記述を取得します。 |
|
DisplayName | DDEX のプロバイダーの表示名を取得します。 |
|
Guid | DDEX のプロバイダーの一意の識別子を取得します。 |
|
Name | DDEX のプロバイダーのプログラム名を取得します。 |
|
ShortDisplayName | DDEX のプロバイダーの短い表示名を取得します。 |
|
Technology | DDEX のプロバイダーによって使用されているおよび対象の基になるテクノロジの一意の識別子を取得します。 |
このページのトップへ
メソッド
| 名前 | 説明 | |
|---|---|---|
.gif "パブリック メソッド") |
CreateObject(Type) | DDEX のプロバイダーによって実装される指定 DDEX サポート エンティティのインスタンスを作成します。 |
|
CreateObject(Guid, Type) | DDEX のプロバイダーによって実装される指定 DDEX のデータ ソースの指定 DDEX サポート エンティティのインスタンスを作成します。 |
|
CreateObject<TObject>() | DDEX のプロバイダーによって実装される指定 DDEX サポート エンティティのインスタンスを作成します。 |
|
CreateObject<TObject>(Guid) | DDEX のプロバイダーによって実装される指定 DDEX のデータ ソースの指定 DDEX サポート エンティティのインスタンスを作成します。 |
|
CreateObject<TSite>(Guid, Type, TSite) | 指定されたサイト オブジェクトに配置される DDEX のプロバイダーによって実装される指定 DDEX のデータ ソースの指定 DDEX サポート エンティティのインスタンスを作成します。 |
|
CreateObject<TObject, TSite>(Guid, TSite) | 指定されたサイト オブジェクトに配置される DDEX のプロバイダーによって実装される指定 DDEX のデータ ソースの指定 DDEX サポート エンティティのインスタンスを作成します。 |
|
DeriveSource | DDEX のプロバイダーでサポートされる対象データ ソースに関する情報を含む DDEX のデータ ソースを派生します。 |
|
GetAssembly(String) | Assembly の対応する表現にプロバイダー固有のアセンブリ文字列を解決します。 |
|
GetAssembly(Guid, String) | DDEX 固有のデータ ソースに Assembly の対応する表現にプロバイダー固有のアセンブリ文字列を解決します。 |
|
GetMainAssembly | プロバイダーのメイン アセンブリを取得します。 |
|
GetProperty | DDEX のプロバイダーの登録済みプロパティを取得します。 |
|
GetString | DDEX のプロバイダーからローカライズされた文字列を取得します。 |
|
GetType(String) | Type の対応する表現にプロバイダーに固有の型名を解決します。 |
|
GetType(Guid, String) | DDEX 固有のデータ ソースに Type の対応する表現にプロバイダーに固有の型名を解決します。 |
|
GetUnsupportedReason(CommandID, Object) | 操作がサポートされない理由を説明するローカライズされた文字列を取得します。 |
|
GetUnsupportedReason(Guid, CommandID, Object) | 操作が指定 DDEX のデータ ソースでサポートされない理由を説明するローカライズされた文字列を取得します。 |
|
IsOperationSupported(CommandID, Object) | 特定のアクションが現在の環境のプロバイダーによってサポートされているかどうかを判定します。 |
|
IsOperationSupported(Guid, CommandID, Object) | 特定のアクションが現在の環境のプロバイダーでサポートされる指定 DDEX のデータ ソースでかどうかを判断します。 |
|
SupportsObject(Type) | DDEX のプロバイダーがサポート DDEX エンティティを指定された型をサポートするかどうかを判定します。 |
|
SupportsObject(Guid, Type) | DDEX のプロバイダーを指定 DDEX のデータ ソースに DDEX サポート エンティティを指定された型をサポートするかどうかを判定します。 |
|
TryCreateObject(Type) | DDEX のプロバイダーによって実装される指定 DDEX サポート エンティティのインスタンスを作成しようとします。 |
|
TryCreateObject(Guid, Type) | DDEX のプロバイダーによって実装される指定 DDEX のデータ ソースの指定 DDEX サポート エンティティのインスタンスを作成しようとします。 |
|
TryCreateObject<TObject>() | DDEX のプロバイダーによって実装される指定 DDEX サポート エンティティのインスタンスを作成しようとします。 |
|
TryCreateObject<TObject>(Guid) | DDEX のプロバイダーによって実装される指定 DDEX のデータ ソースの指定 DDEX サポート エンティティのインスタンスを作成しようとします。 |
|
TryCreateObject<TSite>(Guid, Type, TSite) | 指定されたサイト オブジェクトに配置される DDEX のプロバイダーによって実装される指定 DDEX のデータ ソースの指定 DDEX サポート エンティティのインスタンスを作成しようとします。 |
|
TryCreateObject<TObject, TSite>(Guid, TSite) | 指定されたサイト オブジェクトに配置される DDEX のプロバイダーによって実装される指定 DDEX のデータ ソースの指定 DDEX サポート エンティティのインスタンスを作成しようとします。 |
このページのトップへ
解説
DDEX プロバイダー オブジェクトは Visual Studio 環境に登録されているプロバイダーに関する情報を提供します。 これは DDEX のプロバイダーと対話する DDEX クライアントのエントリ ポイントです。 各プロバイダーにさまざまな名前と説明、他と区別する一意の GUID があります。 このインターフェイスは、プロバイダー固有であるリソース id の文字列を入力した場合、ローカライズされた文字列を取得するメソッドに加えてカスタム プロバイダーの特性を定義する一連のプロパティを指定します。 また、対象データ ソースに関する情報を含んでいる接続文字列が指定されている場合 DDEX のデータ ソースを判断するためのメソッドを提供します。 これは、プロバイダーが実装する DDEX サポート エンティティを識別し、作成するためのメソッドを提供します。 最後に、プロバイダーが所有するアセンブリと、またはマネージ型の解決のメソッドを提供します。
DDEX プロバイダー オブジェクトは IVsDataProviderManager サービスを使用して取得することもできます。
例
次のコードは、クライアントがどのように DDEX 固有のプロバイダーを取得し、表示名と説明を出力できると、標準 DDEX サポート エンティティまたはの 1 種類を作成します。
using System;
using System.Diagnostics;
using Microsoft.VisualStudio.Data.Core;
using Microsoft.VisualStudio.Data.Services.SupportEntities;
public class DDEX_IVsDataProviderExample1
{
public static void UseDataProvider(
IServiceProvider serviceProvider,
Guid providerGuid)
{
IVsDataProviderManager providerManager =
serviceProvider.GetService(typeof(IVsDataProviderManager))
as IVsDataProviderManager;
IVsDataProvider provider = providerManager.Providers[providerGuid];
Trace.WriteLine(provider.DisplayName);
Trace.WriteLine(provider.Description);
IVsDataConnectionProperties connectionProperties =
provider.CreateObject<IVsDataConnectionProperties>();
connectionProperties.Parse("Test connection string");
}
}