BuildProjectOnload element (Visual Studio templates)

Article
01/12/2024

Builds only new projects as you create and add them to a solution. The entire solution isn't built.

Element hierarchy:

<VSTemplate>
  <TemplateData>
    <BuildProjectOnLoad>

Syntax

<BuildProjectOnLoad> true/false </BuildProjectOnLoad>

Attributes and elements

The following sections describe attributes, child elements, and parent elements.

Attributes

None.

Child elements

None.

Parent elements

Element	Description
`TemplateData`	Categorizes the template and defines how it appears in both the New Project and the Add New Item dialog boxes.

Text value

A text value is required.

The text must be either true or false to indicate whether to build only the new project when it's created from the template.

Remarks

BuildProjectOnLoad is an optional element. The default value is false.

Example

The following example illustrates the metadata for a Visual C# template.

<VSTemplate Type="Project" Version="3.0.0"
    xmlns="http://schemas.microsoft.com/developer/vstemplate/2005">
    <TemplateData>
        <Name>My template</Name>
        <Description>A basic template</Description>
        <Icon>TemplateIcon.ico</Icon>
        <ProjectType>CSharp</ProjectType>
        <BuildProjectOnload>true</BuildProjectOnLoad>
    </TemplateData>
    <TemplateContent>
        <Project File="MyTemplate.csproj">
            <ProjectItem>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>

Share via