Создание шаблонов элементов и проектов для элементов проектов SharePoint

Статья
02/20/2013

При определении пользовательского типа элемента проекта SharePoint можно связать его с шаблоном элемента или проекта, чтобы другие разработчики могли использовать элемент проекта в Visual Studio.Также можно создать мастер для шаблона.

Например, Visual Studio не содержит шаблон проекта или шаблон элемента для добавления поля к сайту SharePoint.Можно определить тип элемента проекта SharePoint, представляющий поле и формирующий шаблон элемента, который другие разработчики могут использовать для добавления элемента поля в проект SharePoint.Или можно создать шаблон проекта, чтобы разработчики могли создать новый проект SharePoint, содержащий элемент поля. В обоих случаях можно также предоставить мастер, который появляется, когда разработчики используют ваш шаблон.Этот мастер может запрашивать информацию у разработчиков для настройки нового элемента или проекта SharePoint.

Шаблоны элементов и проектов представляют собой ZIP-файлы, в которых содержатся файлы, используемые Visual Studio для создания проекта или элемента проекта.Дополнительные сведения об основных принципах работы с шаблонами элементов и проектов см. в разделе Знакомство с шаблонами Visual Studio.

Создание шаблонов элементов

При создании шаблона элемента для элемента проекта SharePoint есть файлы, которые требуются всегда, и необязательные файлы, которые могут использоваться некоторыми типами элементов проектов.Пошаговое руководство по определению типа элемента проекта SharePoint и созданию для него шаблона элемента см. в разделе Пошаговое руководство. Создание элемента проекта настраиваемого действия с помощью шаблона элемента, часть 1.

В следующей таблице приведены файлы, требуемые для создания шаблона элемента для элемента проекта SharePoint.

Требуемый файлы	Описание
SPDATA-файл	Это XML-файл, указывающий содержимое и поведение по умолчанию для элемента проекта.Этот файл должен содержаться в шаблоне элемента.Дополнительные сведения о содержимом SPDATA-файлов см. в разделе Справочные материалы по схеме элементов проектов SharePoint.
VSTEMPLATE-файл.	Этот файл предоставляет системе Visual Studio сведения, необходимые для отображения шаблона в диалоговом окне Добавление нового элемента и для создания элемента проекта из шаблона.Этот файл должен содержаться в шаблоне элемента.Дополнительные сведения см. в разделе Visual Studio Template Metadata Files.
Сборка расширения Visual Studio, реализующая интерфейс ISharePointProjectItemTypeProvider.	Эта сборка определяет поведение элемента проекта во время выполнения.Эта сборка должна содержаться в пакете VSIX с шаблоном элемента.Дополнительные сведения см. в разделах Определение пользовательских типов элементов проектов SharePoint и Разработка расширений для средств SharePoint в Visual Studio.

В следующем списке приведены некоторые из наиболее типичных необязательных файлов, которые могут содержаться в шаблоне элемента.Для некоторых типов элементов проектов могут требоваться другие файлы, не указанные здесь.

Необязательный файл	Описание
Elements.xml	Файл Элемент компонента.Этот файл определяет пользовательский интерфейс и поведение настройки, созданной элементом проекта.Каждый тип настройки, такой как экземпляры списков, типы контента или настраиваемые действия, имеют различную схему, определяющую содержимое файла.Дополнительные сведения см. в разделе Стандартный блок: Компоненты и Схемы компонента.
Schema.xml	Файл схемы для определений списка.Дополнительные сведения см. в разделе Стандартный блок: Списки и библиотеки документов и Schema.xml.
.webpart	Файл Определение веб-части.Этот файл содержит настройки свойства для веб-части.Дополнительные сведения см. в разделе Стандартный блок: Веб-части.
ASCX	Файл ASP.NET UserControl.Этот файл определяет пользовательский интерфейс визуальной веб-части.
ASPX	Файл страница ASP.NET.Этот файл содержит разметку XML, которая определяет страницу приложения.
Файлы .cs или .vb	Эти файлы кода определяют поведение настроек SharePoint, содержащих модели программирования, доступ к которым может осуществляться из кода Visual C# или Visual Basic, такие как страницы приложения, веб-части и рабочие процессы.

