Jak: wykonanie polecenia programu SharePoint

Artykuł
02/27/2013

Jeśli chcesz użyć modelu obiektu serwera w rozszerzeniach narzędzia programu SharePoint, należy utworzyć niestandardowy polecenia programu SharePoint do wywołania z interfejsu API.Po zdefiniowaniu polecenia i wdrożyć go rozszerzeniem narzędzia programu SharePoint, Twój numer wewnętrzny może wydaj polecenie, aby zadzwonić do modelu obiektu programu SharePoint server.Aby wykonać polecenie, należy użyć jednej z ExecuteCommand metody ISharePointConnection obiektu.

Aby uzyskać więcej informacji o przeznaczeniu poleceń programu SharePoint, zobacz Wywołanie do modeli obiektów programu SharePoint.

Do wykonania polecenia programu SharePoint

Twój numer wewnętrzny narzędzia programu SharePoint na uzyskanie ISharePointConnection obiektu.Sposób uzyskiwania ISharePointConnection zależy od typu rozszerzenie podczas tworzenia obiektu:
- Rozszerzenia systemu projektu programu SharePoint, należy użyć ISharePointProject.SharePointConnection właściwości.
  
  Aby uzyskać więcej informacji na temat projektu systemu rozszerzeń, zobacz Rozszerzenia systemu projektu programu SharePoint.
- Do rozszerzenia Połączeń SharePoint węzeł w Server Explorer, użyj IExplorerNodeContext.SharePointConnection właściwości.Aby uzyskać IExplorerNodeContext obiektów, użyj IExplorerNode.Context właściwości.
  
  Aby uzyskać więcej informacji o Server Explorer rozszerzeń, zobacz Rozszerzanie węzła połączenia programu SharePoint w programie Server Explorer.
- W kodzie, który nie jest częścią rozszerzeniem narzędzia programu SharePoint, takich jak Kreator szablonów projektu, należy użyć ISharePointProjectService.SharePointConnection właściwości.
  
  Aby uzyskać więcej informacji na temat pobierania usługi projektu, zobacz Za pomocą usługi SharePoint projektu.

Wywołania jednej z ExecuteCommand metody ISharePointConnection obiektu.Przekazana nazwa polecenia, które chcesz wykonać do pierwszego argumentu ExecuteCommand metody.Jeśli polecenie ma parametr niestandardowe, należy przekazać tego parametru do drugiego argumentu ExecuteCommand metody.

Jest innym ExecuteCommand dla każdego podpisu obsługiwanych poleceń na przeciążenie.Poniższa tabela zawiera listę obsługiwanych podpisów i które przeciążenie, aby użyć dla każdego podpisu.

Polecenie Podpis	Przeciążenie ExecuteCommand, aby użyć
Polecenie ma tylko domyślne ISharePointCommandContext parametru i nie zwraca wartości.	ExecuteCommand(String)
Polecenie ma tylko domyślne ISharePointCommandContext parametru i wartości zwracanej.	ExecuteCommand<TResult>(String)
Polecenie ma dwa parametry (domyślnie ISharePointCommandContext parametr oraz parametr niestandardowych) i nie zwraca wartości.	ExecuteCommand<T>(String, T)
Polecenie ma dwa parametry i wartości zwracanej.	ExecuteCommand<T, TResult>(String, T)

Przykład

Poniższy przykład kodu pokazuje sposób użycia ExecuteCommand<T>(String, T) przeciążenie wywołać Contoso.Commands.UpgradeSolution polecenia, który jest opisany w Jak: Tworzenie polecenia programu 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);
}

Execute Metod przedstawionych w tym przykładzie jest implementacją Execute metoda IDeploymentStep interfejsu w kroku wdrażania niestandardowego.Aby wyświetlić ten kod w kontekście przykład większych, zobacz Instruktaż: Tworzenie kroku wdrożenia niestandardowe dla projektów programu SharePoint.

Uwaga następujące szczegółowe informacje o wywołaniu ExecuteCommand<T>(String, T) metody:

Pierwszy parametr określa polecenie, które chcesz zadzwonić.Ten ciąg odpowiada wartości, który jest przekazywany do SharePointCommandAttribute na definicję polecenia.
Drugi parametr jest wartością, którą chcesz przekazać do niestandardowych, drugi parametr polecenia.W tym przypadku jest pełną ścieżkę pliku .wsp, który jest uaktualniany do witryny programu SharePoint.
Kod nie przechodzi niejawny ISharePointCommandContext do polecenia.Ten parametr jest przekazywana do polecenia automatycznie, gdy wywołanie polecenia z rozszerzeniem systemu projektu programu SharePoint lub rozszerzenie Połączeń SharePoint węzeł w Server Explorer.W innych typach rozwiązań, takich jak w Kreatora szablonów projektu, który implementuje Microsoft.VisualStudio.TemplateWizard.IWizard interfejsu, ten parametr jest null.