Criar suplementos do SharePoint no Visual Studio

Você pode desenvolver suplementos do SharePoint usando os novos modelos para projetos e itens de projeto no vsnv.

Modelos de projeto

Quando você usa um modelo de projeto no Visual Studio, ele cria uma solução com os itens e os arquivos do projeto exigidos pelo tipo de projeto. Os modelos de projeto a seguir aparecerão na caixa de diálogo Novo Projeto se você expandir o nó Office/SharePoint e selecionar o nó Suplementos. Saiba mais sobre os modelos de projeto no nó Soluções do SharePoint em Modelos de Projeto e Item de Projeto do SharePoint.

Suplemento do Office

Cria uma página da Web hospedada em um aplicativo do Office, como o Excel ou o Outlook. Um Suplemento do Office fornece conteúdo e funcionalidade adicionais em um documento ou item do Outlook.

Saiba mais em Visão geral da plataforma Suplementos do Office.

Suplemento do SharePoint

Cria um Suplemento do SharePoint com base nas informações especificadas em um assistente. Essas informações incluem os dados a seguir.

  • O nome do suplemento.
  • Site do SharePoint local ou remoto a ser usado para a depuração de seu suplemento.
  • O tipo de suplemento que você deseja criar: hospedado pelo provedor ou hospedado pelo SharePoint.

Veja mais informações em Suplementos do SharePoint.

Modelos de item de projeto

Depois de criar uma solução do SharePoint, você pode adicionar itens de projeto a ela usando os modelos a seguir, que aparecem na caixa de diálogo Adicionar Novo Item no nó Office/SharePoint.

Suplemento do Office

Adiciona um Suplemento do Office ao seu Suplemento do SharePoint. Você pode adicionar um suplemento do painel de tarefas, um suplemento de conteúdo ou um suplemento de email.

Saiba mais em Visão geral da plataforma Suplementos do Office.

Web Part cliente (Host da Web)

Adiciona uma Web Part cliente ao seu Suplemento do SharePoint. Ao adicionar uma Web Part cliente, você poderá exibir suplementos nas páginas de um site host. Este modelo contém um único arquivo Elements.xml, cujas propriedades definem os seguintes elementos da Web Part cliente.

Nome da propriedade Descrição
ClientWebPart Especifica o nome, o título, a descrição e as dimensões da Web part cliente.
Conteúdo Define o local da página renderizada dentro da Web Part cliente. Este elemento tem duas propriedades: Type e Src.
Type especifica o tipo de Web Part que você está criando, como HTML.
Src define o local da página renderizada dentro da Web Part cliente.
O modelo faz referência a propriedades na cadeia de caracteres de consulta usando o padrão PropertyName, como Src="~addinWebUrl/Pages/ClientWebPart1.aspx?Property1=_property1_"

Saiba mais em Criar partes de suplementos para instalar com o seu Suplemento do SharePoint.

Tipo de Conteúdo

Adiciona um tipo de conteúdo ao seu Suplemento do SharePoint, semelhante aos tipos de conteúdo usados nas versões anteriores do SharePoint. Um tipo de conteúdo é um conjunto de metadados, fluxos de trabalho e comportamento para uma categoria de itens em uma lista ou biblioteca do SharePoint. Por exemplo, um item é um tipo de conteúdo de lista. Outros tipos de conteúdo de lista incluem anúncios, contatos e tarefas, e eles herdam do tipo de conteúdo do item. O tipo de conteúdo de contato contém colunas como Nome, Sobrenome e Cargo.

Quando você adiciona um tipo de conteúdo ao seu Suplemento do SharePoint, especifica o tipo de conteúdo base do qual o novo tipo de conteúdo é herdado. Por exemplo, ele pode herdar de um anúncio, de um contato, de um documento ou de um tipo de conteúdo do item. Em seguida, você usa o designer de Tipo de Conteúdo para configurar as colunas para o tipo de conteúdo e suas outras propriedades, como nome e descrição. Os valores escolhidos são adicionados aos elementos ContentType e FieldRef no arquivo Elements.xml.