Создание шаблонов проектов

При создании шаблона проекта SharePoint есть файлы, которые требуются всегда, и необязательные файлы, которые могут использоваться некоторыми типами проектов.Как правило, проекты SharePoint включают как минимум один элемент проекта SharePoint.Впрочем, это не обязательно.Например, можно определить шаблон проекта SharePoint, предназначенный для использования только для развертывания решений SharePoint, созданных в других проектах.

Пошаговое руководство по определению типа элемента проекта SharePoint и созданию для него шаблона проекта см. в разделе Пошаговое руководство. Создание элемента проекта столбца сайта с помощью шаблона элемента, часть 1.

В следующей таблице указаны файлы, которые должны содержаться в шаблоне проекта SharePoint.

Требуемый файлы	Описание
VSTEMPLATE-файл	Этот файл предоставляет системе Visual Studio сведения, необходимые для отображения шаблона в диалоговом окне Новый проект и для создания проекта из шаблона.Дополнительные сведения см. в разделе Visual Studio Template Metadata Files.
CSPROJ- или VBPROJ-файл	Это файл проекта.Он определяет содержимое и параметры конфигурации проекта.
Package.package	Этот файл определяет пакет развертывания для проекта.При использовании конструктора пакетов для настройки пакета решения для проекта Visual Studio сохраняет данные о пакете решения в файле. При создании пользовательского шаблона проекта SharePoint в файл Package.package рекомендуется включать минимальное количество необходимого содержимого, а также настраивать пакет решения с помощью интерфейсов API в пространстве имен Microsoft.VisualStudio.SharePoint.Packages в расширении, связанном с шаблоном проекта.В этом случае шаблон проекта защищен от возможных изменений в структуре файла Package.package.Пример Package.package файла с минимально необходимым содержимым см. в разделе Пошаговое руководство. Создание элемента проекта столбца сайта с помощью шаблона элемента, часть 1. При необходимости изменения каталога файла Package.package можно проверить содержимое с помощью схемы, находящейся по адресу %Program Files (x86)%\Microsoft Visual Studio 11.0\Xml\Schemas\PackageModelSchema.xsd.
Package.Template.xml	Этот файл предоставляет основу для файла манифеста решения (manifest.xml) для пакета решения SharePoint (.wsp), сформированного из проекта.В этот файл можно добавить содержимое, если следует указать определенное поведение, которое не предполагается изменять в соответствии с типом проекта.Дополнительные сведения см. в разделе Стандартный блок: Решения и Схема решения. При построении пакета решения из проекта Visual Studio объединяет содержимое файлов Package.package и Package.Template.xml в файл манифеста решения.Дополнительные сведения о построении пакетов решений см. в разделе Практическое руководство. Создание пакета решения SharePoint в Visual Studio.

В следующей таблице указаны необязательные файлы, которые могут содержаться в шаблоне проекта.

Дополнительные файлы	Описание
Элементы проекта SharePoint	Можно добавить один или несколько SPDATA-файлов, определяющих типы элементов проектов SharePoint.Для каждого SPDATA-файла должен быть реализован соответствующий интерфейс ISharePointProjectItemTypeProvider в сборке расширения, содержащейся в пакете VSIX вместе с шаблоном проекта.Дополнительные сведения см. в разделе Создание шаблонов элементов. Как правило, проекты SharePoint включают как минимум один элемент проекта SharePoint.Впрочем, это не обязательно.
featureName.feature	Этот файл определяет компонент SharePoint, используемый для группировки нескольких элементов проекта для развертывания.При использовании "Конструктора компонентов" для настройки компонента в проекте, Visual Studio сохраняет данные о компоненте в этом файле.Для группировки элементов проекта в различных компонентах, можно включить несколько FEATURE-файлов. При создании пользовательского шаблона проекта SharePoint в FEATURE-файл рекомендуется включать минимально необходимое количество содержимого, а также настраивать компоненты с помощью интерфейсов API в пространстве имен Microsoft.VisualStudio.SharePoint.Features в расширении, связанном с шаблоном проекта.В этом случае шаблон проекта защищен от возможных изменений в структуре FEATURE-файла.Пример FEATURE-файла с минимально необходимым содержимым см. в разделе Пошаговое руководство. Создание элемента проекта столбца сайта с помощью шаблона элемента, часть 1. При необходимости изменения каталога FEATURE-файла можно проверить содержимое с помощью схемы, находящейся по адресу %Program Files (x86)%\Microsoft Visual Studio 11.0\Xml\Schemas\FeatureModelSchema.xsd.
featureName.Template.xml	Этот файл предоставляет основу для файла манифеста компонента (Feature.xml) для каждого компонента, сформированного из проекта.В этот файл можно добавить содержимое, если следует указать определенное поведение, которое не предполагается изменять в соответствии с типом проекта.Дополнительные сведения см. в файлах Стандартный блок: Компоненты и Feature.xml. При построении пакета решения из проекта Visual Studio сливает содержимое каждой пары файлов featureName.feature и featureName.Template.xml в файл манифеста компонента.Дополнительные сведения о построении пакетов решений см. в разделе Практическое руководство. Создание пакета решения SharePoint в Visual Studio.

