LocationField Element (Visual Studio Project Templates)

  • Article

Specifies whether or not the Location text box in the New Project dialog box is enabled, disabled, or hidden for the project template.

<VSTemplate>
   <TemplateData>
     <LocationField>

<LocationField> Enabled/Disabled/Hidden </LocationField>

Attributes and Elements

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

Attributes

None.

Child Elements

None.

Parent Elements

Element

Description

TemplateData

Required element.

Categorizes the template and defines how it displays in either the New Project.

Text Value

A text value is required.

Valid text values are:

  • Enabled, which specifies that the Location box of the New Project dialog box is enabled.

  • Disabled, which specifies that the Location box of the New Project dialog box is disabled.

  • Hidden, which specifies that the Location box of the New Project dialog box is hidden.

Remarks

The default value is Enabled.

The Location text box in the New Project dialog box enables users to change the default directory in which new projects are saved.

The value specified in the Location element is only honored by the dialog box if the underlying project system supports it.

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>
        <LocationField>Disabled</LocationField>
    </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

Reference

Visual Studio Template Schema Reference

Concepts

Creating Templates for Projects and Items in Visual Studio