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

Článek
03/04/2013

Přidáte-li vlastní data určité objekty v rozšíření nástroje služby SharePoint.To je užitečné, pokud máte data v jedné části vašeho rozšíření, které chcete později získat přístup z jiného kódu ve vašem rozšíření.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 poté načíst data ze stejného objektu později.

Přidání vlastních dat do objektů je také užitečné, pokud chcete zachovat data, vztahující se k určité položce v aplikaci Visual Studio.Rozšíření nástroje služby SharePoint jsou načteny pouze jednou, v aplikaci Visual Studio tak vaše rozšíření může pracovat několik různých položek (například projektů, projektů položek, nebo Server Explorer uzly) kdykoli.Pokud máte vlastní data, která jsou relevantní pouze pro určitou položku, 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, který 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-li přidat vlastní data objektu v rozšíření nástroje aplikace SharePoint, získat Annotations vlastnosti objektu, který chcete přidat data a potom použít IAnnotationDictionary.Add() způsob přidání dat do objektu.

Chcete-li načíst vlastní data z objektu v rozšíření nástroje aplikace 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 datový objekt existuje, nebo false Pokud neexistuje.Tuto metodu můžete použít k načtení instance typů hodnotu nebo odkaz.
IAnnotationDictionary.GetValue().Tato metoda vrátí data objektu, pokud jej ukončí, nebo null Pokud neexistuje.Tuto metodu můžete použít 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 vlastností položky projektu.Větší příklad tohoto kódu v kontextu naleznete v tématu Jak: Přidat typ položky služby SharePoint projektu vlastní vlastnost.

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

Názorný postup: Vytváření projektu vlastní akci pomocí položky šablony, část 1

Názorný postup: Rozšíření serveru Explorer k zobrazení webové části

Koncepty

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

Jak: Přidat vlastnost SharePoint projekty

Jak: Přidat typ položky služby SharePoint projektu vlastní vlastnost

Sdílet prostřednictvím