Элементы проекта SharePoint

Можно добавить один или несколько SPDATA-файлов, определяющих типы элементов проектов SharePoint.Для каждого SPDATA-файла должен быть реализован соответствующий интерфейс ISharePointProjectItemTypeProvider в сборке расширения, содержащейся в пакете VSIX вместе с шаблоном проекта.Дополнительные сведения см. в разделе Создание шаблонов элементов.

Как правило, проекты SharePoint включают как минимум один элемент проекта SharePoint.Впрочем, это не обязательно.

featureName.feature

Этот файл определяет компонент SharePoint, используемый для группировки нескольких элементов проекта для развертывания.При использовании "Конструктора компонентов" для настройки компонента в проекте, Visual Studio сохраняет данные о компоненте в этом файле.Для группировки элементов проекта в различных компонентах, можно включить несколько FEATURE-файлов.

При создании пользовательского шаблона проекта SharePoint в FEATURE-файл рекомендуется включать минимально необходимое количество содержимого, а также настраивать компоненты с помощью интерфейсов API в пространстве имен Microsoft.VisualStudio.SharePoint.Features в расширении, связанном с шаблоном проекта.В этом случае шаблон проекта защищен от возможных изменений в структуре FEATURE-файла.Пример FEATURE-файла с минимально необходимым содержимым см. в разделе Пошаговое руководство. Создание элемента проекта столбца сайта с помощью шаблона элемента, часть 1.

При необходимости изменения каталога FEATURE-файла можно проверить содержимое с помощью схемы, находящейся по адресу %Program Files (x86)%\Microsoft Visual Studio 11.0\Xml\Schemas\FeatureModelSchema.xsd.

featureName.Template.xml

Этот файл предоставляет основу для файла манифеста компонента (Feature.xml) для каждого компонента, сформированного из проекта.В этот файл можно добавить содержимое, если следует указать определенное поведение, которое не предполагается изменять в соответствии с типом проекта.Дополнительные сведения см. в файлах Стандартный блок: Компоненты и Feature.xml.

При построении пакета решения из проекта Visual Studio сливает содержимое каждой пары файлов featureName.feature и featureName.Template.xml в файл манифеста компонента.Дополнительные сведения о построении пакетов решений см. в разделе Практическое руководство. Создание пакета решения SharePoint в Visual Studio.

Создание мастеров для шаблонов элементов и проектов

После определения типа элемента проекта SharePoint и связывания его с шаблоном элемента или проекта, также можно создать мастер.Мастер отображается, когда разработчик использует шаблон элемента для добавления элемента проекта SharePoint к проекту, или когда разработчик использует шаблон проекта для создания нового проекта, содержащего элемент проекта SharePoint.Мастер может быть использован для сбора информации от разработчиков и для инициализации нового элемента проекта SharePoint.

Пошаговые руководства по созданию шаблонов элементов и проектов см. в разделах Пошаговое руководство. Создание элемента проекта настраиваемого действия с помощью шаблона элемента, часть 2 и Пошаговое руководство. Создание элемента проекта столбца сайта с помощью шаблона элемента, часть 2.