Criando modelos de Item e projeto para os itens de projeto do SharePoint
Quando você define um tipo de item de projeto personalizado do SharePoint, pode associá-la com um modelo de item ou um modelo de projeto para que outros desenvolvedores possam usar o item de projeto em Visual Studio. Você também pode criar um Assistente para o modelo.
Por exemplo, Visual Studio 2010 não inclui um modelo de projeto ou de um modelo de item para adicionar um campo para um site do SharePoint. Você pode definir um tipo de item de projeto do SharePoint que representa um campo e, então, construir um modelo de item que outros desenvolvedores podem usar para adicionar o item de campo a um projeto do SharePoint. Ou, você pode construir um modelo de projeto para que os desenvolvedores podem criar um novo projeto do SharePoint que contém o item de campo. Em ambos os casos, você também pode fornecer um assistente que aparece quando os desenvolvedores a usar seu modelo. Este assistente pode coletar informações de desenvolvedores para configurar o novo item ou projeto.
Modelos de item e projeto são arquivos. zip que contêm arquivos que são usados pelo Visual Studio para criar um projeto ou item de projeto. Para obter mais informações sobre os fundamentos de modelos de item e projeto, consulte Introdução a modelos do Visual Studio.
Criando modelos de item
Quando você cria um modelo de item para um item de projeto do SharePoint, existem alguns arquivos que são sempre necessários e opcional que pode ser usado por determinados tipos de itens de projeto. Para uma explicação passo a passo que demonstra como definir um tipo de item de projeto do SharePoint e criar um modelo de item para ele, consulte Demonstra Passo a passo: A criação de um Item de projeto de ação personalizada com um modelo de Item, parte 1.
A tabela a seguir lista os arquivos necessários para criar um modelo de item para um item de projeto do SharePoint.
Arquivo necessário |
Descrição |
|---|---|
Um arquivo de .spdata |
Este é um arquivo XML que especifica o conteúdo e o comportamento padrão do item de projeto. Este arquivo deve ser incluído no modelo de item. Para obter mais informações sobre o conteúdo dos arquivos de .spdata, consulte Referência de esquema de Item de projeto do SharePoint. |
Um arquivo. vstemplate. |
Este arquivo fornece Visual Studio com as informações necessárias para exibir o modelo a Add New Item caixa de diálogo e criar um item de projeto do modelo. Este arquivo deve ser incluído no modelo de item. Para obter mais informações, consulte Arquivos de metadados de modelo do Visual Studio. |
Um assembly de extensão de Visual Studio que implementa o ISharePointProjectItemTypeProvider interface. |
Esse conjunto define o comportamento de tempo de execução do item de projeto. Este assembly deve ser incluído no pacote de VSIX com o modelo de item. Para obter mais informações, consulte Definindo tipos de Item de projeto do SharePoint personalizados e Implantar extensões para as ferramentas do SharePoint em Visual Studio. |
A tabela a seguir lista alguns dos arquivos opcionais mais comuns que podem ser incluídos no modelo de item. Alguns tipos de itens de projeto podem exigir outros arquivos não listados aqui.
Arquivo opcional |
Descrição |
|---|---|
Elements |
A elemento Feature arquivo. Esse arquivo define a interface do usuário e o comportamento da personalização criado pelo item de projeto. Cada tipo de personalização, como instâncias de lista, tipos de conteúdo ou ações personalizadas, tem um esquema diferente que define o conteúdo deste arquivo. Para obter mais informações, consulte Bloco de construção: Recursos e recurso esquemas. |
Schema. XML |
O arquivo de esquema para definições de lista. Para obter mais informações, consulte Bloco de construção: Listas e bibliotecas de documentos e Schema. XML. |
. WebPart |
A a definição de Web Part arquivo. Este arquivo contém as configurações de propriedade para uma Web Part. Para obter mais informações, consulte Bloco de construção: Web Parts. |
.ascx |
Um aplicativo ASP.Arquivo NET UserControl. Esse arquivo define a interface do usuário de uma Web Part Visual. |
.aspx |
Um aplicativo ASP.Arquivo de paginação NET. Este arquivo contém a marcação XML que define uma página de aplicativo. |
arquivos. cs ou. vb |
Esses arquivos de código definem o comportamento de personalizações do SharePoint que possuem um modelo de programação que pode ser acessado a partir do Visual C# ou Visual Basic código, como, por exemplo, páginas de aplicativo, Web parts e fluxos de trabalho. |
Criando modelos de projeto
Quando você cria um modelo de projeto do SharePoint, existem alguns arquivos que são sempre os arquivos necessários e opcionais que podem ser usados por determinados tipos de projetos. Normalmente, os projetos do SharePoint incluem pelo menos um item de projeto do SharePoint. No entanto, isso não é necessário. Por exemplo, você poderia definir um modelo de projeto do SharePoint se destina a ser usada somente para implantar soluções do SharePoint criadas em outros projetos.
Para uma explicação passo a passo que demonstra como definir um tipo de item de projeto do SharePoint e criar um modelo de projeto para ele, consulte Demonstra Passo a passo: A criação de um Item de projeto da coluna de Site com um modelo de projeto, parte 1.
A tabela a seguir lista os arquivos que devem ser incluídos em um modelo de projeto do SharePoint.
Arquivo necessário |
Descrição |
|---|---|
Um arquivo. vstemplate |
Este arquivo fornece Visual Studio com as informações necessárias para exibir o modelo a Novo projeto caixa de diálogo e criar um projeto do modelo. Para obter mais informações, consulte Arquivos de metadados de modelo do Visual Studio. |
Um arquivo. csproj ou. vbproj |
Este é o arquivo de projeto. Ele define o conteúdo e as definições de configuração do projeto. |
Package.Package |
Esse arquivo define o pacote de implantação para o projeto. Quando você usa o criador de pacotes para personalizar o pacote de solução para o seu projeto, o Visual Studio armazena dados sobre o pacote de solução neste arquivo. Quando você cria um modelo de projeto do SharePoint personalizado, recomendamos que você inclua somente o mínimo necessário de conteúdo no arquivo Package.package e que você configure o pacote da solução usando as APIs no Microsoft.VisualStudio.SharePoint.Packages o namespace em uma extensão que está associado com o modelo de projeto. Se você fizer isso, seu modelo de projeto está protegido contra futuras alterações na estrutura do arquivo Package.package. Para obter um exemplo que demonstra como criar um arquivo de Package.package com apenas o mínimo necessário conteúdo, consulte Demonstra Passo a passo: A criação de um Item de projeto da coluna de Site com um modelo de projeto, parte 1. Se você quiser modificar o arquivo Package.package diretamente, você pode verificar o conteúdo usando o esquema em % Program Files (10.0\Xml\Schemas\PackageModelSchema.xsd de Visual Studio de x86)%\Microsoft. |
Package.Template.XML |
Este arquivo fornece a base para o solução arquivo de manifesto (manifest. XML) para o pacote de solução do SharePoint (. wsp) que é gerado a partir do projeto. Você pode adicionar conteúdo a este arquivo se você desejar especificar o comportamento de não se destina a ser alteradas pelos usuários de seu tipo de projeto. Para obter mais informações, consulte Bloco de construção: Soluções e o esquema de solução. Quando você cria um pacote de solução do projeto, Visual Studio mescla o conteúdo da Package.package e os arquivos de Package.Template.xml na solução de arquivo de manifesto. Para obter mais informações sobre a criação de pacotes de soluções, consulte Como: Criar um pacote de solução do SharePoint no Visual Studio. |
A tabela a seguir lista os arquivos opcionais que podem ser incluídos no modelo de projeto.
Arquivo opcional |
Descrição |
|---|---|
Itens de projeto do SharePoint |
Você pode incluir um ou mais arquivos de .spdata que definem os tipos de item de projeto do SharePoint. Cada arquivo de .spdata deve ter uma correspondência ISharePointProjectItemTypeProvider implementação em um assembly de extensão que está incluído no pacote de VSIX com o modelo de projeto. Para obter mais informações, consulte Criando modelos de Item. Normalmente, os projetos do SharePoint incluem pelo menos um item de projeto do SharePoint. No entanto, isso não é necessário. |
Nome_do_recurso.feature |
Esse arquivo define um recurso é usado para agrupar vários itens de projeto para a implantação do SharePoint. Quando você usa o recurso de Designer para personalizar um recurso em seu projeto, o Visual Studio armazena dados sobre o recurso neste arquivo. Se você deseja agrupar os itens de projeto para recursos diferentes, você pode incluir vários arquivos de .feature. Quando você cria um modelo de projeto do SharePoint personalizado, recomendamos que você incluir o conteúdo mínimo necessário em cada arquivo de .feature e que você configure recursos usando as APIs no Microsoft.VisualStudio.SharePoint.Features o namespace em uma extensão que está associado com o modelo de projeto. Se você fizer isso, seu modelo de projeto está protegido contra futuras alterações na estrutura do arquivo .feature. Para obter um exemplo que demonstra como criar um arquivo de .feature com apenas o mínimo necessário conteúdo, consulte Demonstra Passo a passo: A criação de um Item de projeto da coluna de Site com um modelo de projeto, parte 1. Se você quiser modificar um arquivo de .feature diretamente, você pode verificar o conteúdo usando o esquema em % Program Files (10.0\Xml\Schemas\FeatureModelSchema.xsd de Visual Studio de x86)%\Microsoft. |
Nome_do_recurso.Template. XML |
Este arquivo fornece a base para o arquivo de manifesto do recurso (Feature. XML) para cada recurso que é gerado a partir do projeto. Você pode adicionar conteúdo a este arquivo se você desejar especificar o comportamento de não se destina a ser alteradas pelos usuários de seu tipo de projeto. Para obter mais informações, consulte Bloco de construção: Recursos e Feature. XML arquivos. Quando você cria um pacote de solução do projeto, o Visual Studio mescla o conteúdo de cada par de Nome_do_recursoo arquivo de .feature e Nome_do_recurso.Arquivos de Template. XML em um arquivo de manifesto de recurso. Para obter mais informações sobre a criação de pacotes de soluções, consulte Como: Criar um pacote de solução do SharePoint no Visual Studio. |
A criação de assistentes para modelos de Item e projeto
Depois de definir um tipo de item de projeto do SharePoint e associá-la a um modelo de item ou projeto, você também pode criar um assistente. O assistente exibe quando um desenvolvedor usa o modelo de item para adicionar o item de projeto do SharePoint para um projeto ou um desenvolvedor usa o modelo de projeto para criar um novo projeto que contém o item de projeto do SharePoint. O assistente pode ser usado para coletar informações de desenvolvedores e inicializar o novo item de projeto do SharePoint.
Para instruções passo a passo que demonstre como criar assistentes para modelos de item e projeto, consulte Demonstra Passo a passo: A criação de um Item de projeto de ação personalizada com um modelo de Item, parte 2 e Demonstra Passo a passo: A criação de um Item de projeto da coluna de Site com um modelo de projeto, parte 2.
Consulte também
Tarefas
Conceitos
Introdução a modelos do Visual Studio
Outros recursos
Definindo tipos de Item de projeto do SharePoint personalizados