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

Статья
10/10/2023

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

Примечание.

Элемент 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>

Элементы и атрибуты

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

Атрибуты

Атрибут	Description
`SubType`	Необязательный атрибут элемента . Указывает подтип элемента в шаблоне элемента с несколькими файлами. Это значение используется для определения редактора, который Visual Studio будет использовать для открытия элемента.
`CustomTool`	Необязательный атрибут элемента . Задает customTool для элемента в файле проекта.
`ItemType`	Необязательный атрибут элемента . Задает ItemType для элемента в файле проекта.
`ReplaceParameters`	Необязательный атрибут элемента . Логическое значение, указывающее, имеет ли элемент значения параметров, которые должны быть заменены при создании проекта из шаблона. Значение по умолчанию: `false`.
`TargetFileName`	Необязательный атрибут элемента . Указывает имя элемента, созданного на основе шаблона. Этот атрибут полезен для использования замены параметров для создания имени элемента.

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

Нет.

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

Элемент	Description
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="http://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>

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