Elemen ProjectItem (templat proyek Visual Studio)

Artikel
01/13/2024

Menentukan file yang disertakan dalam templat proyek.

Catatan

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

Sintaks

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

Atribut dan elemen

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

Atribut

Atribut	Deskripsi
`TargetFileName`	Atribut opsional. Menentukan nama dan jalur item proyek saat proyek dibuat dari templat. Atribut ini berguna untuk membuat struktur direktori yang berbeda dari struktur direktori dalam file .zip templat, atau untuk menggunakan penggantian parameter untuk membuat nama item.
`ReplaceParameters`	Atribut opsional. Nilai Boolean yang menentukan apakah item memiliki nilai parameter yang harus diganti saat proyek dibuat dari templat. Nilai default `false`.
`OpenInEditor`	Atribut opsional. Nilai Boolean yang menentukan apakah item harus dibuka di editornya masing-masing di Visual Studio saat proyek dibuat dari templat. Atribut `OpenInWebBrowser` dan `OpenInHelpBrowser` diabaikan pada item dengan `OpenInEditor` nilai `true`. Nilai defaultnya adalah `false`.
`OpenInWebBrowser`	Atribut opsional. Nilai Boolean yang menentukan apakah item harus dibuka browser Web saat proyek dibuat dari templat. Hanya file HTML dan file teks yang lokal untuk proyek yang dapat dibuka di browser Web. URL eksternal tidak dapat dibuka dengan atribut ini. Nilai defaultnya adalah `false`.
`OpenInHelpBrowser`	Atribut opsional. Nilai Boolean yang menentukan apakah item harus dibuka di penampil Bantuan saat proyek dibuat dari templat. Hanya file HTML dan file teks yang lokal untuk proyek yang dapat dibuka di browser Bantuan. URL eksternal tidak dapat dibuka dengan atribut ini. Nilai defaultnya adalah `false`.
`OpenOrder`	Atribut opsional. Menentukan nilai numerik yang mewakili urutan item yang akan dibuka di editor masing-masing. Semua nilai harus kelipatan 10. Item dengan nilai yang lebih tinggi `OpenOrder` dibuka terlebih dahulu.

Elemen anak

Tidak ada.

Elemen induk

Elemen	Deskripsi
Proyek	Menentukan file atau direktori yang akan ditambahkan ke proyek.

Nilai teks

Nilai teks diperlukan.

string yang mewakili nama atau jalur ke file dalam file .zip templat.

Keterangan

ProjectItem adalah anak opsional dari Project.

Atribut TargetFileName dapat digunakan untuk membuat struktur direktori yang berbeda dari struktur direktori dalam file .zip templat. Misalnya, jika file MyFile.vb ada di akar file .zip templat, tetapi Anda ingin file ditempatkan dalam direktori bernama CustomFiles di semua proyek yang dibuat dari templat, Anda akan menggunakan XML berikut:

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

Atribut TargetFileName juga dapat digunakan untuk mengganti nama file yang berisi karakter internasional dalam nama file mereka. Misalnya, file .zip templat tidak boleh berisi nama file dengan karakter Unicode, sehingga file harus diganti namanya sebelum dapat dikompresi ke dalam file .zip. Atribut TargetFileName dapat digunakan untuk mengatur nama file kembali ke nama file Unicode asli.

Atribut TargetFileName juga dapat digunakan untuk mengganti nama file dengan parameter. Prosedur berikut menjelaskan cara mengganti nama file MyFile.vb, yang ada di direktori akar file .zip templat, menjadi nama file berdasarkan nama proyek.

Untuk mengganti nama file dengan parameter

Gunakan XML berikut dalam file .vstemplate :

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

Buka file proyek (.vbproj untuk proyek Visual Basic) di editor teks atau Visual Studio.
Temukan baris dalam file proyek yang terlihat mirip dengan XML berikut:
```
<Compile Include="MyFile.vb">
```
Ganti baris kode dengan XML berikut:
```
<Compile Include="$safeprojectname$.vb">
```
Saat proyek dibuat dari templat ini, nama file akan didasarkan pada nama yang dimasukkan pengguna dalam kotak dialog Proyek Baru, dengan semua karakter dan spasi tidak aman dihapus. Untuk informasi selengkapnya, lihat Parameter templat.

Contoh

Contoh berikut menunjukkan metadata untuk templat proyek untuk aplikasi 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>

Bagikan melalui