Přidružení dat vlastní rozšíření nástroje služby SharePoint

Článek
08/11/2011

Některé objekty v rozšíření nástroje služby SharePoint můžete přidat vlastní data. To je užitečné, pokud máte data v jedné části vašeho rozšíření, které chcete získat přístup z vašeho rozšíření jiný kód později. Místo provádění vlastní způsob ukládání a přístup k datům můžete přidružit data objektu ve vaší rozšíření a načíst ze stejného objektu data později.

Přidání vlastních dat do objektů je také užitečný, když chcete zachovat data vztahující se k určité položce v aplikaci Visual Studio. Rozšíření nástroje služby SharePoint jsou načtena pouze jednou v aplikaci Visual Studio tak vaše rozšíření může pracovat několik různých položek (projektu položky, jako jsou projekty, nebo Server Explorer uzlů) v čase jakékoli. Pokud máte vlastní data, která jsou relevantní pouze pro určité zboží, můžete přidat data k objektu, který reprezentuje danou položku.

Při přidání vlastních dat do objektů v rozšíření nástroje SharePoint data nejsou zachovány. Data jsou k dispozici pouze během životnost objektu. Po objektu je převzaty systémem pro úklid, data budou ztracena.

Rozšíření projektu systému SharePoint můžete také uložit řetězec data, která přetrvává i po rozšíření je uvolněn. Další informace naleznete v tématu Uložení dat v rozšíření systému SharePoint projektu.

Objekty, které mohou obsahovat vlastní Data

Můžete přidat vlastní data na libovolný objekt v objektovém modelu SharePoint nástroje implementuje IAnnotatedObject rozhraní. Toto rozhraní definuje pouze jednu vlastnost Annotations, což je sada objektů vlastní data. Implementovat následující typy IAnnotatedObject:

Přidání a načítání dat vlastní

Chcete vlastní data do objektu v rozšíření nástroje SharePoint získáte Annotations Vlastnosti objektu, který chcete přidat data a potom pomocí IAnnotationDictionary.Add() způsob přidání dat do objektu.

Chcete-li načíst vlastní data z objektu v rozšíření nástroje služby SharePoint, získat Annotations Vlastnosti objektu a pak použijte jednu z následujících metod:

IAnnotationDictionary.TryGetValue(). Tato metoda vrátí true Pokud existuje objekt dat nebo false Pokud neexistuje. Tato metoda slouží k načtení instance typy hodnotu nebo odkaz.
IAnnotationDictionary.GetValue(). Tato metoda vrátí data objektu Pokud ukončí, nebo null Pokud neexistuje. Tato metoda slouží pouze k načtení instance typu odkaz.

Následující příklad kódu určuje, zda datový objekt je již spojen s položku projektu. Pokud datový objekt již není k položce projektu, je kód přidá objekt Annotations Vlastnosti položky projektu. Větší příklad tohoto kódu v kontextu naleznete v tématu Postupy: Přidání vlastnosti do vlastního typu položky projektu 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);
}

Viz také

Úkoly

Podrobné pokyny: Vytvoření položky projektu vlastní akce položku šablony, část 1

Podrobné pokyny: Rozšíření Průzkumníka serveru pro zobrazení webových částí

Další zdroje

Programovací pojmy a funkce nástroje rozšíření serveru SharePoint

Postupy: Přidat vlastnost SharePoint projekty

Postupy: Přidání vlastnosti do vlastního typu položky projektu SharePoint

Sdílet prostřednictvím