RequiredFrameworkVersion element (Visual Studio templates)

  • Article

Applies to: yesVisual Studio noVisual Studio for Mac

Note

This article applies to Visual Studio 2017. 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

Specifies the minimum version of the .NET Framework that is required by the template. It causes the Target Framework Version dropdown to be displayed in the New Project dialog. The RequiredFrameworkVersion element also determines the lowest value available in the dropdown.

Important

Starting in Visual Studio 2017 version 15.6, the Target Framework Version dropdown is no longer a filter for displayed templates in the Templates section of the New Project dialog. Instead, the dropdown functions as a framework picker for the selected template.

<VSTemplate> <TemplateData> <RequiredFrameworkVersion>

Syntax

<RequiredFrameworkVersion> .... </RequiredFrameworkVersion>

Attributes and elements

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

Attributes

None.

Child elements

None.

Parent elements

Element Description
TemplateData Required element.

Categorizes the template and defines how it is displayed in either the New Project or the Add New Item dialog box.

Text value

A text value is required.

The text must be the minimum version number of the .NET Framework that is required for the template.

Remarks

RequiredFrameworkVersion is an optional element. Use this element only if the template supports a specific minimum version (and later versions if any) of the .NET Framework. If you specify the RequiredFrameworkVersion element and your template doesn't support a specific minimum version of the .NET Framework, the Target Framework Version dropdown displays when it is not applicable.

Example

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

<VSTemplate Type="Item" Version="3.0.0"
    xmlns="http://schemas.microsoft.com/developer/vstemplate/2005">
    <TemplateData>
        <Name>MyClass</Name>
        <Description>My custom C# class template.</Description>
        <Icon>Icon.ico</Icon>
        <ProjectType>CSharp</ProjectType>
        <RequiredFrameworkVersion>3.0</RequiredFrameworkVersion>
        <MaxFrameworkVersion>4.7.1</MaxFrameworkVersion>
        <DefaultName>MyClass</DefaultName>
    </TemplateData>
    <TemplateContent>
        <ProjectItem>MyClass.cs</ProjectItem>
    </TemplateContent>
</VSTemplate>

In this example, the minimum version of the .NET Framework that is required by the template, represented by RequiredFrameworkVersion, is 3.0. A project created with this template can target .NET Framework versions starting from 3.0.

See also