Criando modelos de Item e projeto para itens de projeto do SharePoint

Artigo
02/25/2013

Quando você define um tipo de item de projeto personalizado do SharePoint, você pode associá-lo com um modelo de item ou um modelo de projeto para que outros desenvolvedores possam usar o item de projeto no Visual Studio.Você também pode criar um assistente para o modelo.

Por exemplo, o Visual Studio não inclui um modelo de projeto ou modelo de item para adicionar um campo a um site web do SharePoint.Você pode definir um tipo de item de projeto do SharePoint que representa um campo e constrói em um modelo de item que outros desenvolvedores possam usar para adicionar o item do campo para um projeto do SharePoint.Ou, você pode criar um modelo de projeto para que os desenvolvedores possam criar um novo projeto do SharePoint que contém o item do campo. Em ambos os casos, você também pode fornecer um assistente que aparece quando os desenvolvedores usam o modelo.Este assistente pode reunir informações dos desenvolvedores para configurar o novo item ou projeto.

Modelos de item e modelos de projeto são os arquivos .zip que contêm os arquivos que são usados pelo Visual Studio para criar um item de projeto ou um projeto.Para obter mais informações sobre os fundamentos de modelos de item e de modelos de projeto, consulte Introdução aos modelos de Visual Studio.

Criando modelos de item

Quando você cria um modelo de item para um item de projeto do SharePoint, há alguns arquivos que são sempre necessários e opcionais, os arquivos que podem ser usados por certos tipos de itens de projeto.Para uma explicação passo a passo que demonstra como definir um tipo de item de projeto e do SharePoint para criar um modelo de item para ele, consulte Passo a passo: Criando 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 item de projeto.Esse arquivo deve ser incluído no modelo de item.Para obter mais informações sobre conteúdo de arquivos de .spdata, consulte Referência de esquema de Item de projeto do SharePoint.
Um arquivo .vstemplate.	Esse arquivo fornece o Visual Studio com informações necessárias para exibir o modelo na caixa de diálogo de Adicionar novo item e para criar um item de projeto do modelo.Esse arquivo deve ser incluído no modelo de item.Para obter mais informações, consulte Visual Studio Template Metadata Files.
Um assembly de extensão do Visual Studio que implementa a interface de ISharePointProjectItemTypeProvider .	Este assembly define o comportamento em tempo de execução do item de projeto.Este assembly deve ser incluído no conjunto de VSIX com o modelo de item.Para obter mais informações, consulte Definindo tipos de Item de projeto do SharePoint personalizados e Implantação de extensões para as ferramentas de SharePoint no Visual Studio.

A tabela a seguir lista alguns dos arquivos opcionais 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.xml	Um elemento de recurso.Esse arquivo define interface do usuário e o comportamento de personalização criada pelo item de projeto.Cada tipo de personalização, como instâncias da lista, tipos de conteúdo, ou ações personalizadas, tem um esquema diferente que define o conteúdo do arquivo.Para obter mais informações, consulte Bloco de construção: recursos e Esquemas de recurso.
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	Um arquivo de definição de Web parts .Este arquivo contém as configurações de propriedade de Web parts.Para obter mais informações, consulte Bloco de construção: Web Parts.
.ascx	Um arquivo do ASP.NET UserControl.Esse arquivo define interface de usuário da Web parts visual.
.aspx	Um arquivo da página ASP.NET.Este arquivo contém marcação XML que define uma página do aplicativo.
arquivos .cs ou .vb	Esses arquivos de código a seguir definem o comportamento das personalizações do SharePoint que têm um modelo de programação que pode ser acessado visual C# ou de código Visual Basic, como páginas de aplicativo, partes Web, e fluxos de trabalho.

Criando modelos de projeto

