Freigeben über

ProjectItem-Element (Visual Studio-Projektvorlagen)

  • Artikel

Gibt eine Datei an, die in der Projektvorlage enthalten ist.

Tipp

Je nachdem, ob die Vorlage für ein Projekt oder ein Element entwickelt wurde, akzeptiert das ProjectItem-Element verschiedene Attribute. In diesem Thema wird das ProjectItem-Element für Projektvorlagen erläutert. Eine Erläuterung des ProjectItem-Elements für Elementvorlagen finden Sie unter ProjectItem-Element (Visual Studio-Elementvorlagen).

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

Attribute und Elemente

In den folgenden Abschnitten werden Attribute, untergeordnete Elemente und übergeordnete Elemente beschrieben.

Attribute

Attribut

Beschreibung

TargetFileName

Optionales Attribut.

Gibt den Namen und Pfad des Projektelements an, wenn ein Projekt von der Vorlage erstellt wird. Dieses Attribut ist hilfreich beim Erstellen einer Verzeichnisstruktur, die sich von der Verzeichnisstruktur in der ZIP-Datei der Vorlage unterscheidet, oder beim Erstellen des Elementnamens mittels Parameterersetzung.

ReplaceParameters

Optionales Attribut.

Ein boolescher Wert, durch den angegeben wird, ob das Element über Parameterwerte verfügt, die ersetzt werden müssen, wenn ein Projekt von der Vorlage erstellt wird. Der Standardwert ist false.

OpenInEditor

Optionales Attribut.

Ein boolescher Wert, durch den festgelegt wird, ob das Element beim Erstellen eines Projekts von der Vorlage in seinem zugewiesenen Editor in Visual Studio geöffnet wird.

Das OpenInWebBrowser-Attribut und das OpenInHelpBrowser-Attribut werden bei einem Element mit dem OpenInEditor-Wert true ignoriert.

Der Standardwert ist false.

OpenInWebBrowser

Optionales Attribut.

Ein boolescher Wert, durch den angegeben wird, ob das Element im Webbrowser geöffnet werden soll, wenn ein Projekt von der Vorlage erstellt wird.

Nur lokal im Projekt vorhandene HTML- und Textdateien können im Webbrowser geöffnet werden. Externe URLs können nicht mit diesem Attribut geöffnet werden.

Der Standardwert ist false.

OpenInHelpBrowser

Optionales Attribut.

Ein boolescher Wert, durch den angegeben wird, ob das Element im Hilfe-Viewer geöffnet werden soll, wenn ein Projekt von der Vorlage erstellt wird.

Nur lokal im Projekt vorhandene HTML- und Textdateien können im Hilfebrowser geöffnet werden. Externe URLs können nicht mit diesem Attribut geöffnet werden.

Der Standardwert ist false.

OpenOrder

Optionales Attribut.

Gibt einen numerischen Wert für die Reihenfolge an, in der Elemente in den zugewiesenen Editoren geöffnet werden. Alle Werte müssen ein Vielfaches von 10 sein. Elemente mit niedrigeren OpenOrder-Werten werden zuerst geöffnet.

Untergeordnete Elemente

Keine.

Übergeordnete Elemente

Element

Beschreibungen

Project

Gibt die Dateien oder Verzeichnisse an, die dem Projekt hinzugefügt werden sollen.

Textwert

Ein Textwert ist erforderlich.

string mit dem Namen oder Pfad zu einer Datei, die in der ZIP-Datei der Vorlage enthalten ist.

Hinweise

ProjectItem ist ein optionales untergeordnetes Element von Project.

Das TargetFileName-Attribut kann zum Erstellen einer Verzeichnisstruktur verwendet werden, die sich von der Verzeichnisstruktur in der ZIP-Datei der Vorlage unterscheidet. Wenn die Datei MyFile.vb im Stammverzeichnis der ZIP-Datei der Vorlage vorhanden ist, sie jedoch in allen von der Vorlage erstellten Projekten in einem Verzeichnis mit dem Namen CustomFiles abgelegt werden soll, würden Sie beispielsweise folgenden XML-Code verwenden:

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

Über das TargetFileName-Attribut können zudem Dateien mit internationalen Zeichen im Dateinamen umbenannt werden. Eine als Vorlage verwendete ZIP-Datei kann beispielsweise keine Dateinamen mit Unicode-Zeichen enthalten. Die Datei muss daher umbenannt werden, bevor sie in einer ZIP-Datei komprimiert werden kann. Über das TargetFileName-Attribut kann der Dateiname auf den ursprünglichen Unicode-Dateinamen zurückgesetzt werden.

Das TargetFileName-Attribut kann auch dazu verwendet werden, Dateien mit Parametern umzubenennen. Im Folgenden wird beschrieben, wie Sie die im Stammverzeichnis der ZIP-Vorlagendatei enthaltene Datei MyFile.vb auf der Grundlage des Projektnamens umbenennen.

So benennen Sie Dateien mit Parametern um

  1. Verwenden Sie in der VSTEMPLATE-Datei die folgende XML:

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

  2. Öffnen Sie die Projektdatei (VBPROJ für ein Visual Basic-Projekt) in einem Text-Editor oder Visual Studio. Weitere Informationen über die Bearbeitung von Projektdateien in vsprvs finden Sie unter How to: Edit Project Files.

  3. Suchen Sie die Zeile in der Projektdatei, die ähnlich aussieht wie die folgende XML:

    <Compile Include="MyFile.vb">

  4. Ersetzen Sie die Codezeile durch die folgende XML:

    <Compile Include="$safeprojectname$.vb">

    Wenn ein Projekt von dieser Vorlage erstellt wird, basiert der Dateiname auf dem Namen, den der Benutzer im Dialogfeld Neues Projekt eingegeben hat. Unsichere Zeichen sowie Leerzeichen werden aus dem Namen entfernt. Weitere Informationen finden Sie unter Vorlagenparameter.

Beispiel

Im folgenden Beispiel werden die Metadaten für eine Projektvorlage einer Visual C#-Anwendung veranschaulicht.

<VSTemplate Type="Project" Version="2.0.0"
    xmlns="https://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>

Siehe auch

Aufgaben

Gewusst wie: Manuelles Erstellen von Projektvorlagen

Referenz

Schemareferenz zu Visual Studio-Vorlagen

ProjectItem-Element (Visual Studio-Elementvorlagen)

Konzepte

Vorlagenparameter

Gewusst wie: Starten von bestimmten Dateien beim Öffnen von Vorlagen

Weitere Ressourcen

Visual Studio-Vorlagen