Skip to content

icon-element-visual-studio-templates.md

Latest commit

 

History

History
91 lines (73 loc) · 3.02 KB

icon-element-visual-studio-templates.md

File metadata and controls

91 lines (73 loc) · 3.02 KB
Raw
title Icon Element (Visual Studio Templates)
description Learn about the Icon element and how it specifies the path and the filename of the image file that serves as the icon.
ms.date 11/04/2016
ms.subservice general-ide
ms.topic reference
f1_keywords
helpviewer_keywords
Icon element [Visual Studio project templates]
author tinaschrepfer
ms.author tinali

Icon element (Visual Studio templates)

Specifies the path and the filename of the image file that serves as the icon, which appears in either the New Project or the Add New Item dialog box, for the template.

<VSTemplate> <TemplateData> <Icon>

Syntax

<Icon>
    IconFileName
</Icon>

<Icon Package="{PackageID}" ID="ResourceID" />

Attributes and elements

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

Attributes

Attribute Description
Package Optional attribute, for advanced user scenarios.

A GUID that specifies the Visual Studio package ID.
ID Optional attribute, for advanced user scenarios.

Specifies the Visual Studio resource ID.

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 unless the Package and ID attributes are used.

The text provides the path and file name of the template icon that will appear in the New Project dialog box.

Remarks

Icon is a required child element of TemplateData.

Example

The following example shows the metadata for a project template for a Visual C# application.

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