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

Artykuł
10/10/2023

Określa plik dołączony do szablonu projektu.

Uwaga

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

Składnia

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

Atrybuty i elementy

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

Atrybuty

Atrybut	opis
`TargetFileName`	Atrybut opcjonalny. Określa nazwę i ścieżkę elementu projektu podczas tworzenia projektu na podstawie szablonu. Ten atrybut jest przydatny do tworzenia struktury katalogów innej niż struktura katalogów w pliku zip szablonu lub przy użyciu zastępowania parametrów w celu utworzenia nazwy elementu.
`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`.
`OpenInEditor`	Atrybut opcjonalny. Wartość logiczna określająca, czy element powinien być otwarty w odpowiednim edytorze w programie Visual Studio podczas tworzenia projektu na podstawie szablonu. Atrybuty `OpenInWebBrowser` i `OpenInHelpBrowser` są ignorowane w elemencie o wartości .`trueOpenInEditor` Domyślna wartość to `false`.
`OpenInWebBrowser`	Atrybut opcjonalny. Wartość logiczna określająca, czy element powinien zostać otwarty w przeglądarce sieci Web podczas tworzenia projektu na podstawie szablonu. W przeglądarce sieci Web można otwierać tylko pliki HTML i pliki tekstowe, które są lokalne dla projektu. Nie można otworzyć zewnętrznych adresów URL za pomocą tego atrybutu. Domyślna wartość to `false`.
`OpenInHelpBrowser`	Atrybut opcjonalny. Wartość logiczna określająca, czy element powinien być otwarty w podglądzie Pomocy podczas tworzenia projektu na podstawie szablonu. W przeglądarce Pomocy można otwierać tylko pliki HTML i pliki tekstowe, które są lokalne dla projektu. Nie można otworzyć zewnętrznych adresów URL za pomocą tego atrybutu. Domyślna wartość to `false`.
`OpenOrder`	Atrybut opcjonalny. Określa wartość liczbową reprezentującą kolejność otwierania elementów w odpowiednich edytorach. Wszystkie wartości muszą być wielokrotnościami 10. Elementy z wyższymi `OpenOrder` wartościami są najpierw otwierane.

Elementy podrzędne

Brak.

Elementy nadrzędne

Element	opis
Projekt	Określa pliki lub katalogi, które mają zostać dodane do projektu.

Wartość tekstowa

Wartość tekstowa jest wymagana.

Element string reprezentujący nazwę lub ścieżkę do pliku w pliku zip szablonu.

Uwagi

ProjectItemjest opcjonalnym elementem podrzędnym .Project

Atrybut TargetFileName może służyć do tworzenia struktury katalogów innej niż struktura katalogów w pliku zip szablonu. Jeśli na przykład plik MyFile.vb istnieje w katalogu głównym pliku zip szablonu, ale chcesz, aby plik został umieszczony w katalogu o nazwie CustomFiles we wszystkich projektach utworzonych na podstawie szablonu, należy użyć następującego kodu XML:

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

Atrybut TargetFileName może również służyć do zmieniania nazw plików, które zawierają znaki międzynarodowe w nazwach plików. Na przykład plik zip szablonu nie może zawierać nazw plików ze znakami Unicode, więc należy zmienić nazwę pliku, zanim będzie można go skompresować do pliku zip. Za TargetFileName pomocą atrybutu można ustawić nazwę pliku z powrotem na oryginalną nazwę pliku Unicode.

Atrybut TargetFileName może również służyć do zmieniania nazw plików z parametrami. W poniższej procedurze wyjaśniono, jak zmienić nazwę pliku MyFile.vb, który istnieje w katalogu głównym pliku zip szablonu, na nazwę pliku na podstawie nazwy projektu.

Aby zmienić nazwy plików przy użyciu parametrów

Użyj następującego kodu XML w pliku vstemplate :

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

Otwórz plik projektu (vbproj dla projektu Visual Basic) w edytorze tekstów lub programie Visual Studio.
Znajdź wiersz w pliku projektu, który wygląda podobnie do następującego kodu XML:
```
<Compile Include="MyFile.vb">
```
Zastąp wiersz kodu następującym kodem XML:
```
<Compile Include="$safeprojectname$.vb">
```
Po utworzeniu projektu na podstawie tego szablonu nazwa pliku będzie oparta na nazwie wprowadzonej przez użytkownika w oknie dialogowym Nowy projekt ze wszystkimi niebezpiecznymi znakami i spacjami. Aby uzyskać więcej informacji, zobacz Parametry szablonu.

Przykład

Poniższy przykład przedstawia metadane szablonu projektu dla aplikacji Visual C#.

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

Udostępnij za pośrednictwem