Postupy: Provedení 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.Po definování příkazu a jeho nasazení s rozšířením nástrojů SharePoint, mohou vaše rozšíření provést příkaz k volání do modelu serverového objektu SharePoint.Chcete-li provést příkaz, použijte jednu z metod ExecuteCommand objektu ISharePointConnection.

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

Chcete-li provést příkaz SharePoint

1. Ve vašem rozšíření nástrojů služby SharePoint získejte objekt ISharePointConnection.Způsob, jakým získáte objekt ISharePointConnection závisí na typu rozšíření, které vytváříte:

   • Rozšíření projektu systému SharePoint použít ISharePointProject.SharePointConnection vlastnost.

     Další informace o rozšíření systému projektu naleznete v tématu Rozšíření systému projektu služby SharePoint.

   • V rozšíření SharePoint připojení uzlu v Server Explorer, použít IExplorerNodeContext.SharePointConnection vlastnost.Získat IExplorerNodeContext objekt, použijte IExplorerNode.Context vlastnost.

     Další informace o rozšířeních Průzkumníku serveru naleznete v částiRozšíření uzlu připojení služby SharePoint v průzkumníku serveru.

   • V kódu, který není součástí rozšíření nástrojů služby SharePoint, jako například Průvodce šablonou projektu, použijte ISharePointProjectService.SharePointConnection vlastnost.

     Další informace o načítání služeb projektu naleznete v tématu Použití služby projektu služby SharePoint.

2. Volejte jednu z metod ExecuteCommand objektu ISharePointConnection.Předejte název příkazu, který chcete provést na prvním argumentu metody ExecuteCommand.Pokud má váš příkaz vlastní parametr, předejte parametr druhému argumentu metody ExecuteCommand.

   Existuje rozdílné ExecuteCommand přetížení pro každou podporovanou signaturu příkazu.V následující tabulce jsou uvedeny podporované signatury a které přetížení použít pro kterou signaturu.

   Signatura příkazu	ExecuteCommand přetížení pro použití
   Příkaz má pouze výchozí parametr ISharePointCommandContext a žádné návratové hodnoty.	ExecuteCommand(String)
   Příkaz má pouze výchozí parametr ISharePointCommandContext a návratovou hodnotu.	ExecuteCommand``1(String)
   Příkaz obsahuje dva parametry (výchozí parametr ISharePointCommandContext a vlastní parametr) a nemá návratovou hodnotu.	ExecuteCommand``1(String, UMP)
   Příkaz má dva parametry a návratovou hodnotu.	ExecuteCommand``2(String, UMP)

Příklad

Následující příklad kódu demonstruje jak použít přetížení ExecuteCommand``1(String, UMP) pro volání příkazu Contoso.Commands.UpgradeSolution, který je popsán v Postupy: Vytvoření příkazu SharePoint.

Private Sub Execute(ByVal context As IDeploymentContext) _
    Implements IDeploymentStep.Execute
    context.Logger.WriteLine("Upgrading solution: " & solutionName, LogCategory.Status)
    context.Project.SharePointConnection.ExecuteCommand("Contoso.Commands.UpgradeSolution", _
        solutionFullPath)
End Sub

public void Execute(IDeploymentContext context)
{
    context.Logger.WriteLine("Upgrading solution: " + solutionName, LogCategory.Status);
    context.Project.SharePointConnection.ExecuteCommand("Contoso.Commands.UpgradeSolution",
        solutionFullPath);
}

Metoda Execute uvedená v následujícím příkladu je implementací metody Execute rozhraní IDeploymentStep v kroku vlastního nasazení.Větší příklad tohoto kódu v kontextu naleznete v tématu Návod: Vytvoření vlastního kroku nasazení pro projekty SharePoint.

Uvědomte si následující podrobnosti o volání metody ExecuteCommand``1(String, UMP):

• První parametr identifikuje příkaz, který chcete volat.Tomuto řetězci odpovídá hodnota předávaná SharePointCommandAttribute v definici příkazu.

• Druhý parametr je hodnota, kterou chcete předat vlastnímu druhému parametru příkazu.V tomto případě je to úplná cesta souboru .wsp, který je aktualizován na web služby SharePoint.

• Kód nepředá implicitní parametr příkazu ISharePointCommandContext.Tento parametr je předán do příkazu automaticky při volání příkazu z rozšíření systému projektu služby SharePoint nebo rozšíření uzlu Připojení služby SharePoint v Průzkumníku serveru.V jiných typech řešení, jako například průvodci šablonou projektu, implementuje rozhraní IWizard, tento parametr je null.

Probíhá kompilace kódu

Tento příklad vyžaduje odkaz na sestavení Microsoft.VisualStudio.SharePoint.

Viz také

Úkoly

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

Koncepty

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

Postupy: Vytvoření příkazu SharePoint