Compartilhar via

Criar Web Parts para o SharePoint

  • Artigo

Usando Web Parts, você pode modificar o conteúdo, a aparência e o comportamento das páginas de um site do SharePoint usando um navegador. Web Parts são controles do lado do servidor executados em uma página de Web Part: são os blocos de construção de páginas que aparecem em um site do SharePoint. Confira Bloco de Construção: Web Parts.

Você pode criar e depurar Web Parts em um site do SharePoint usando modelos do Visual Studio.

Criar uma Web Part no Visual Studio

Criar uma Web Part adicionando um item de Web Part a qualquer projeto do SharePoint. Você pode usar um item de Web Part em uma solução em área restrita ou em uma solução de farm.

Se você quiser criar uma Web Part visualmente usando um designer, crie um projeto de Web Part visual ou adicione um item de Web Part visual a qualquer projeto do SharePoint. Você pode usar apenas um item de Web Part visual em uma solução de farm.

Item da Web Part

O item de Web Part fornece arquivos que podem ser usados para criar uma Web Part para um site do SharePoint. Quando você adiciona um item de Web Part, o Visual Studio cria uma pasta em seu projeto e adiciona vários arquivos à pasta. A tabela a seguir descreve cada arquivo.

Arquivo Descrição
Elements.xml Contém informações que o arquivo de definição de recurso em seu projeto usa para implantar a Web Part.
Arquivo .webpart Fornece informações que o SharePoint precisa para exibir sua Web Part em uma galeria de Web Part.
Arquivo de código Contém métodos que adicionam controles à Web Part e que geram conteúdo personalizado na Web Part.

Para obter mais informações, confira Como criar uma Web Part do SharePoint.

Item da Web Part visual

Uma Web Part visual é uma Web Part criada usando o Designer de Visual Web Developer no Visual Studio. Uma Web Part visual funciona como qualquer outra Web Part. Para adicionar controles, como botões e caixas de texto, a uma Web Part, você adiciona código a um arquivo XML. No entanto, você adiciona controles a uma Web Part visual arrastando-os ou copiando-os para a Web Part da Caixa de Ferramentas do Visual Studio. Em seguida, o designer gera o código necessário no arquivo XML. Confira Como criar um Web Part do SharePoint usando um designer.

Controles do SharePoint

O Visual Studio fornece alguns controles para criar páginas do SharePoint, como páginas de aplicativos. Esses controles aparecem na Caixa de Ferramentas em Controles do SharePoint. A funcionalidade desses controles deriva do namespace Microsoft.SharePoint.WebControls, que contém controles de servidor ASP.NET usados em páginas de sites e listas do SharePoint.

Nome do controle Descrição
AspMenu Insere um menu ASP. Para obter mais informações, consulte Visão geral do controle de menu.
CssLink Insere um elemento LINK na página .aspx e aplica uma ou mais folhas de estilo externas definidas por CssRegistration.
DateTimeControl Insere um controle DateTime na página .aspx.
FormDigest Insere uma validação de segurança na página .aspx
ListProperty Retorna uma propriedade de uma lista especificada.
ProjectProperty Retorna uma propriedade global do site atual.
RssLink Insere um link para um feed RSS na página .aspx.
ScriptLink Fornece propriedades e métodos para registrar recursos, como scripts, em uma página para que eles possam ser solicitados quando a página for renderizada.
Tema Aplica um tema à página .aspx.

Depurar uma Web Part

Você pode depurar um projeto do SharePoint que contém uma Web Part da mesma forma que depuraria outros projetos do Visual Studio. Quando você inicia o depurador do Visual Studio, o Visual Studio abre o site do SharePoint.

Para começar a depurar seu código, adicione a Web Part a uma página da Web Part no SharePoint.

Para obter mais informações sobre como depurar projetos do SharePoint, consulte Solucionar problemas com soluções do SharePoint.

Limitações da Web Part visual