Saiba mais em Bloco de construção: tipos de conteúdo do SharePoint 2010.

Elemento Vazio

Adiciona um item de projeto para um elemento vazio ao seu Suplemento do SharePoint. Este item de projeto contém um único arquivo, Elements.xml, no qual você define as propriedades do elemento. Você normalmente usa um elemento vazio para definir um item para o qual o Visual Studio não fornece um modelo.

Lista

Adiciona dois itens de projeto ao seu Suplemento do SharePoint: uma definição de lista e uma instância da lista. Ao adicionar uma lista ao seu suplemento, você especifica o nome da lista e se deseja criar uma lista em branco ou uma lista baseada em um tipo de lista existente. Você também especifica se a lista pode ser personalizada. Em seguida, você usa o Designer de Lista para configurar as colunas e exibições da lista e de outras propriedades, como o nome e a descrição da lista.

Saiba mais sobre propriedades de lista em Elemento ListTemplate (Modelo de Lista) e Elemento ListInstance (Instância de Lista).

Adiciona um item de projeto que estende a interface de usuário do seu site host adicionando uma ação a um menu de lista. A ação personalizada de menu contém um arquivo Elements.xml, que você usa para definir as propriedades da ação.

Saiba mais em Criar ações personalizadas para implantar com Suplementos do SharePoint.

Módulo

Adiciona um item de projeto de módulo ao seu Suplemento do SharePoint. Os módulos são basicamente contêineres que você pode usar para incluir outros arquivos ao implantar o Suplemento do SharePoint. Para adicionar um arquivo, copie-o para o projeto no módulo no Gerenciador de Soluções. Uma referência ao arquivo é incluída automaticamente no arquivo Elements.xml para o módulo, e a referência especifica o caminho e a URL do novo arquivo. Você pode excluir o arquivo Sample.txt incluído no módulo porque ele está incluído apenas para fins de exemplo.

Receptor de eventos remotos

Adiciona um item de projeto para um receptor de eventos remoto ao seu Suplemento do SharePoint e um projeto de aplicativo da Web à sua solução, caso esse projeto ainda não exista. O aplicativo da Web contém um serviço da Web associado ao receptor de eventos remoto no Suplemento do SharePoint. O serviço da Web contém um arquivo de código Visual Basic ou Visual C# cujo código é executado quando uma lista, um item de lista ou um evento de item da Web ocorre no Suplemento do SharePoint. Se houver um aplicativo da Web, ele será associado ao Suplemento do SharePoint e o serviço da Web será adicionado a esse aplicativo.

Saiba mais em Lidar com eventos nos Suplementos do SharePoint.

Ação Personalizada da Faixa de Opções

Adiciona um item de projeto que estende a interface de usuário do seu site host adicionando uma ação a uma faixa de opções. A ação personalizada da faixa de opções contém um arquivo Elements.xml, que define as propriedades da ação.

Saiba mais em Criar ações personalizadas para implantar com Suplementos do SharePoint.

Configuração de pesquisa

Adiciona um item de projeto que lhe permite importar configurações personalizadas de parâmetros de pesquisa que foram exportadas de um site do SharePoint.

Coluna do site

Adiciona um item de projeto para uma coluna de site ao seu Suplemento do SharePoint. A coluna do site contém um arquivo Elements.xml que define as propriedades de Campo da coluna do site, incluindo os seguintes dados.

Nome da propriedade Descrição
ID Um valor GUID exclusivo para a coluna de site.
Nome Um nome exclusivo usado para se fazer referência à coluna de site.
DisplayName Um nome amigável que aparece na interface do usuário.
Tipo O tipo de dados da coluna de site com base em SPFieldType, como booliano, pesquisa ou texto.
Obrigatório Se a coluna for obrigatória, a propriedade será definida como Verdadeiro. Caso contrário, a propriedade será definida como Falso.
Grupo Especifica o nome do grupo ao qual a coluna do site está atribuída. O valor padrão para essa propriedade é Colunas de Site Personalizadas..