Quando você cria um modelo de projeto do SharePoint, há alguns arquivos que são sempre necessários e opcionais, os arquivos que podem ser usados por certos tipos de projetos.Normalmente, os projetos do SharePoint incluem pelo menos um item de projeto do SharePoint.Em o entanto, isso não é necessário.Por exemplo, você pode definir um modelo de projeto do SharePoint que é destinada a ser usado 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 e do SharePoint para criar um modelo de projeto para ele, consulte Passo a passo: Criando um Item de projeto de coluna do 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	Esse arquivo fornece o Visual Studio com informações necessárias para exibir o modelo na caixa de diálogo de Novo Projeto e criar um projeto do modelo.Para obter mais informações, consulte Visual Studio Template Metadata Files.
Um arquivo csproj ou .vbproj	este é o arquivo de projeto.Define o conteúdo e as configurações do projeto.
Package.package	Esse arquivo define o pacote de implantação do projeto.Quando você usar o designer de pacote para personalizar o pacote de solução para seu projeto, o Visual Studio armazena dados sobre o pacote de solução em este arquivo. Quando você cria um modelo de projeto personalizado do SharePoint, é recomendável que você inclua somente o conteúdo necessário mínimo no arquivo de Package.package, e que você configura o pacote de solução usando APIs no namespace de Microsoft.VisualStudio.SharePoint.Packages em uma extensão que está associada com o modelo de projeto.Se você fizer isso, o modelo de projeto está protegido de alterações futuras a estrutura do arquivo de Package.package.Para um exemplo que demonstra como criar um arquivo de Package.package apenas com o mínimo requer o conteúdo, consulte Passo a passo: Criando um Item de projeto de coluna do Site com um modelo de projeto, parte 1. Se você deseja modificar diretamente o arquivo Package.package, você pode verificar o conteúdo usando o esquema em %Program Files (x86)%\Microsoft Visual Studio 11.0\Xml\Schemas\PackageModelSchema.xsd.
Package.Template.xml	Esse arquivo fornece a base para o arquivo de manifesto de solução (manifest.xml) para o pacote de solução do SharePoint .wsp () que é gerada do projeto.Você pode adicionar conteúdo para esse arquivo se você desejar especificar qualquer comportamento que não é destinada a ser modificado por usuários do seu tipo de projeto.Para obter mais informações, consulte Bloco de construção: soluções e Esquema de solução. Quando você compila um pacote de solução do projeto, o Visual Studio mescla o conteúdo de Package.package e os arquivos de Package.Template.xml no arquivo de manifesto de solução.Para obter mais informações sobre os pacotes de solução de compilação, 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 itens de projeto do SharePoint.Cada arquivo de .spdata deve ter uma implementação de ISharePointProjectItemTypeProvider correspondente em um conjunto 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.Em o entanto, isso não é necessário.
featureName.feature	Esse arquivo define um recurso do SharePoint que é usado para agrupar vários itens de projeto para implantação.Quando você usar o resource designer para personalizar um recurso em seu projeto, o Visual Studio armazena dados sobre o recurso no arquivo.Se você deseja agrupar itens de projeto em recursos diferentes, você pode incluir vários arquivos de .feature. Quando você cria um modelo de projeto personalizado do SharePoint, é recomendável que você inclua somente o conteúdo mínimo necessário em cada arquivo de .feature, e que você configura recursos usando APIs no namespace de Microsoft.VisualStudio.SharePoint.Features em uma extensão que está associada com o modelo de projeto.Se você fizer isso, o modelo de projeto está protegido de alterações futuras a estrutura do arquivo de .feature.Para um exemplo que demonstra como criar um arquivo de .feature apenas com o mínimo requer o conteúdo, consulte Passo a passo: Criando um Item de projeto de coluna do Site com um modelo de projeto, parte 1. Se você deseja modificar diretamente um arquivo .feature, você pode verificar o conteúdo usando o esquema em %Program Files (x86)%\Microsoft Visual Studio 11.0\Xml\Schemas\FeatureModelSchema.xsd.
featureName. Template.xml	Esse arquivo fornece a base para o arquivo de manifesto de recurso (Feature.xml) para cada recurso que é gerado de projeto.Você pode adicionar conteúdo para esse arquivo se você desejar especificar qualquer comportamento que não é destinada a ser modificado por usuários do seu tipo de projeto.Para obter mais informações, consulte Bloco de construção: recursos e Feature.xml arquivos. Quando você compila um pacote de solução do projeto, o Visual Studio mescla o conteúdo de cada par de arquivo de featureName.feature e de featureName. Template.xml arquivos em um arquivo de recurso de manifesto.Para obter mais informações sobre os pacotes de solução de compilação, consulte Como: criar um pacote de solução do SharePoint no Visual Studio.

Itens de projeto do SharePoint

Você pode incluir um ou mais arquivos de .spdata que definem os tipos de itens de projeto do SharePoint.Cada arquivo de .spdata deve ter uma implementação de ISharePointProjectItemTypeProvider correspondente em um conjunto 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.Em o entanto, isso não é necessário.

featureName.feature

Esse arquivo define um recurso do SharePoint que é usado para agrupar vários itens de projeto para implantação.Quando você usar o resource designer para personalizar um recurso em seu projeto, o Visual Studio armazena dados sobre o recurso no arquivo.Se você deseja agrupar itens de projeto em recursos diferentes, você pode incluir vários arquivos de .feature.

Quando você cria um modelo de projeto personalizado do SharePoint, é recomendável que você inclua somente o conteúdo mínimo necessário em cada arquivo de .feature, e que você configura recursos usando APIs no namespace de Microsoft.VisualStudio.SharePoint.Features em uma extensão que está associada com o modelo de projeto.Se você fizer isso, o modelo de projeto está protegido de alterações futuras a estrutura do arquivo de .feature.Para um exemplo que demonstra como criar um arquivo de .feature apenas com o mínimo requer o conteúdo, consulte Passo a passo: Criando um Item de projeto de coluna do Site com um modelo de projeto, parte 1.

Se você deseja modificar diretamente um arquivo .feature, você pode verificar o conteúdo usando o esquema em %Program Files (x86)%\Microsoft Visual Studio 11.0\Xml\Schemas\FeatureModelSchema.xsd.

featureName. Template.xml

Esse arquivo fornece a base para o arquivo de manifesto de recurso (Feature.xml) para cada recurso que é gerado de projeto.Você pode adicionar conteúdo para esse arquivo se você desejar especificar qualquer comportamento que não é destinada a ser modificado por usuários do seu tipo de projeto.Para obter mais informações, consulte Bloco de construção: recursos e Feature.xml arquivos.

Quando você compila um pacote de solução do projeto, o Visual Studio mescla o conteúdo de cada par de arquivo de featureName.feature e de featureName. Template.xml arquivos em um arquivo de recurso de manifesto.Para obter mais informações sobre os pacotes de solução de compilação, consulte Como: criar um pacote de solução do SharePoint no Visual Studio.

Criando assistentes para modelos de item e modelos de projeto

Após você definir um tipo de item de projeto do SharePoint e o associa com um modelo de item ou do projeto, você também pode criar um assistente.O assistente quando um desenvolvedor usar o modelo de item para adicionar o item de projeto do SharePoint a um projeto, ou quando um desenvolvedor usar o modelo de projeto para criar um novo projeto que contém o item de projeto do SharePoint.O assistente pode ser usado para reunir informações dos desenvolvedores e inicializar o novo item de projeto do SharePoint.

Para orientações que demonstram como assistentes para criar modelos de item e modelos de projeto, consulte Passo a passo: Criando um Item de projeto de ação personalizada com um modelo de Item, parte 2 e Passo a passo: Criando um Item de projeto de coluna do Site com um modelo de projeto, parte 2.