A partir do Visual Studio, você pode adicionar Web Parts visuais a soluções do SharePoint em área restrita e soluções de farm. No entanto, as Web Parts visuais têm as seguintes limitações:

  • As Web Parts visuais não dão suporte a parâmetros substituíveis. Para saber mais, confira Parâmetros substituíveis.

  • Os controles de usuário ou as Web Parts visuais não podem ser arrastados e removidos ou copiados para Web Parts visuais. Essa ação gera um erro de build.

  • As Web Parts visuais não dão suporte diretamente a tokens de servidor do SharePoint, como $SPUrl. Para obter mais informações, confira "Restrições de token em Web Parts visuais em área restrita" no tópico Solucionar problemas de soluções do SharePoint.

  • As Web Parts visuais em uma solução em área restrita ocasionalmente obtêm o erro: "A solicitação de execução de código em área restrita foi recusada porque o Serviço de Host de Código em Área Restrita estava muito ocupado para lidar com a solicitação." Para obter mais informações sobre esse erro, confira esta postagem no Blog da Equipe de Desenvolvedores do SharePoint.

  • Não há suporte para a depuração JavaScript do lado do servidor no Visual Studio, mas há suporte para a depuração do JavaScript no lado do cliente.

    Embora você possa adicionar JavaScript embutido a um arquivo de marcação do lado do servidor, não há suporte para depuração de pontos de interrupção adicionados à marcação. Para depurar JavaScript, faça referência a um arquivo JavaScript externo no arquivo de marcação e defina os pontos de interrupção no arquivo JavaScript.

  • A depuração de código ASP.NET embutido deve ser feita no arquivo de código gerado, e não no arquivo de marcação.

  • Web Parts visuais não dão suporte ao uso da diretiva <@ Assembly Src=.

  • Não há suporte para controles web do SharePoint e alguns controles ASP.NET no ambiente em área restrita do SharePoint. Se controles sem suporte forem usados em uma Web Part visual em uma solução em área restrita, o erro "O tipo ou o nome do namespace 'Theme' não existe no namespace 'Microsoft.SharePoint.WebControls'" será exibido.

    Para obter mais informações sobre solições em áreas restritas, consulte Diferenças entre soluções em área restrita e de farm.

Criando Web Parts com base no SharePoint em estilo mais antigo

Você pode usar os modelos no Visual Studio para criar Web Parts personalizadas do ASP.NET 2.0 para o SharePoint. As Web Parts 2.0 do ASP.NET são criadas sobre a infraestrutura de Web Part do ASP.NET e são o tipo recomendado para novos projetos.

Em poucos casos, talvez seja necessário criar uma Web Part usando o estilo mais antigo da Web Part baseada no SharePoint. Você pode usar o Visual Studio para criar esses tipos de Web Parts, mas o Visual Studio não fornece modelos projetados especificamente para ajudá-lo a criá-los.

Para obter mais informações sobre quando você pode querer criar uma Web Part baseada em SharePoint de estilo mais antigo, consulte Infraestrutura de Web Part no Windows SharePoint Services. Para obter mais informações sobre como criar uma Web Part usando o estilo mais antigo da Web Part baseada no SharePoint, consulte Passo a passo para criação de uma Web Part básica do SharePoint.

Título Descrição
Como criar uma Web Part para o SharePoint Mostra como criar Web Parts para páginas do SharePoint.
Como: criar uma Web Part do SharePoint usando um designer Mostra como criar Web Parts para o SharePoint usando uma superfície de design visual.
Como criar um controle de usuário para uma página de aplicativo do SharePoint ou Web Part Mostra como criar controles personalizados e reutilizáveis que podem ser consumidos por páginas de aplicativo e Web Parts executados no SharePoint.
Passo a passo: criar uma Web Part para o SharePoint Descreve como criar uma Web Part para o SharePoint.
Passo a passo: criar uma Web Part para o SharePoint usando um designer Descreve como criar uma Web Part para o SharePoint arrastando controles para uma superfície de design visual.
Passo a passo: criar uma Web Part do Silverlight que exibe OData para o SharePoint Descreve como criar uma Web Part para o SharePoint que hospeda um aplicativo Silverlight e exibe dados de listas do SharePoint.