Saiba mais em Bloco de construção: tipos de campo e colunas.

Fluxo de Trabalho

Adiciona um item de projeto para um fluxo de trabalho do Microsoft Azure ao seu Suplemento do SharePoint. Saiba mais em Fluxos de trabalho no SharePoint.

Quando você adiciona esse tipo de item, especifica um nome para o fluxo de trabalho e se é um fluxo de trabalho de lista ou de site. Como os nomes sugerem, um fluxo de trabalho de lista funciona apenas com uma lista e o fluxo de trabalho de um site funciona apenas com o site do SharePoint. Ao criar o fluxo de trabalho, você também especifica se deve associar automaticamente o fluxo de trabalho a listas e bibliotecas e, em caso afirmativo, quais delas. Para cada associação adicionada, um arquivo é adicionado ao projeto de fluxo de trabalho. Um fluxo de trabalho contém os seguintes arquivos.

Nome do arquivo Descrição
Elements.xml Especifica a configuração do fluxo de trabalho e dos arquivos que ele contém, como o arquivo workflow.xaml e os arquivos de associação, e as propriedades de cada arquivo, como URL, tipo e caminho. Para cada arquivo adicionado ao projeto de fluxo de trabalho, uma seção correspondente é adicionada ao arquivo Elements.xml do fluxo de trabalho. Os arquivos de associação em fluxos de trabalho de lista requerem uma lista, portanto, eles têm uma referência ao token de lista. Em um fluxo de trabalho de site, um GUID é adicionado ao site. Cuidado Como o Visual Studio mantém os itens no arquivo Elements.xml, é recomendável alterá-los, a menos que você esteja familiarizado com o impacto das alterações.
Workflow.xaml Representa o designer para o fluxo de trabalho. Nesse arquivo, você adiciona ações ao fluxo de trabalho e define o código e as propriedades.
WorkflowStartAssociation Inicia manualmente o fluxo de trabalho no SharePoint. Esse arquivo será adicionado ao projeto de fluxo de trabalho se você selecionar a caixa de seleção Um usuário iniciar manualmente a caixa de seleção do fluxo de trabalho no assistente de fluxo de trabalho.
ItemAddedAssociation Inicia o fluxo de trabalho automaticamente se houver um quando um usuário cria um item no site ou na lista (dependendo do tipo de fluxo de trabalho). Esse arquivo será adicionado ao projeto de fluxo de trabalho se você selecionar o fluxo de trabalho iniciado automaticamente quando um item for adicionado no assistente de fluxo de trabalho.
ItemUpdatedAssociation Inicia o fluxo de trabalho automaticamente, caso exista algum quando um usuário alterar um item no site ou na lista (dependendo do tipo de fluxo de trabalho). Esse arquivo será adicionado ao projeto de fluxo de trabalho se você selecionar o fluxo de trabalho iniciado automaticamente quando um item for alterado no assistente de fluxo de trabalho.
WorkflowHistoryList Representa o arquivo adicionado ao projeto de fluxo de trabalho se você criar uma lista de histórico para o fluxo de trabalho no assistente de fluxo de trabalho.
WorkflowTaskList Representa o arquivo adicionado ao projeto de fluxo de trabalho se você criar uma lista de tarefas para o fluxo de trabalho no assistente de fluxo de trabalho.

Atividade personalizada de fluxo de trabalho

Adiciona um item de projeto para uma atividade personalizada de fluxo de trabalho ao seu Suplemento do SharePoint. Ao adicionar uma atividade personalizada de fluxo de trabalho, você pode criar ações de fluxo de trabalho adicionais que podem ser importadas como ações personalizadas no SharePoint Designer. A atividade personalizada de fluxo de trabalho contém um arquivo Elements.xml, que define as propriedades da ação, e um arquivo .xaml para o designer de fluxo de trabalho.

Saiba mais em Fluxos de trabalho no SharePoint.

Confira também