Поделиться через

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

  • Статья

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

Добавление шаблона элемента в диалоговое окно "Добавление нового элемента"

  1. Создайте или откройте проект в Visual Studio.

  2. Добавьте элемент в проект и измените его по своему усмотрению.

  3. Отредактируйте файл кода, чтобы указать, где должна быть выполнена замена параметра. Дополнительные сведения см. в разделе Практическое руководство. Замена параметров в шаблоне.

  4. В меню Проект выберите команду Экспорт шаблона.

  5. На странице Выбор типа шаблона выберите Шаблон элемента, затем проект, который содержит элемент, и нажмите кнопку Далее.

  6. На странице Выбор элемента для экспорта выберите элемент, для которого нужно создать шаблон, а затем нажмите кнопку Далее.

  7. На странице Выбор ссылок для элементов выберите ссылки на сборки, включаемые в шаблон, а затем нажмите кнопку Далее.

  8. На странице Выбор параметров шаблона введите имя шаблона и необязательное описание, значок и рисунок предварительного просмотра, а затем нажмите кнопку Готово. Файлы значков для элементов — файлы, как описано .ico в разделе "Изображения и значки" для Visual Studio — типы файлов. Изображение предварительного просмотра — это изображение 200 x 200, которое появится в диалоговом окне "Добавление нового элемента ".

    Вы можете просмотреть библиотеку образов Visual Studio для значков в соответствии со стилем Visual Studio.

    Файлы для шаблона добавляются в ZIP-файл и копируются в каталог, который вы указали в мастере. Расположением по умолчанию является папка %USERPROFILE%\Documents\Visual Studio <версия>\My Exported Templates.

  9. Если вы не выбрали параметр Автоматически импортировать шаблон в Visual Studio в мастере экспорта шаблонов, найдите экспортированный шаблон. Затем скопируйте его в каталог пользовательских шаблонов элементов. Расположением по умолчанию является папка %USERPROFILE%\Documents\Visual Studio <версия>\Templates\ItemTemplates.

  10. Закройте Visual Studio, а затем откройте среду повторно.

  11. Создайте новый проект или откройте существующий, а затем выберите Проект>Добавить новый элемент или нажмите клавиши CTRL+SHIFT+A.

    Шаблон элемента появится в диалоговом окне Добавление нового элемента. Если вы добавили описание в мастере экспорта шаблонов, оно будет отображаться в правой части диалогового окна.

Включение шаблона элемента для использования в проекте универсального приложения для Windows

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

  1. Выполните шаги из предыдущего раздела по экспорту шаблона элемента.

  2. Извлеките созданный ZIP-файл и откройте VSTEMPLATE-файл в Visual Studio.

  3. Для проекта универсальной платформы Windows на C# добавьте следующий XML-код внутри <TemplateData> элемента:

    <TemplateID>Microsoft.CSharp.Class</TemplateID>

  4. Сохраните VSTEMPLATE-файл в Visual Studio и закройте его.

  5. Скопируйте и вставьте VSTEMPLATE-файл обратно в ZIP-файл.

    Если откроется диалоговое окно Копирование файла, выберите параметр Копировать с заменой.

Теперь можно добавить основанный на этом шаблоне элемент в проект универсальной платформы Windows из диалогового окна Добавление нового элемента.

Включение шаблонов для конкретных подтипов проектов

Можно указать, что шаблон должен отображаться только для определенных подтипов проекта, например Windows, Office, базы данных или веб-сайта.

  1. Найдите в VSTEMPLATE-файле элемент ProjectType для шаблона элемента.

  2. Добавьте элемент ProjectSubType сразу после элемента ProjectType.

  3. Задайте для элемента одно из следующих текстовых значений:

    • Windows
    • Office
    • База данных
    • Интернет

Например: <ProjectSubType>Database</ProjectSubType>.

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

<VSTemplate Version="2.0.0" Type="Item" Version="2.0.0">
   <TemplateData>
      <Name>Class</Name>
      <Description>An empty class file</Description>
      <Icon>Class.ico</Icon>
      <ProjectType>CSharp</ProjectType>
      <ProjectSubType>Office</ProjectSubType>
      <DefaultName>Class.cs</DefaultName>
   </TemplateData>
   <TemplateContent>
      <ProjectItem>Class1.cs</ProjectItem>
   </TemplateContent>
</VSTemplate>

Создание шаблона элемента вручную

В некоторых случаях может потребоваться вручную создать шаблон элемента с нуля.

  1. Создайте проект и его элемент.

  2. Измените элемент проекта, пока он не будет готов к сохранению в качестве шаблона.

  3. Отредактируйте файл кода, чтобы указать, где должна быть выполнена замена параметра. Дополнительные сведения о замене параметров см. в статье Практическое руководство. Замена параметров в шаблоне.

  4. Создайте XML-файл и сохраните его, используя расширение VSTEMPLATE, в одном каталоге с файлом элемента проекта.

  5. Измените VSTEMPLATE-файл с кодом XML для предоставления метаданных шаблона элемента. Дополнительные сведения см. в статье Справочник по схемам шаблонов (расширяемость) и в примере из предыдущего раздела.

  6. Сохраните VSTEMPLATE-файл и закройте его.

  7. В проводнике выберите файлы, которые нужно включить в шаблон. Щелкните выбранные файлы правой кнопкой мыши и выберите пункты Отправить>Сжатая ZIP-папка. Выбранные файлы будут сжаты в ZIP-файл.

  8. Скопируйте ZIP-файл и вставьте его в расположение, где находится пользовательский шаблон элемента. Каталог по умолчанию — %USERPROFILE%\Documents\Visual Studio 2022\Templates\ItemTemplates. Дополнительные сведения см. в статье Практическое руководство. Размещение и упорядочение шаблонов проектов и элементов.

Связанный контент