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.Příkaz SharePoint definujete v sestavení, které můžete 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 služby SharePoint

1. Vytvoření projektu knihovny třídy, který má následující konfiguraci:

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

   • Cíle AnyCPU nebo x 64 platformu.Ve výchozím nastavení je AnyCPU cílová platforma pro projektech knihoven tříd.Další informace o výběru cílová platforma, viz How to: Optimize an Application for a Specific CPU Type.

   [!POZNÁMKA]

   Příkaz služby SharePoint nemůže implementovat ve stejném projektu definuje příponou nástroje služby SharePoint, protože SharePoint příkazy cíl.NET Framework 3.5 a SharePoint cíl rozšíření nástroje .NET Framework 4.Je nutné definovat všechny příkazy SharePoint, které se používají 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. Třídy v projektu vytvořte metodu, která definuje příkaz služby SharePoint.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 použít k vytvoření 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 k příkazu SharePoint, potřebujete-li 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 pomocí Windows komunikace Foundation (WCF).Další informace naleznete v tématu Typy podporované serializátorem kontraktu dat a Používání třídy XmlSerializer.

   • Metoda může mít jakýkoli viditelnosti (public, internal, nebo private), a může být statická nebo nestatický.

4. Použije SharePointCommandAttribute metodou.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 vašeho rozšíření nástroje služby 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ý má identifikátor Contoso.Commands.UpgradeSolution.Tento příkaz používá rozhraní API v modelu objektu server upgrade na 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 souboru WSP, který je upgradován na web služby SharePoint.Větší příklad tohoto kódu v kontextu naleznete v tématu Návod: Vytvoření vlastního kroku nasazení pro projekty SharePoint.

Probíhá kompilace kódu

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

• Microsoft.VisualStudio.SharePoint.Commands

• Microsoft.SharePoint

Nasazení, příkaz

Příkaz při nasazení zahrnují sestavení příkazu ve stejném 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

Postupy: Provedení příkazu SharePoint

Návod: Rozšíření průzkumníka serveru pro zobrazení částí webu

Koncepty

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