ProjectItem-Element (Visual Studio-Projektvorlagen)

  • Artikel

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

Hinweis

Das ProjectItem Element akzeptiert unterschiedliche Attribute, je nachdem, ob es sich bei der Vorlage um ein Projekt oder ein Element handelt. In diesem Thema wird das ProjectItem Element für Projektvorlagen erläutert. Eine Erläuterung des Elements für Elementvorlagen finden Sie unter ProjectItem Element (Visual Studio Item Templates).For an explanation of the element templates, see ProjectItem Element (Visual Studio Item Templates).For an explanation of the ProjectItem element templates, see ProjectItem Element (Visual Studio Item Templates).

<VSTemplate TemplateContent><<>ProjectItem><>

Syntax

<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-Elemente sowie untergeordnete und übergeordnete Elemente beschrieben.

Attribute

Attribut Beschreibung
TargetFileName Optionales Attribut.

Gibt den Namen und Pfad des Projektelements an, wenn ein Projekt aus der Vorlage erstellt wird. Dieses Attribut ist nützlich, um eine Verzeichnisstruktur zu erstellen, die sich von der Verzeichnisstruktur in der ZIP-Datei der Vorlage unterscheidet, oder zum Verwenden der Parameterersetzung zum Erstellen eines Elementnamens.
ReplaceParameters Optionales Attribut.

Ein boolescher Wert, der angibt, ob das Element Parameterwerte enthält, die ersetzt werden müssen, wenn ein Projekt aus der Vorlage erstellt wird. Der Standardwert ist falsesein.
OpenInEditor Optionales Attribut.

Ein boolescher Wert, der angibt, ob das Element in seinem jeweiligen Editor in Visual Studio geöffnet werden soll, wenn ein Projekt aus der Vorlage erstellt wird.

Die OpenInWebBrowser Attribute und OpenInHelpBrowser Attribute werden für ein Element mit einem OpenInEditor Wert von trueignoriert.

Der Standardwert ist false.
OpenInWebBrowser Optionales Attribut.

Ein boolescher Wert, der angibt, ob das Element beim Erstellen eines Projekts aus der Vorlage geöffnet werden soll.

Nur HTML-Dateien und Textdateien, die lokal für das Projekt sind, 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, der angibt, ob das Element im Hilfe-Viewer geöffnet werden soll, wenn ein Projekt aus der Vorlage erstellt wird.

Nur HTML-Dateien und Textdateien, die lokal für das Projekt sind, 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 an, der die Reihenfolge darstellt, in der Elemente in ihren jeweiligen Editoren geöffnet werden. Alle Werte müssen Vielfache von 10 sein. Elemente mit höheren OpenOrder Werten werden zuerst geöffnet.

Untergeordnete Elemente

Keine

Übergeordnete Elemente

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

Text Wert

Ein Textwert ist erforderlich.

A string that represents the name or path to a file in the template .zip file.

Hinweise

ProjectItem ist ein optionales untergeordnetes Element von Project.

Das TargetFileName Attribut kann verwendet werden, um eine Verzeichnisstruktur zu erstellen, die sich von der Verzeichnisstruktur in der ZIP-Datei der Vorlage unterscheidet. Wenn die Datei "MyFile.vb" beispielsweise im Stammverzeichnis der ZIP-Datei der Vorlage vorhanden ist, die Datei aber in einem Verzeichnis mit dem Namen CustomFiles in allen Projekten platziert werden soll, die aus der Vorlage erstellt wurden, verwenden Sie den folgenden XML-Code:

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

Das TargetFileName Attribut kann auch verwendet werden, um Dateien umzubenennen, die internationale Zeichen in ihren Dateinamen enthalten. Eine ZIP-Vorlage kann z. B. keine Dateinamen mit Unicode-Zeichen enthalten, sodass die Datei umbenannt werden muss, bevor sie in eine ZIP-Datei komprimiert werden kann. Das TargetFileName Attribut kann verwendet werden, um den Dateinamen wieder auf den ursprünglichen Unicode-Dateinamen festzulegen.

Das TargetFileName Attribut kann auch verwendet werden, um Dateien mit Parametern umzubenennen. Im folgenden Verfahren wird erläutert, wie Sie die Datei "MyFile.vb" umbenennen, die im Stammverzeichnis der ZIP-Datei der Vorlage vorhanden ist, in einen Dateinamen basierend auf dem Projektnamen.

So benennen Sie Dateien mit Parametern um

  1. Verwenden Sie den folgenden XML-Code in der VSTEMPLATE-Datei :

    <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.

  3. Suchen Sie die Zeile in der Projektdatei, die dem folgenden XML-Code ähnelt:

    <Compile Include="MyFile.vb">

  4. Ersetzen Sie die Codezeile durch den folgenden XML-Code:

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

    Wenn ein Projekt aus dieser Vorlage erstellt wird, basiert der Dateiname auf dem Namen, den der Benutzer im Dialogfeld "Neues Projekt " eingegeben hat, wobei alle unsicheren Zeichen und Leerzeichen entfernt wurden. 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="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>

Siehe auch