BuildProjectOnload Element (Visual Studio Templates)

  • Article

Note

This article applies to Visual Studio 2015. If you're looking for the latest Visual Studio documentation, see Visual Studio documentation. We recommend upgrading to the latest version of Visual Studio. Download it here

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

<VSTemplate>
<TemplateData>
<BuildProjectOnLoad>

Syntax

<BuildProjectOnLoad> true/false </BuildOnLoad>

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="https://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>

See Also

Creating Project and Item Templates
Visual Studio Template Schema Reference