Como: executar um comando do SharePoint

Artigo
02/25/2013

Se você quiser usar o modelo de objeto do servidor em uma extensão de ferramentas do SharePoint, você deve criar uma personalizada comando SharePoint para chamar a API.Depois de definir o comando e implantá-la com sua extensão de ferramentas do SharePoint, sua extensão pode executar o comando para chamar o modelo de objeto do SharePoint server.Para executar o comando, use um do ExecuteCommand métodos de um ISharePointConnection objeto.

Para obter mais informações sobre a finalidade dos comandos do SharePoint, consulte A chamada para os modelos de objeto do SharePoint.

Para executar um comando do SharePoint

Na sua extensão de ferramentas do SharePoint, obter um ISharePointConnection objeto.A forma, você obterá uma ISharePointConnection objeto depende do tipo de extensão que você está criando:
- Na extensão do sistema do projeto do SharePoint, use o ISharePointProject.SharePointConnection propriedade.
  
  Para obter mais informações sobre extensões de sistema do projeto, consulte Estendendo o sistema de projeto do SharePoint.
- Em uma extensão da SharePoint Connections nó na Server Explorer, use o IExplorerNodeContext.SharePointConnection propriedade.Para obter um IExplorerNodeContext de objeto, use o IExplorerNode.Context propriedade.
  
  Para obter mais informações sobre Server Explorer extensões, consulte Estendendo o nó de conexões do SharePoint no Server Explorer.
- No código que não faz parte de uma extensão das ferramentas do SharePoint, como, por exemplo, um Assistente de modelo de projeto, use o ISharePointProjectService.SharePointConnection propriedade.
  
  Para obter mais informações sobre como recuperar o serviço de projeto, consulte Usando o serviço de projeto do SharePoint.

Chamar um do ExecuteCommand métodos para o ISharePointConnection objeto.Passe o nome do comando que você deseja executar ao primeiro argumento da ExecuteCommand método.Se o comando possui um parâmetro personalizado, passar esse parâmetro para o segundo argumento do ExecuteCommand método.

Há uma outra ExecuteCommand de sobrecarga para cada assinatura de comando com suporte.A tabela a seguir lista as assinaturas com suporte e que pode sobrecarregar a ser usado para cada assinatura.

Assinatura de comando	Sobrecarga de ExecuteCommand para usar
O comando tem apenas o padrão ISharePointCommandContext parâmetro e nenhum valor de retorno.	ExecuteCommand(String)
O comando tem apenas o padrão ISharePointCommandContext parâmetro e um valor de retorno.	ExecuteCommand<TResult>(String)
O comando tem dois parâmetros (o padrão ISharePointCommandContext parâmetro e um parâmetro personalizado) e nenhum valor de retorno.	ExecuteCommand<T>(String, T)
O comando tem dois parâmetros e um valor de retorno.	ExecuteCommand<T, TResult>(String, T)

Exemplo

O exemplo de código a seguir demonstra como usar o ExecuteCommand<T>(String, T) sobrecarga para chamar o Contoso.Commands.UpgradeSolution comando descrita no Como: criar um comando do 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);
}

O Execute método mostrado neste exemplo é uma implementação da Execute método da IDeploymentStep interface em uma etapa de implantação personalizada.Para ver este código no contexto de um exemplo maior, consulte Passo a passo: Criando uma etapa de implantação personalizado para projetos do SharePoint.

Observe os seguintes detalhes sobre a chamada para o ExecuteCommand<T>(String, T) método:

O primeiro parâmetro identifica o comando que você deseja chamar.Essa seqüência de caracteres corresponde ao valor que você passa para o SharePointCommandAttribute na definição de comando.
O segundo parâmetro é o valor que você deseja passar para o segundo parâmetro personalizado do comando.Nesse caso, é o caminho completo do arquivo. wsp que está sendo atualizado para o site do SharePoint.
O código não passa o implícito ISharePointCommandContext parâmetro para o comando.Este parâmetro é passado para o comando automaticamente quando você chamar o comando a partir de uma extensão do sistema de projeto do SharePoint ou uma extensão do SharePoint Connections nó na Server Explorer.Em outros tipos de soluções, como em um Assistente de modelo de projeto que implementa o Microsoft.VisualStudio.TemplateWizard.IWizard interface, esse parâmetro é null.