Solution2.GetProjectItemTemplate メソッド

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

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

構文

'宣言
Function GetProjectItemTemplate ( _
    TemplateName As String, _
    Language As String _
) As String
string GetProjectItemTemplate(
    string TemplateName,
    string Language
)
String^ GetProjectItemTemplate(
    String^ TemplateName, 
    String^ Language
)
abstract GetProjectItemTemplate : 
        TemplateName:string * 
        Language:string -> string
function GetProjectItemTemplate(
    TemplateName : String, 
    Language : String
) : String

パラメーター

  • TemplateName
    型 : String

    テンプレートの名前。

  • Language
    型 : String

    テンプレートの書き込みに使用されている言語。

戻り値

型 : String
プロジェクト項目テンプレートの完全名を返します。

解説

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

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

  • スマート デバイス Visual Basic 仮想プロジェクトの GUID を Language パラメーターとして、zip ファイルの名前を TemplateName パラメーターとして渡します。

    GetProjectItemTemplate("NETCFv2-Class.zip", "{3114F5B0-E435-4bc5-A03D-168E20D9BF83}");
    
  • スマート デバイス Visual Basic 仮想プロジェクトの GUID を Language パラメーターとして、文字列 "Class" を TemplateName パラメーターとして渡します。 文字列 "Class" はフォルダー階層から派生し、ユーザー インターフェイス (UI) 文字列と呼ばれています。 その他の UI 文字列には、"HTML Page" と "Splash Screen" があります。 UI 文字列は、ロケールに依存します。 zip ファイルを使用すると、最も安全に TemplateName パラメーターを渡すことができます。

    GetProjectItemTemplate("Class", "{3114F5B0-E435-4bc5-A03D-168E20D9BF83}");
    
  • 文字列 "VisualBasic" を Language パラメーターとして、zip ファイルの名前を TemplateName パラメーターとして渡します。 NETCFv2-Class.zip はスマート デバイスに対して一意であるため、この操作は有効です。

    GetProjectItemTemplate("NETCFv2-Class.zip", "VisualBasic/SmartDevice-NETCFv2");
    

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

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

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

8dot3 形式ではなく長いファイル名を使用するようにします。 詳細については、「Creating Project and Item Templates」を参照してください。

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

HTML ページをソリューションに追加する例を次に示します。

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)
    SaveAsExample(_applicationObject)
End Sub

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

    Dim soln As Solution2 = _
    CType(_applicationObject.Solution, Solution2)
    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 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.
    SolnGetProjetItemExample((DTE2)_applicationObject);
}
public void SolnGetProjetItemExample(DTE2 dte)
{
    // This add-in adds an item to a Visual Basic solution.
    // Open a Visual Basic solution in Visual Studio 
    // before running this example.
 
    Solution2 soln = (Solution2)_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);
    }
}

.NET Framework セキュリティ

  • 直前の呼び出し元に対する完全な信頼。このメンバーは、部分的に信頼されているコードから使用することはできません。詳細については、「部分信頼コードからのライブラリの使用」を参照してください。

参照

関連項目

Solution2 インターフェイス

EnvDTE80 名前空間