共用方式為


ProjectItem 元素 (Visual Studio 專案範本)

指定專案範本中包含的檔案。

注意

元素 ProjectItem 會接受不同的屬性,視範本是針對專案或專案而定。 本主題說明 ProjectItem 專案範本的元素。 如需專案範本專案的說明ProjectItem,請參閱 ProjectItem 元素(Visual Studio 項目範本)。

<VSTemplate><範本Content<>項目專案><Item>

語法

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

屬性和元素

下列章節將說明屬性、子項目和父項目。

屬性

屬性 描述
TargetFileName 選用屬性。

從範本建立專案時,指定專案專案的名稱和路徑。 這個屬性適用於在範本 .zip 檔案中建立與目錄結構不同的目錄結構,或使用參數取代來建立項目名稱。
ReplaceParameters 選用屬性。

布爾值,指定專案是否具有從範本建立項目時必須取代的參數值。 預設值為 false
OpenInEditor 選用屬性。

布爾值,指定從範本建立專案時,是否應該在Visual Studio的個別編輯器中開啟專案。

OpenInWebBrowser值為true的專案OpenInEditor上會忽略和 OpenInHelpBrowser 屬性。

預設值是 false
OpenInWebBrowser 選用屬性。

布爾值,指定從範本建立專案時,是否應該開啟網頁瀏覽器。

只有本機專案的 HTML 檔案和文字檔可以在網頁瀏覽器中開啟。 無法使用這個屬性開啟外部 URL。

預設值是 false
OpenInHelpBrowser 選用屬性。

布爾值,指定從範本建立專案時,是否應該在 [說明查看器] 中開啟專案。

只有位於專案本機的 HTML 檔案和文字檔,才能在 [說明] 瀏覽器中開啟。 無法使用這個屬性開啟外部 URL。

預設值是 false
OpenOrder 選用屬性。

指定數值,表示專案在各自的編輯器中開啟的順序。 所有值都必須是 10 的倍數。 具有較高 OpenOrder 值的專案會先開啟。

子元素

無。

父元素

元素 描述
計畫 指定要加入至項目的檔案或目錄。

文字值

需要文字值。

string,表示範本 .zip 檔案中檔案的名稱或路徑。

備註

ProjectItem 是的 Project選擇性子系。

TargetFileName屬性可用來建立與範本 .zip 檔案中目錄結構不同的目錄結構。 例如,如果 MyFile.vb 檔案存在於範本 .zip 檔案的根目錄中,但您想要將檔案放在從範本建立的所有專案中名為 CustomFiles 的目錄中,您可以使用下列 XML:

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

TargetFileName屬性也可以用來重新命名檔名中包含國際字元的檔案。 例如,範本 .zip 檔案不能包含具有 Unicode 字元的檔名,因此必須先重新命名檔案,才能將檔案壓縮成 .zip 檔案。 TargetFileName屬性可用來將檔名設定回原始 Unicode 檔名。

TargetFileName屬性也可以用來使用參數重新命名檔案。 下列程序說明如何根據項目名稱,將範本 .zip 檔案根目錄中的 MyFile.vb 檔案重新命名為檔名。

使用參數重新命名檔案

  1. 在 .vstemplate 檔案中使用下列 XML:

    <ProjectItem TargetFileName="$safeprojectname$.vb">MyFile.vb</ProjectItem>
    
  2. 在文本編輯器或 Visual Studio 中開啟項目檔 (.vbproj for a Visual Basic 專案)。

  3. 在項目檔中找出類似下列 XML 的行:

    <Compile Include="MyFile.vb">
    
  4. 以下列 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>

另請參閱