WizardData Element (Visual Studio Templates)

Note

This article applies to Visual Studio 2015. If you're looking for the latest Visual Studio documentation, use the version selector at the top left. We recommend upgrading to Visual Studio 2019. Download it here

Specifies custom XML

<VSTemplate>
<WizardData>

Syntax

<WizardData>  
    <!-- XML to pass to the custom wizard extension -->  
    ...  
</WizardData>  

Attributes and Elements

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

Attributes

None.

Child Elements

None.

Parent Elements

Element Description
VSTemplate Required element.

Contains all the metadata for the project template, item template, or starter kit.

Text Value

A text value is optional.

This text specifies the custom XML to pass to the custom wizard extension specified in the WizardExtension element.

Remarks

Any XML can be specified in this element. The XML will be passed as a parameter to the custom wizard extension, allowing the extension to use the contents of this element. No validation is done on this data.

The contents of the WizardData element are passed, unchanged, as a parameter inside the string dictionary of parameters in the IWizard.RunStarted method. The parameter is named $WizardData$.

Example

The following example illustrates the metadata for the standard project template for a Visual C# Windows application.

<VSTemplate Version="3.0.0" Type="Item"  
    xmlns="http://schemas.microsoft.com/developer/vstemplate/2005">  
    <TemplateData>  
        <Name>MyTemplate</Name>  
        <Description>Template using IWizard extension</Description>  
        <Icon>TemplateIcon.ico</Icon>  
        <ProjectType>CSharp</ProjectType>  
    </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>  
    <WizardExtension>  
        <Assembly>MyWizard, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a, Custom=null</Assembly>  
        <FullClassName>MyWizard.CustomWizard</FullClassName>  
    </WizardExtension>  
    <WizardData>  
        <!-- XML to pass to the custom wizard extension -->  
    </WizardData>  
</VSTemplate>  

See Also

Visual Studio Template Schema Reference
Creating Project and Item Templates
WizardExtension Element (Visual Studio Templates)
How to: Use Wizards with Project Templates