ProjectItem-Element (Visual Studio-Elementvorlagen)

Gibt eine Datei an, die in der Elementvorlage 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 Elementvorlagen erläutert. Eine Erläuterung des ProjectItem-Elements für Projektvorlagen finden Sie unter ProjectItem-Element (Visual Studio-Projektvorlagen).

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

Attribute und Elemente

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

Attribute

Attribut	Beschreibung
SubType	Optionales Attribut. Gibt den Untertyp eines Elements in einer Elementvorlage mit mehreren Dateien an. Durch diesen Wert wird der Editor angegeben, mit dem Visual Studio das Element öffnet.
CustomTool	Optionales Attribut. Legt das CustomTool für das Element in der Projektdatei fest.
ItemType	Optionales Attribut. Legt den ItemType für das Element in der Projektdatei fest.
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.
TargetFileName	Optionales Attribut. Gibt den Namen des Elements an, das von der Vorlage erstellt wird. Dieses Attribut ist hilfreich, wenn ein Elementname mittels Parameterersetzung erstellt werden soll.

Untergeordnete Elemente

Keine.

Übergeordnete Elemente

Element	Beschreibung
TemplateContent	Gibt den Inhalt der Vorlage an.

Textwert

Ein Textwert ist erforderlich.

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

Hinweise

ProjectItem ist ein optionales untergeordnetes Element von TemplateContent.

Das TargetFileName-Attribut kann zum Umbenennen von Dateien mit Parametern verwendet werden. Wenn die Datei MyFile.vb im Stammverzeichnis der ZIP-Datei der Vorlage vorhanden ist, sie jedoch nach dem Dateinamen benannt werden soll, der vom Benutzer im Dialogfeld Neues Element hinzufügen eingegeben wurde, würden Sie beispielsweise folgenden XML-Code verwenden:

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

Wenn ein Element auf der Grundlage dieser Vorlage erstellt wird, entspricht der Dateiname dem Namen, den der Benutzer im Dialogfeld Neues Element hinzufügen eingegeben hat. Dies ist hilfreich, wenn Elementvorlagen mit mehreren Dateien erstellt werden. Weitere Informationen finden Sie unter Gewusst wie: Erstellen von Elementvorlagen mit mehreren Dateien und Vorlagenparameter.

Beispiel

Im folgenden Beispiel werden die Metadaten für die Standardelementvorlage einer Klasse in Visual C# veranschaulicht.

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

Siehe auch

Aufgaben

Gewusst wie: Erstellen von Elementvorlagen mit mehreren Dateien

Referenz

Schemareferenz zu Visual Studio-Vorlagen

Konzepte

Vorlagenparameter

Weitere Ressourcen

Visual Studio-Vorlagen