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

Элемент ProjectItem (шаблоны элементов Visual Studio)

  • Статья

Указывает файла, который включается в шаблон элемента.

Примечание

Элемент ProjectItem принимает различные атрибуты в зависимости от того, для чего предназначен шаблон (для проекта или элемента).В этом разделе объясняется использование элемента ProjectItem для элементов.Описание элемента ProjectItem для шаблонов проектов содержится в разделе Элемент ProjectItem (шаблоны проектов Visual Studio).

<ProjectItem
    SubType="Form/Component/CustomControl/UserControl"
    CustomTool="string"
    ItemType="string"
    ReplaceParameters="true/false"
    TargetFileName="TargetFileName.ext">
        FileName.ext
</ProjectItem>

Атрибуты и элементы

В следующих разделах описаны атрибуты, дочерние элементы и родительские элементы.

Атрибуты

Атрибут

Описание

SubType

Необязательный атрибут.

Указывает подтип элемента в многофайловом шаблоне элемента. Это значение используется для определения редактора, который Visual Studio будет использовать, чтобы открыть элемент.

CustomTool

Необязательный атрибут.

Пользовательский инструмент для элемента в файле проекта.

ItemType

Необязательный атрибут.

Тип элемента в файле проекта.

ReplaceParameters

Необязательный атрибут.

Логическое значение, указывающее, имеются ли в элементе значения параметров, которые должны быть заменены при создании проекта из шаблона. Значение по умолчанию — false.

TargetFileName

Необязательный атрибут.

Указывает имя элемента, создаваемого из шаблона. Этот атрибут полезен при использовании замены параметров для создания имени элемента.

Дочерние элементы

Отсутствует.

Родительские элементы

Элемент

Описание

TemplateContent

Задает содержимое шаблона.

Текстовое значение

Текстовое значение является обязательным.

Строка string, представляющая имя файла в ZIP-файле шаблона.

Заметки

ProjectItem является необязательным дочерним элементом TemplateContent.

Атрибут TargetFileName можно использовать для переименования файлов с параметрами. Например, если файл MyFile.vb находится в корневом каталоге ZIP-файла шаблона, но его необходимо переименовать, основываясь на имени файла, предоставленном пользователем в диалоговом окне Добавить новый элемент, нужно использовать следующий XML-код.

<ProjectItem TargetFileName="$fileinputname$.vb">MyFile.vb</ProjectItem>

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

Пример

В следующем примере демонстрируются метаданные для стандартного шаблона элемента класса Visual C#.

<VSTemplate Type="Item" Version="3.0.0"
    xmlns="https://schemas.microsoft.com/developer/vstemplate/2005">
    <TemplateData>
        <Name>MyClass</Name>
        <Description>My custom C# class.</Description>
        <Icon>Icon.ico</Icon>
        <ProjectType>CSharp</ProjectType>
        <DefaultName>MyClass.cs</DefaultName>
    </TemplateData>
    <TemplateContent>
        <ProjectItem ReplaceParameters="true">MyClass.cs</ProjectItem>
    </TemplateContent>
</VSTemplate>

См. также

Задачи

Практическое руководство. Создание многофайловых шаблонов элементов

Ссылки

Справочник по схеме шаблонов Visual Studio

Основные понятия

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

Параметры шаблона