Elemen ProjectItem (templat item Visual Studio)

Artikel
01/13/2024

Menentukan file yang disertakan dalam templat item.

Catatan

Elemen ProjectItem menerima atribut yang berbeda tergantung pada apakah templat tersebut untuk proyek atau item. Topik ini menjelaskan ProjectItem elemen untuk item. Untuk penjelasan ProjectItem tentang elemen untuk templat proyek, lihat elemen ProjectItem (templat proyek Visual Studio).

Sintaks

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

Atribut dan elemen

Bagian berikut menjelaskan atribut, elemen turunan, dan elemen induk.

Atribut

Atribut	Deskripsi
`SubType`	Atribut opsional. Menentukan subjenis item dalam templat item multi-file. Nilai ini digunakan untuk menentukan editor yang akan digunakan Visual Studio untuk membuka item.
`CustomTool`	Atribut opsional. Mengatur CustomTool untuk item dalam file proyek.
`ItemType`	Atribut opsional. Mengatur ItemType untuk item dalam file proyek.
`ReplaceParameters`	Atribut opsional. Nilai Boolean yang menentukan apakah item memiliki nilai parameter yang harus diganti saat proyek dibuat dari templat. Nilai default `false`.
`TargetFileName`	Atribut opsional. Menentukan nama item yang dibuat dari templat. Atribut ini berguna untuk menggunakan penggantian parameter untuk membuat nama item.

Elemen anak

Tidak ada.

Elemen induk

Elemen	Deskripsi
TemplateContent	Menentukan konten templat.

Nilai teks

Nilai teks diperlukan.

string yang mewakili nama file dalam file .zip templat.

Keterangan

ProjectItem adalah anak opsional dari TemplateContent.

Atribut TargetFileName dapat digunakan untuk mengganti nama file dengan parameter. Misalnya, jika file MyFile.vb ada di direktori akar file .zip templat, tetapi Anda ingin file dinamai berdasarkan nama file yang disediakan oleh pengguna dalam kotak dialog Tambahkan Item Baru, Anda akan menggunakan XML berikut:

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

Saat item dibuat dari templat ini, nama file akan didasarkan pada nama yang dimasukkan pengguna dalam kotak dialog Tambahkan Item Baru. Ini berguna saat membuat templat item multi-file. Untuk informasi selengkapnya, lihat Cara: Membuat templat item multi-file dan Parameter templat.

Contoh

Contoh berikut mengilustrasikan metadata untuk templat item standar untuk kelas 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>

Bagikan melalui