CodeElement2.ElementID プロパティ

[アーティクル]
08/09/2011

要素を一意に識別する値を取得します。 Visual C# には実装されていません。

名前空間: EnvDTE80
アセンブリ: EnvDTE80 (EnvDTE80.dll 内)

構文

'宣言
ReadOnly Property ElementID As String
    Get

string ElementID { get; }

property String^ ElementID {
    String^ get ();
}

abstract ElementID : string

function get ElementID () : String

プロパティ値

型: System.String
要素の一意な値を表す文字列。

解説

ElementID プロパティは、要素を一意に識別する要素名および他の情報に基づいて計算された値です。 ID の正確な計算は、言語によって異なります。

この ID は、コードモデルクライアントで参照を保持せずに要素を追跡する場合に使用されます。この ID は、コードモデルのイベントに含まれており、変更されている要素をクライアントコードに通知します。新しい ID は、ID の作成時に指定されます。

ElementID プロパティの値は、永続的であるとは限りません。この値は、プロジェクトにコードモデルが作成されるたびに変更される可能性が高く、現在のセッションでも変更されることがあります。 ElementChanged イベントは、ElementID が変更されるたびに発生します。

注意

遅延バインドされた RenameSymbol や ElementID を呼び出すことはできません。 (たとえば、DTE.ActiveDocument.ProjectItem.FileCodeModel.CodeElements.Item("Class1").RenameSymbol("Class2"))。呼び出しを実行する前に、CodeElement2 インターフェイスに対して、明示的にオブジェクトをキャストする必要があります。

EnvDTE80 のコード要素 (これ以降、"Code*2 オブジェクト" と呼びます) は、EnvDTE のコード要素から派生します。たとえば、CodeClass2 は CodeClass から派生し、CodeElement2 は CodeElement から派生します。 Visual Studio の内部では、どちらのアセンブリの場合も、すべてのコード要素が順に CodeElement2 にキャストされます。したがって、論理的には、CodeClass2 であるかのように動作し、最終的には CodeElement2 から派生します。

しかし、2 つの要素は、実際には 2 つの個別の継承階層に存在するため、遅延バインダーは Code*2 オブジェクトで CodeElement2 メソッドを参照できません。 EnvDTE は、基本的に同様に機能しますが、プリプロセッサマクロの使用により、継承されたメソッドが、変換が存在する関連インターフェイスのすべてで明示的に定義されているように、インターフェイスで定義することができます。 EnvDTE80 インターフェイスは、プリプロセッサステートメントを使用せず、同様の継承スキームを使用して定義します。これは、冗長なプロパティが除去されるため、より洗練された解決方法ですが、プロパティを遅延バインディングで呼び出すことができません。この問題を解決するには、呼び出しを実行する前に、CodeElement2 インターフェイスに対して明示的にオブジェクトをキャストします。

また、特定の種類の編集を行うと、クラス、構造体、関数、属性、デリゲートなどのコードモデル要素が非確定的な値になる場合があります。つまり、これらの要素の値は、常に同じ値になるとは限りません。詳細については、「コードモデルを使用したコードの調査 (Visual Basic)」の「変更されるコードモデル要素値」を参照してください。