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

Статья
01/13/2024

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

Примечание.

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

Синтаксис

<ProjectItem
    TargetFileName="TargetFileName.ext"
    ReplaceParameters="true/false"
    OpenInEditor="true/false"
    OpenInWebBrowser="true/false"
    OpenInHelpBrowser="true/false"
    OpenOrder="Value">
        FileName.ext
</ProjectItem>

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

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

Атрибуты

Атрибут	Description
`TargetFileName`	Необязательный атрибут элемента . Указывает имя и путь элемента проекта при создании проекта из шаблона. Этот атрибут полезен для создания структуры каталогов, отличной от структуры каталогов в ZIP-файле шаблона, или при использовании замены параметров для создания имени элемента.
`ReplaceParameters`	Необязательный атрибут элемента . Логическое значение, указывающее, имеет ли элемент значения параметров, которые должны быть заменены при создании проекта из шаблона. Значение по умолчанию: `false`.
`OpenInEditor`	Необязательный атрибут элемента . Логическое значение, указывающее, следует ли открывать элемент в соответствующем редакторе в Visual Studio при создании проекта из шаблона. Атрибуты `OpenInWebBrowser` игнорируются для элемента со значением `OpenInEditortrue`.`OpenInHelpBrowser` Значение по умолчанию — `false`.
`OpenInWebBrowser`	Необязательный атрибут элемента . Логическое значение, указывающее, следует ли открывать элемент в веб-браузере при создании проекта из шаблона. В веб-браузере можно открыть только HTML-файлы и текстовые файлы, которые являются локальными для проекта. Внешние URL-адреса нельзя открыть с помощью этого атрибута. Значение по умолчанию — `false`.
`OpenInHelpBrowser`	Необязательный атрибут элемента . Логическое значение, указывающее, следует ли открывать элемент в средстве просмотра справки при создании проекта из шаблона. В браузере справки можно открыть только HTML-файлы и текстовые файлы, которые являются локальными для проекта. Внешние URL-адреса нельзя открыть с помощью этого атрибута. Значение по умолчанию — `false`.
`OpenOrder`	Необязательный атрибут элемента . Указывает числовое значение, представляющее порядок открытия элементов в соответствующих редакторах. Все значения должны быть кратными из 10. Сначала открываются элементы с более высокими `OpenOrder` значениями.

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

Нет.

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

Элемент	Description
Проект	Указывает файлы или каталоги для добавления в проект.

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

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

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

Замечания

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

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

<ProjectItem TargetFileName="CustomFiles\MyFile.vb">MyFile.vb</ProjectItem>

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

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

Переименование файлов с параметрами

Используйте следующий XML-код в vstemplate-файле :
```
<ProjectItem TargetFileName="$safeprojectname$.vb">MyFile.vb</ProjectItem>
```
Откройте файл проекта (Vbproj для проекта Visual Basic) в текстовом редакторе или Visual Studio.
Найдите строку в файле проекта, который выглядит примерно так:
```
<Compile Include="MyFile.vb">
```
Замените строку кода следующим XML-кодом:
```
<Compile Include="$safeprojectname$.vb">
```
При создании проекта из этого шаблона имя файла будет зависеть от имени пользователя, введенного в диалоговом окне "Новый проект ", со всеми небезопасными символами и пробелами. Дополнительные сведения см. в разделе "Параметры шаблона".

Пример

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

<VSTemplate Type="Project" Version="3.0.0"
    xmlns="http://schemas.microsoft.com/developer/vstemplate/2005">
    <TemplateData>
        <Name>My template</Name>
        <Description>A basic starter kit</Description>
        <Icon>TemplateIcon.ico</Icon>
        <ProjectType>CSharp</ProjectType>
    </TemplateData>
    <TemplateContent>
        <Project File="MyStarterKit.csproj">
            <ProjectItem ReplaceParameters="true">Form1.cs<ProjectItem>
            <ProjectItem>Form1.Designer.cs</ProjectItem>
            <ProjectItem>Program.cs</ProjectItem>
            <ProjectItem>Properties\AssemblyInfo.cs</ProjectItem>
            <ProjectItem>Properties\Resources.resx</ProjectItem>
            <ProjectItem>Properties\Resources.Designer.cs</ProjectItem>
            <ProjectItem>Properties\Settings.settings</ProjectItem>
            <ProjectItem>Properties\Settings.Designer.cs</ProjectItem>
        </Project>
    </TemplateContent>
</VSTemplate>

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