ProjectItem-Element (Visual Studio-Projektelementvorlagen)

Artikel
01/13/2024

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

Syntax

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

Attribute

Attribut	Beschreibung
`SubType`	Optionales Attribut. Gibt den Untertyp eines Elements in einer Mehrdateielementvorlage an. Dieser Wert wird verwendet, um den Editor zu bestimmen, den Visual Studio zum Öffnen des Elements verwendet.
`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, der angibt, ob das Element Parameterwerte enthält, die ersetzt werden müssen, wenn ein Projekt aus der Vorlage erstellt wird. Der Standardwert ist `false`sein.
`TargetFileName`	Optionales Attribut. Gibt den Namen des Elements an, das aus der Vorlage erstellt wird. Dieses Attribut ist nützlich für die Verwendung des Parameterersetzungs zum Erstellen eines Elementnamens.

Untergeordnete Elemente

Keine

Übergeordnete Elemente

Element	Beschreibung
Templatecontent	Gibt den Inhalt der Vorlage an.

Text Wert

Ein Textwert ist erforderlich.

A string that represents the name of a file in the template .zip file.

Hinweise

ProjectItem ist ein optionales untergeordnetes Element von TemplateContent.

Das TargetFileName Attribut kann verwendet werden, um Dateien mit Parametern umzubenennen. Wenn die Datei "MyFile.vb" beispielsweise im Stammverzeichnis der ZIP-Datei der Vorlage vorhanden ist, die Datei jedoch basierend auf dem vom Benutzer im Dialogfeld "Neues Element hinzufügen" bereitgestellten Dateinamen benannt werden soll, verwenden Sie die folgende XML-Datei:

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

Wenn ein Element aus dieser Vorlage erstellt wird, basiert der Dateiname auf dem Namen, den der Benutzer im Dialogfeld "Neues Element hinzufügen" eingegeben hat. Dies ist hilfreich beim Erstellen von Vorlagen mit mehreren Dateien. Weitere Informationen finden Sie unter How to: Create multi-file item templates and Template parameters.

Beispiel

Das folgende Beispiel veranschaulicht die Metadaten für die Standardelementvorlage für eine Visual C#-Klasse.

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

Freigeben über