Solution4.GetProjectItemTemplate(String, String) Method

Reference

Definition

Namespace:: EnvDTE100

Assembly:: EnvDTE100.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.11.40262

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Returns a path to the indicated project item template.

public:
 System::String ^ GetProjectItemTemplate(System::String ^ TemplateName, System::String ^ Language);

public:
 Platform::String ^ GetProjectItemTemplate(Platform::String ^ TemplateName, Platform::String ^ Language);

std::wstring GetProjectItemTemplate(std::wstring const & TemplateName, std::wstring const & Language);

[System.Runtime.InteropServices.DispId(104)]
public string GetProjectItemTemplate (string TemplateName, string Language);

[<System.Runtime.InteropServices.DispId(104)>]
abstract member GetProjectItemTemplate : string * string -> string

Public Function GetProjectItemTemplate (TemplateName As String, Language As String) As String

Parameters

TemplateName: String

The name of the template.

Language: String

The language used to write the template.

Returns

String

The full name of the project item template.

Implements

GetProjectItemTemplate(String, String)

Attributes: DispIdAttribute

Examples

Sub SaveAsExample(ByVal dte As DTE2)  
    ' Add an HTML page to a solution.  
    ' Open a Visual Basic solution in Visual Studio before running this example.  

    Dim soln As Solution4 = _  
    CType(_applicationObject.Solution, Solution4)  
    Dim prj As Project  
    Dim prjItem As ProjectItem  
    Dim itemPath As String  

    Try  
        prj = soln.Projects.Item(1)  
        itemPath = soln.GetProjectItemTemplate("HTMLPage.zip", _  
        "VisualBasic")  
        ' Create a new project item based on the template.   
        ' (In this case, an HTML page.)  
        prjItem =  _  
        prj.ProjectItems.AddFromTemplate(itemPath, "MyNewHtml")  

    Catch ex As SystemException  
        MsgBox("ERROR: " & ex.ToString())  
    End Try  
End Sub

using System.Windows.Forms;  
public void SolnGetProjetItemExample(DTE2 dte)  
{  
    // Add an item to a Visual Basic solution.  
    // Open a Visual Basic solution in Visual Studio   
    // before running this example.  

    Solution4 soln = (Solution4)_applicationObject.Solution;  
    Project prj;  
    ProjectItem prjItem;  
    string itemPath;  
    try  
    {  

        prj = soln.Projects.Item(1);  
        itemPath =   
          soln.GetProjectItemTemplate("HTMLPage.zip", "VisualBasic");  
        // Create a new project item based on the template.   
        // (In this case, an HTML page.)  
        prjItem =   
prj.ProjectItems.AddFromTemplate(itemPath, "MyNewHtml");  

    }  
    catch (SystemException ex)  
    {  
        MessageBox.Show("ERROR: " + ex);  
    }  
}

Remarks

Project templates are stored as zip files. This method asks for the project by name and language and returns the path to the template.

The parameters of GetProjectItemTemplate can be supplied in a number of different ways as shown below:

Pass in the GUID for a Smart Device Visual Basic Virtual Project as the Language parameter, and the name of the zip file as the TemplateName.
```
GetProjectItemTemplate("NETCFv2-Class.zip", "{3114F5B0-E435-4bc5-A03D-168E20D9BF83}");  
```
Pass in the GUID for a Smart Device Visual Basic Virtual Project as the Language parameter, and the "Class" string as the TemplateName. The string "Class" is derived from the folder hierarchy and is referred to as the user interface (UI) string. Other UI strings are "HTML Page" and "Splash Screen". The UI strings are locale dependent. Using the name of the zip file is the safest way to pass the TemplateName parameter.
```
GetProjectItemTemplate("Class", "{3114F5B0-E435-4bc5-A03D-168E20D9BF83}");  
```
Pass in the string "VisualBasic" as the Language parameter, and the name of the zip file for the TemplateName parameter. This works because NETCFv2-Class.zip is unique to Smart Devices.
```
GetProjectItemTemplate("NETCFv2-Class.zip", "VisualBasic/SmartDevice-NETCFv2");  
```

You can also create custom templates for project items. To specify the directory in which you will store your templates, click Options on the Tools menu. On the left pane of the Options dialog box, click Projects and Solutions. Type the paths for your templates in the Visual Studio user item templates location boxes. Alternatively, you can accept the default location.

Custom templates require unique file names that do not conflict with the file names defined in:

<drive>:\Program Files\Microsoft Visual Studio 9\Common7\IDE\ItemTemplates\Language.

Ensure that you use long file names (as opposed to 8dot3). For more information, see NIB: Creating Project and Item Templates.

Applies to

Share via