Solution3.GetProjectTemplate メソッド (String, String)

[アーティクル]
08/09/2011

指定されたプロジェクトテンプレートのパスを返します。

名前空間: EnvDTE90
アセンブリ: EnvDTE90 (EnvDTE90.dll 内)

構文

'宣言
Function GetProjectTemplate ( _
    TemplateName As String, _
    Language As String _
) As String

string GetProjectTemplate(
    string TemplateName,
    string Language
)

String^ GetProjectTemplate(
    String^ TemplateName, 
    String^ Language
)

abstract GetProjectTemplate : 
        TemplateName:string * 
        Language:string -> string

function GetProjectTemplate(
    TemplateName : String, 
    Language : String
) : String

パラメーター

TemplateName
型: System.String
テンプレートの名前。

Language
型: System.String
テンプレートの書き込みに使用されている言語。

戻り値

型: System.String
プロジェクトテンプレートの完全名。

実装

Solution2.GetProjectTemplate(String, String)

解説

プロジェクトテンプレートは、zip ファイルとして格納されます。このメソッドは、名前と言語でプロジェクトを要求し、テンプレートのパスを返します。

GetProjectTemplate のパラメーターは、次のようなさまざまな方法で指定できます。

"CSharp" を Language パラメーターとして、zip ファイルの名前を TemplateName パラメーターとして渡します。
```
GetProjectTemplate("PocketPC2003-ClassLibrary.zip", "CSharp");
```
"CSharp" を Language パラメーターとして渡し、部分ファイルパス "PocketPC2003\ClassLibrary.vstemplate" も渡して、一意の TemplateName を指定します。
```
GetProjectTemplate("PocketPC2003\ClassLibrary.vstemplate", "CSharp");//partial file path
```
文字列 "CSharp" を Language パラメーターとして、文字列 "Pocket PC 2003 Class Library" を TemplateName パラメーターとして渡します。文字列 "Pocket PC 2003 Class Library" はフォルダー階層から派生し、ユーザーインターフェイス (UI) 文字列と呼ばれています。その他の UI 文字列の例としては、"Console Application" と "Windows Application" があります。

注意

UI 文字列は、ロケールによって異なります。 zip ファイルを使用すると、最も安全に TemplateName パラメーターを渡すことができます。
```
GetProjectTemplate("Pocket PC 2003 Class Library", "CSharp");
```
文字列 "CSharp" を Language パラメーターとして、文字列 "PocketPC2003\Pocket PC 2003 Class Library" を TemplateName パラメーターとして渡します。これには、テンプレートを一意に指定する UI 文字列と部分パスが含まれます。
```
GetProjectTemplate("PocketPC2003\Pocket PC 2003 Class Library", "CSharp");
```

カスタムのプロジェクトテンプレートを独自に作成することもできます。テンプレートを格納するディレクトリを指定するには、[ツール] メニューの [オプション] をクリックします。 [オプション] ダイアログボックスの左ペインで、[プロジェクトおよびソリューション] をクリックします。テンプレートのパスを [Visual Studio ユーザープロジェクトテンプレートの場所] ボックスに入力します。または、既定の場所を使用できます。

カスタムテンプレートには、次の場所で定義されたファイル名と競合しない一意のファイル名が必要です。

<drive>:\Program Files\Microsoft Visual Studio 8\Common7\IDE\ProjectTemplates\Language

8dot3 形式ではなく長いファイル名を使用するようにします。詳細については、「プロジェクトと項目テンプレートの作成」を参照してください。

例

このアドインコードの実行方法については、「方法 : オートメーションオブジェクトモデルのコード例をコンパイルおよび実行する」を参照してください。

Public Sub OnConnection(ByVal application As Object, _
 ByVal connectMode As ext_ConnectMode, ByVal addInInst As Object, _
 ByRef custom As Array) Implements IDTExtensibility2.OnConnection
    _applicationObject = CType(application, DTE2)
    _addInInstance = CType(addInInst, AddIn)
    SolutionExample(_applicationObject)
End Sub

Sub SolutionExample(ByVal dte As DTE2)
    ' This function creates a solution and adds a Visual C# Console
    ' project to it.
    Try
        Dim soln As Solution3 = CType(DTE.Solution, Solution3)
        Dim csTemplatePath As String
        ' This path must exist on your computer.
        ' Replace <file path> below with an actual path.
        Dim csPrjPath As String = "<file path>"
        MsgBox("starting")
        ' Get the project template path for a C# console project.
        csTemplatePath = soln.GetProjectTemplate _
        ("ConsoleApplication.zip", "CSharp")
        ' Create a new C# Console project using the template obtained 
        ' above.
        soln.AddFromTemplate(csTemplatePath, csPrjPath, _
        "New CSharp Console Project", False)
        MsgBox("done")
    Catch ex As System.Exception
        MsgBox(ex.ToString)
    End Try
End Sub

using System.Windows.Forms;
public void OnConnection(object application,
 Extensibility.ext_ConnectMode connectMode, object addInInst,
 ref System.Array custom)
{
    _applicationObject = (DTE2)application;
    _addInInstance = (AddIn)addInInst;
    // Pass the applicationObject member variable to the code example.
    SolutionExample((DTE2)_applicationObject);
}

public void SolutionExample(DTE2 dte)
{
    // This function creates a solution and adds a Visual C# Console
    // project to it.
    try{
        Solution3 soln = (Solution3)_applicationObject.Solution;
        String csTemplatePath;
        // The file path must exist on your computer.
        // Replace <file path> below with an actual path.
        String csPrjPath = "<file path>";
        "<file path>MessageBox.Show("Starting...");
        "<file path>"<file path>csTemplatePath = 
          soln.GetProjectTemplate("ConsoleApplication.zip", "CSharp");
        // Create a new C# Console project using the template obtained 
        // above.
        soln.AddFromTemplate(csTemplatePath, csPrjPath,
          "New CSharp Console Project", false);
        MessageBox.Show("Done!");
    }
    catch(SystemException ex)
    {
        MessageBox.Show("ERROR: " + ex);
    }
}