ProjectItem, element (szablony elementów programu Visual Studio)

Artykuł
01/13/2024

Określa plik uwzględniony w szablonie elementu.

Uwaga

Element ProjectItem akceptuje różne atrybuty w zależności od tego, czy szablon jest przeznaczony dla projektu, czy elementu. W tym temacie ProjectItem opisano element elementu . Aby uzyskać wyjaśnienie ProjectItem elementu szablonów projektów, zobacz ProjectItem, element (szablony projektów programu Visual Studio).

Składnia

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

Atrybuty i elementy

W poniższych sekcjach opisano atrybut, elementy podrzędne i elementy nadrzędne.

Atrybuty

Atrybut	opis
`SubType`	Atrybut opcjonalny. Określa podtyp elementu w szablonie elementu z wieloma plikami. Ta wartość służy do określania edytora, którego program Visual Studio użyje do otwarcia elementu.
`CustomTool`	Atrybut opcjonalny. Ustawia element CustomTool dla elementu w pliku projektu.
`ItemType`	Atrybut opcjonalny. Ustawia element ItemType dla elementu w pliku projektu.
`ReplaceParameters`	Atrybut opcjonalny. Wartość logiczna określająca, czy element ma wartości parametrów, które należy zamienić podczas tworzenia projektu na podstawie szablonu. Wartość domyślna to `false`.
`TargetFileName`	Atrybut opcjonalny. Określa nazwę elementu utworzonego na podstawie szablonu. Ten atrybut jest przydatny do używania zamiany parametrów w celu utworzenia nazwy elementu.

Elementy podrzędne

Brak.

Elementy nadrzędne

Element	opis
Templatecontent	Określa zawartość szablonu.

Wartość tekstowa

Wartość tekstowa jest wymagana.

Element string reprezentujący nazwę pliku w pliku zip szablonu.

Uwagi

ProjectItemjest opcjonalnym elementem podrzędnym .TemplateContent

Atrybut TargetFileName może służyć do zmieniania nazw plików za pomocą parametrów. Jeśli na przykład plik MyFile.vb istnieje w katalogu głównym pliku zip szablonu, ale chcesz, aby plik został nazwany na podstawie nazwy pliku podanej przez użytkownika w oknie dialogowym Dodawanie nowego elementu, należy użyć następującego kodu XML:

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

Po utworzeniu elementu na podstawie tego szablonu nazwa pliku będzie oparta na nazwie wprowadzonej przez użytkownika w oknie dialogowym Dodawanie nowego elementu . Jest to przydatne podczas tworzenia szablonów elementów z wieloma plikami. Aby uzyskać więcej informacji, zobacz How to: Create multi-file item templates and Template parameters (Instrukcje: tworzenie szablonów elementów z wieloma plikami ) i Template parameters (Parametry szablonu).

Przykład

Poniższy przykład ilustruje metadane szablonu elementu standardowego dla klasy Visual C#.

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

Share via