Skip to content

Latest commit

 

History

History
81 lines (63 loc) · 2.73 KB

defaultname-element-visual-studio-templates.md

File metadata and controls

81 lines (63 loc) · 2.73 KB
Raw
title description ms.date ms.subservice ms.topic f1_keywords helpviewer_keywords author ms.author manager
DefaultName Element (Visual Studio Templates)
Learn about the DefaultName element and how it specifies the name that the Visual Studio project system will generate for the project or item when it is created.
11/04/2016
general-ide
reference
DefaultName element [Visual Studio project templates]
maiak
maiak
mijacobs

DefaultName element (Visual Studio templates)

Specifies the name that the Visual Studio project system will generate for the project or item when it is created.

<VSTemplate> <TemplateData> <DefaultName>

Syntax

<DefaultName>
    Default Project Name
</DefaultName>

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 displays in either the New Project or the Add New Item dialog box.

Text value

A text value is required.

This text specifies the default name of the project or item.

Remarks

DefaultName is an optional element.

For projects, this element specifies the name of the directory that stores the project on disk. For items, it specifies the file name of the source file.

When you create a project or item, you can modify the default name using the Name option, which is available from either the New Project dialog box or Add New Item dialog box.

If you do not want the project system to generate the default name for the project or item, then set the ProvideDefaultName element to False.

Example

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

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

See also