Postupy: Vytvoření příkazu SharePoint

Pokud chcete používat model serverového objektu v nástrojích rozšíření SharePoint, musíte vytvořit vlastní Příkaz služby SharePoint pro volání rozhraní API. Definování příkazu SharePoint v sestavení, které lze volat přímo do modelu objektu serveru.

Další informace o účelu SharePoint příkazy, viz Volání do objektových modelů služby SharePoint.

Vytvořit příkaz SharePoint

1. Vytvoření projektu knihovny třídy obsahující následující konfiguraci:

   • Cíle..NET Framework 3.5. Další informace o výběru cílového rámce, viz Postupy: Zaměření na specifickou verzi rozhraní .NET Framework nebo profil.

   • Cíle AnyCPU nebo x 64 platformu. Cílová platforma pro projektech knihoven tříd je AnyCPU. Další informace o výběru cílová platforma, viz Postupy: Optimalizovat aplikaci pro konkrétní typ procesoru.

   Poznámka

   Příkaz SharePoint nemůže implementovat ve stejném projektu definující příponou nástroje SharePoint, protože cíl příkazy SharePoint.NET Framework 3.5 a SharePoint cíl rozšíření nástroje .NET Framework 4. Je nutné definovat všechny SharePoint příkazy používané rozšířením do samostatného projektu. Další informace naleznete v tématu Nasazování rozšíření pro nástroje služby SharePoint v aplikaci Visual Studio.

2. Přidejte odkazy do následujících sestavení:

   • Microsoft.VisualStudio.SharePoint.Commands

   • Microsoft.SharePoint

3. Vytvořte metodu, která definuje SharePoint příkaz třídy v projektu. Metoda musí splňovat následující pokyny:

   • Může mít jeden nebo dva parametry.

     První parametr musí být ISharePointCommandContext objektu. Tento objekt poskytuje Microsoft.SharePoint.SPSite nebo Microsoft.SharePoint.SPWeb ve kterém je příkaz spuštěn. Poskytuje také ISharePointCommandLogger objekt, který lze zapisovat zprávy Výstup okna nebo Seznam chyb okna v aplikaci Visual Studio.

     Druhý parametr může být typ výběru, ale tento parametr je volitelný. Tento parametr můžete přidat SharePoint příkazu potřebujete předat data z aplikace SharePoint nástroje rozšíření příkazu.

   • Vrácená hodnota může mít ale nepovinné.

   • Druhý parametr a návrat hodnota musí být typu, který lze serializovat ve Windows Communication Foundation (WCF). Další informace naleznete v tématu Types Supported by the Data Contract Serializer a Using the XmlSerializer Class.

   • Metoda může mít výhled (public, internal, nebo private), a mohou být statické nebo jiných-statický.

4. Použije SharePointCommandAttribute Metoda. Tento atribut Určuje jedinečný identifikátor příkazu; Tento identifikátor nemá odpovídající název metody.

   Při volání příkazu z rozšíření nástroje aplikace SharePoint, musíte zadat stejné jedinečný identifikátor. Další informace naleznete v tématu Postupy: Provedení příkazu SharePoint.

Příklad

Následující příklad kódu ukazuje SharePoint příkaz, který nemá identifikátor Contoso.Commands.UpgradeSolution. Tento příkaz používá rozhraní API v objektovém modelu server upgrade nasazeného řešení.

<SharePointCommand("Contoso.Commands.UpgradeSolution")> _
Private Sub UpgradeSolution(ByVal context As ISharePointCommandContext, ByVal fullWspPath As String)
    Dim solution As SPSolution = SPFarm.Local.Solutions(Path.GetFileName(fullWspPath))
    If solution Is Nothing Then
        Throw New InvalidOperationException("The solution has not been deployed.")
    End If
    solution.Upgrade(fullWspPath)
End Sub

[SharePointCommand("Contoso.Commands.UpgradeSolution")]
private void UpgradeSolution(ISharePointCommandContext context, string fullWspPath)
{
    SPSolution solution = SPFarm.Local.Solutions[Path.GetFileName(fullWspPath)];

    if (solution == null)
    {
        throw new InvalidOperationException("The solution has not been deployed.");
    }

    solution.Upgrade(fullWspPath);
}

Vedle implicitní první ISharePointCommandContext parametr, tento příkaz má také parametr vlastní řetězec, který obsahuje úplnou cestu k souboru WSP je upgradován na webu SharePoint. Větší příklad tohoto kódu v kontextu naleznete v tématu Podrobné pokyny: Vytvoření vlastního kroku nasazení pro SharePoint projekty.

Probíhá kompilace kódu

Tento příklad vyžaduje odkazy na následující sestavení:

• Microsoft.VisualStudio.SharePoint.Commands

• Microsoft.SharePoint

Příkaz pro zavedení

Nasazení příkaz zahrnout do stejné sestavení příkazu Visual Studio balíček rozšíření (VSIX) s příponou sestavení, která používá příkaz. Musíte také přidat položku pro sestavení příkazu v souboru extension.vsixmanifest. Další informace naleznete v tématu Nasazování rozšíření pro nástroje služby SharePoint v aplikaci Visual Studio.

Viz také

Úkoly

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

Koncepty

Volání do objektových modelů služby SharePoint

Další zdroje

Postupy: Provedení příkazu SharePoint