カスタムデータの SharePoint ツールの拡張機能への関連付け

[アーティクル]
02/21/2013

SharePoint ツールの拡張機能に含まれる特定のオブジェクトにカスタムデータを追加できます。これは、拡張機能の他のコードから後でアクセスするデータが拡張機能の一部にある場合に役立ちます。データを格納したりデータにアクセスしたりする方法をカスタマイズして実装する代わりに、データを拡張機能のオブジェクトに関連付けることで、後で同じオブジェクトからデータを取得できます。

オブジェクトにカスタムデータを追加すると、Visual Studio の特定の項目に関連するデータを保持する場合にも役立ちます。Visual Studio に SharePoint ツールの拡張機能が読み込まれるのは 1 回だけであるため、拡張機能は、いつでも、複数の異なる項目 (プロジェクト、プロジェクト項目、Server Explorer のノードなど) を処理している可能性があります。特定の項目だけに関連するカスタムデータを使用する場合は、その項目を表すオブジェクトにカスタムデータを追加できます。

SharePoint ツールの拡張機能に含まれるオブジェクトにカスタムデータを追加した場合、データは保持されません。データは、オブジェクトの有効期間中にのみ使用できます。ガベージコレクションでオブジェクトがクリアされると、データは失われます。

SharePoint プロジェクトシステムの拡張機能では、拡張機能のアンロード後も保持される文字列データを保存することもできます。詳細については、「SharePoint プロジェクトシステムの拡張機能におけるデータの保存」を参照してください。

カスタムデータを格納できるオブジェクト

IAnnotatedObject インターフェイスを実装する SharePoint ツールのオブジェクトモデルのすべてのオブジェクトにカスタムデータを追加できます。このインターフェイスは、カスタムデータオブジェクトのコレクションである 1 つのプロパティ Annotations だけを定義します。以下の型は IAnnotatedObject を実装します。

カスタムデータの追加および取得

カスタムデータを SharePoint ツールの拡張機能のオブジェクトに追加するには、カスタムデータを追加するオブジェクトの Annotations プロパティを取得してから、IAnnotationDictionary.Add() メソッドを使用してカスタムデータをオブジェクトに追加します。

SharePoint ツール拡張機能でオブジェクトからカスタムデータを取得するには、オブジェクトの Annotations を取得し、次のいずれかのメソッドを使用します。

IAnnotationDictionary.TryGetValue().このメソッドは、データオブジェクトが存在する場合は true を返し、データオブジェクトが存在しない場合は false を返します。このメソッドを使用すると、値の型または参照型のインスタンスを取得できます。
IAnnotationDictionary.GetValue().このメソッドは、データオブジェクトが存在する場合にはデータオブジェクトを返し、データオブジェクトが存在しない場合には null を返します。このメソッドは、参照型のインスタンスを取得する場合のみ使用できます。

特定のデータオブジェクトが既にプロジェクト項目に関連付けられているかどうかを確認する方法を次のコード例に示します。データオブジェクトがプロジェクト項目にまだ関連付けられていない場合は、プロジェクト項目の Annotations プロパティにデータオブジェクトを追加します。この例のコンテキストを確認するには、「方法: プロパティをカスタムの SharePoint プロジェクト項目の種類に追加する」を参照してください。

Private Sub ProjectItemPropertiesRequested(ByVal Sender As Object,
    ByVal e As SharePointProjectItemPropertiesRequestedEventArgs)
    Dim propertyObject As CustomProperties = Nothing

    ' If the properties object already exists, get it from the project item's annotations.
    If False = e.ProjectItem.Annotations.TryGetValue(propertyObject) Then
        ' Otherwise, create a new properties object and add it to the annotations.
        propertyObject = New CustomProperties(e.ProjectItem)
        e.ProjectItem.Annotations.Add(propertyObject)
    End If
    e.PropertySources.Add(propertyObject)
End Sub

void projectItemTypeDefinition_ProjectItemPropertiesRequested(object sender, 
    SharePointProjectItemPropertiesRequestedEventArgs e)
{
    CustomProperties property;

    // If the properties object already exists, get it from the project item's annotations.
    if (!e.ProjectItem.Annotations.TryGetValue(out property))
    {
        // Otherwise, create a new properties object and add it to the annotations.
        property = new CustomProperties(e.ProjectItem);
        e.ProjectItem.Annotations.Add(property);
    }

    e.PropertySources.Add(property);
}