基本的なプロジェクトシステムの作成、パート 2

[アーティクル]
03/10/2023

このシリーズの最初のチュートリアルである「基本的なプロジェクトシステムの作成、パート 1」では、基本的なプロジェクトシステムを作成する方法を説明しています。このチュートリアルでは、基本的なプロジェクトシステムを基に、Visual Studio テンプレート、プロパティページ、およびその他の機能を追加します。このチュートリアルを開始する前に、最初のチュートリアルを完了する必要があります。

このチュートリアルでは、プロジェクトファイル名拡張子が .myproj であるプロジェクトタイプを作成する方法を説明します。このチュートリアルでは、既存の Visual C# プロジェクトシステムの例を使用するため、チュートリアルを完了するために独自の言語を作成する必要はありません。

このチュートリアルでは、次のタスクを実行する方法を説明します。

Visual Studio テンプレートを作成します。
Visual Studio テンプレートをデプロイします。
[新しいプロジェクト] ダイアログボックスで、プロジェクトタイプの子ノードを作成します。
Visual Studio テンプレートでパラメーターの置換を有効にします。
プロジェクトのプロパティページを作成します。

Note

このチュートリアルの手順は、C# プロジェクトに基づいています。ただし、ファイル名拡張子やコードなどの詳細情報を除き、Visual Basic プロジェクトでも同じ手順を使用できます。

Visual Studio テンプレートを作成する

「基本的なプロジェクトシステムの作成、パート 1」では、基本的なプロジェクトテンプレートを作成し、プロジェクトシステムに追加する方法を説明しています。また、ProvideProjectFactoryAttribute 属性を使用してこのテンプレートを Visual Studio に登録する方法についても説明しています。これにより、\Templates\Projects\SimpleProject\ フォルダーの完全なパスがシステムレジストリに書き込まれます。

基本的なプロジェクトテンプレートの代わりに Visual Studio テンプレート (.vstemplate ファイル) を使用すると、[新しいプロジェクト] ダイアログボックスでのテンプレートの表示方法と、テンプレートパラメーターの置換方法を制御できます。 .vstemplate ファイルは、プロジェクトシステムテンプレートを使用してプロジェクトを作成するときに、ソースファイルがどのようにインクルードされるかを記述する XML ファイルです。プロジェクトシステム自体は、.vstemplate ファイルとソースファイルを .zip ファイルに収集することによって作成され、その .zip ファイルを Visual Studio が認識する場所にコピーすることによってデプロイされます。このプロセスは、このチュートリアルの後半で詳しく説明します。

Visual Studio で、「基本的なプロジェクトシステムの作成、パート 1」に従って作成した SimpleProject ソリューションを開きます。
SimpleProjectPackage.cs ファイルで、ProvideProjectFactory 属性を見つけます。次のように、2 番目のパラメーター (プロジェクト名) を null に、4 番目のパラメーター (プロジェクトテンプレートフォルダーのパス) を ".\\NullPath" に置き換えます。
```
[ProvideProjectFactory(typeof(SimpleProjectFactory), null,
    "Simple Project Files (*.myproj);*.myproj", "myproj", "myproj",
    ".\\NullPath",
LanguageVsTemplate = "SimpleProject")]
```
\Templates\Projects\SimpleProject\ フォルダーに、SimpleProject.vstemplate という名前の XML ファイルを追加します。

SimpleProject.vstemplate の内容を、次のコードに置き換えます。

<VSTemplate Version="2.0.0" Type="Project"
    xmlns="http://schemas.microsoft.com/developer/vstemplate/2005">
  <TemplateData>
    <Name>SimpleProject Application</Name>
    <Description>
      A project for creating a SimpleProject application
    </Description>
    <Icon>SimpleProject.ico</Icon>
    <ProjectType>SimpleProject</ProjectType>
  </TemplateData>
  <TemplateContent>
    <Project File="SimpleProject.myproj" ReplaceParameters="true">
      <ProjectItem ReplaceParameters="true" OpenInEditor="true">
        Program.cs
      </ProjectItem>
      <ProjectItem ReplaceParameters="true" OpenInEditor="false">
        AssemblyInfo.cs
      </ProjectItem>
    </Project>
  </TemplateContent>
</VSTemplate>

[プロパティ] ウィンドウで、\Templates\Projects\SimpleProject\ フォルダー内の 5 つのファイルをすべて選択し、[ビルドアクション] を [ZipProject] に設定します。

<TemplateData> セクションでは、次のように、[新しいプロジェクト] ダイアログボックスでの SimpleProject プロジェクトタイプの場所と外観を決定します。

<Name> 要素では、SimpleProject アプリケーションとなるプロジェクトテンプレートの名前を指定します。
<Description> 要素には、プロジェクトテンプレートを選択したときに [新しいプロジェクト] ダイアログボックスに表示される説明が格納されます。
<Icon> 要素では、SimpleProject プロジェクトタイプと共に表示されるアイコンを指定します。
<ProjectType> 要素では、[新しいプロジェクト] ダイアログボックスのプロジェクトタイプの名前を指定します。 ProvideProjectFactory 属性のプロジェクト名パラメーターはこの名前に置き換えられます。

Note

<ProjectType> 要素は、SimpleProjectPackage.cs ファイルの ProvideProjectFactory 属性の LanguageVsTemplate 引数と一致する必要があります。

<TemplateContent> セクションでは、新しいプロジェクトの作成時に生成される次のファイルについて記述します。
SimpleProject.myproj
Program.cs
AssemblyInfo.cs

3 つのファイルすべてで ReplaceParameters が true に設定されています。これにより、パラメーターの置換が有効になります。 Program.cs ファイルでは OpenInEditor が true に設定されています。これにより、プロジェクトの作成時にファイルがコードエディターで開かれます。

Visual Studio テンプレートスキーマの要素の詳細については、「Visual Studio テンプレートスキーマ参照」を参照してください。

Note

プロジェクトに複数の Visual Studio テンプレートがある場合は、すべてのテンプレートが個別のフォルダーに配置されます。そのフォルダー内のすべてのファイルで、[ビルドアクション] が [ZipProject] に設定されている必要があります。

最小限の .vsct ファイルを追加する

新規または変更された Visual Studio テンプレートを認識するには、Visual Studio をセットアップモードで実行する必要があります。セットアップモードでは、.vsct ファイルが存在している必要があります。そのため、プロジェクトに最小限の .vsct ファイルを追加する必要があります。

SimpleProject.vsct という名前の XML ファイルを SimpleProject プロジェクトに追加します。

SimpleProject.vsct ファイルの内容を次のコードに置き換えます。

<?xml version="1.0" encoding="utf-8" ?>
<CommandTable
  xmlns="http://schemas.microsoft.com/VisualStudio/2005-10-18/CommandTable">
</CommandTable>

このファイルの [ビルドアクション] を [VSCTCompile] に設定します。これは、.csproj ファイルでのみ実行でき、[プロパティ] ウィンドウでは実行できません。この時点で、このファイルの [ビルドアクション] が [なし] に設定されていることを確認します。
1. SimpleProject ノードを右クリックし、[SimpleProject.csproj の編集] をクリックします。
2. .csproj ファイルで、SimpleProject.vsct の項目を見つけます。
```
<None Include="SimpleProject.vsct" />
```
3. ビルドアクションを [VSCTCompile] に変更します。
```
<VSCTCompile Include="SimpleProject.vsct" />
```
4. プロジェクトファイル、エディターを閉じます。
5. SimpleProject ノードを保存し、ソリューションエクスプローラーで [プロジェクトの再読み込み] をクリックします。

Visual Studio テンプレートのビルド手順を確認する

VSPackage プロジェクトビルドシステムでは、通常、.vstemplate ファイルが変更された場合、または .vstemplate ファイルを含むプロジェクトがリビルドされた場合に、セットアップモードの Visual Studio が実行されます。 MSBuild の詳細レベルを [標準] 以上に設定することによって、次の操作を行うことができます。

ツールメニューでオプションをクリックします。
[プロジェクトおよびソリューション] ノードを展開し、[ビルドと実行] を選択します。
[MSBuild プロジェクトビルドの出力の詳細] を [標準] に設定します。 OK をクリックします。
SimpleProject プロジェクトをリビルドします。

.zip プロジェクトファイルを作成するためのビルド手順は、次の例のようになります。

ZipProjects:
1>  Zipping ProjectTemplates
1>  Zipping <path>\SimpleProject\SimpleProject\obj\Debug\SimpleProject.zip...
1>  Copying file from "<path>\SimpleProject\SimpleProject\obj\Debug\SimpleProject.zip" to "<%LOCALAPPDATA%>\Microsoft\VisualStudio\14.0Exp\ProjectTemplates\\\\SimpleProject.zip".
1>  Copying file from "<path>\SimpleProject\SimpleProject\obj\Debug\SimpleProject.zip" to "bin\Debug\\ProjectTemplates\\\\SimpleProject.zip".
1>  SimpleProject -> <path>\SimpleProject\SimpleProject\bin\Debug\ProjectTemplates\SimpleProject.zip
1>ZipItems:
1>  Zipping ItemTemplates
1>  SimpleProject ->

Visual Studio テンプレートをデプロイする

Visual Studio テンプレートにはパス情報が含まれていません。そのため、テンプレートの .zip ファイルは、Visual Studio で認識されている場所に配置する必要があります。通常、ProjectTemplates フォルダーの場所は <%LOCALAPPDATA%>\Microsoft\VisualStudio\14.0Exp\ProjectTemplates です。

プロジェクトファクトリを配置するには、インストールプログラムに管理者特権が必要です。テンプレートは Visual Studio のインストールノード ...\Microsoft Visual Studio 14.0\Common7\IDE\ProjectTemplates にデプロイされます。

Visual Studio テンプレートをテストする

プロジェクトファクトリをテストして、Visual Studio テンプレートを使用してプロジェクト階層が作成されるかどうかを確認します。

Visual Studio SDK の実験用インスタンスをリセットします。

Windows 7: [スタート] メニューで、Microsoft Visual Studio/Microsoft Visual Studio SDK/Tools フォルダーを見つけて、[Microsoft Visual Studio 実験用インスタンスのリセット] を選択します。

新しいバージョンの Windows: [スタート] 画面で、「Reset the Microsoft Visual Studio <version> Experimental Instance」と入力します。
コマンドプロンプトウィンドウが表示されます。「続行するには何かキーを押してください」と表示されたら、Enter キーを押します。ウィンドウが閉じたら、Visual Studio を開きます。
SimpleProject プロジェクトをリビルドし、デバッグを開始します。実験用インスタンスが表示されます。
実験用インスタンスで、SimpleProject プロジェクトを作成します。 [新しいプロジェクト] ダイアログボックスで、[SimpleProject] を選びます。
SimpleProject の新しいインスタンスが表示されます。

プロジェクトタイプの子ノードを作成する

[新しいプロジェクト] ダイアログボックスのプロジェクトタイプノードに子ノードを追加できます。たとえば、SimpleProject プロジェクトタイプでは、コンソールアプリケーション、ウィンドウアプリケーション、Web アプリケーションなどの子ノードを持つことができます。

子ノードは、プロジェクトファイルを変更し、<ZipProject> 要素に子の <OutputSubPath> を追加することによって作成されます。ビルド中またはデプロイ時にテンプレートをコピーすると、すべての子ノードがプロジェクトテンプレートフォルダーのサブフォルダーになります。

このセクションでは、SimpleProject プロジェクトタイプに対して、子の Console ノードを作成する方法について説明します。

\Templates\Projects\SimpleProject\ フォルダーの名前を \Templates\Projects\ConsoleApp\ に変更します。
[プロパティ] ウィンドウで、\Templates\Projects\ConsoleApp\ フォルダー内の 5 つのファイルをすべて選択し、[ビルドアクション] が [ZipProject] に設定されていることを確認します。
SimpleProject.vstemplate ファイルで、<TemplateData> セクションの末尾、終了タグの直前に次の行を追加します。
```
<NumberOfParentCategoriesToRollUp>1</NumberOfParentCategoriesToRollUp>
```
これにより、コンソールアプリケーションテンプレートが、子の Console ノードと、子ノードの 1 レベル上にある親の SimpleProject ノードの両方に表示されるようになります。
SimpleProject.vstemplate ファイルを保存します。
.csproj ファイルで、それぞれの ZipProject 要素に <OutputSubPath> を追加します。前と同様にプロジェクトをアンロードし、プロジェクトファイルを編集します。

<ZipProject> 要素を見つけます。それぞれの <ZipProject> 要素に対して <OutputSubPath> 要素を追加し、それに値 Console を指定します。 ZipProject

<ZipProject Include="Templates\Projects\ConsoleApp\AssemblyInfo.cs">
  <OutputSubPath>Console</OutputSubPath>
</ZipProject>
<ZipProject Include="Templates\Projects\ConsoleApp\Program.cs">
  <OutputSubPath>Console</OutputSubPath>
</ZipProject>
<ZipProject Include="Templates\Projects\ConsoleApp\SimpleProject.myproj">
  <OutputSubPath>Console</OutputSubPath>
</ZipProject>
<ZipProject Include="Templates\Projects\ConsoleApp\SimpleProject.vstemplate">
  <OutputSubPath>Console</OutputSubPath>
</ZipProject>
<ZipProject Include="Templates\Projects\ConsoleApp\SimpleProject.ico">
  <OutputSubPath>Console</OutputSubPath>
</ZipProject>

この <PropertyGroup> をプロジェクトファイルに追加します。

<PropertyGroup>
  <VsTemplateLanguage>SimpleProject</VsTemplateLanguage>
</PropertyGroup>

プロジェクトファイルを保存してプロジェクトを再度読み込みます。

プロジェクトタイプの子ノードをテストする

変更したプロジェクトファイルをテストして、子の Console ノードが [新しいプロジェクト] ダイアログボックスに表示されているかどうかを確認します。

Microsoft Visual Studio 実験用インスタンスのリセット ツールを実行します。
SimpleProject プロジェクトをリビルドし、デバッグを開始します。実験用インスタンスが表示されます。
[新しいプロジェクト] ダイアログで、SimpleProject ノードをクリックします。 [テンプレート] ペインにコンソールアプリケーション テンプレートが表示されます。
SimpleProject ノードを展開します。子の Console ノードが表示されます。 SimpleProject アプリケーション テンプレートは [テンプレート] ペインに引き続き表示されます。
[キャンセル] をクリックしてデバッグを停止します。

プロジェクトテンプレートパラメーターを置換する

「基本的なプロジェクトシステムの作成、パート 1」では、ProjectNode.AddFileFromTemplate メソッドを上書きして基本的な種類のテンプレートパラメーターの置換を実行する方法を説明しました。このセクションでは、より高度な Visual Studio テンプレートパラメーターの使用方法について説明します。

[新しいプロジェクト] ダイアログボックスで Visual Studio テンプレートを使用してプロジェクトを作成すると、テンプレートパラメーターが文字列に置き換えられ、プロジェクトがカスタマイズされます。テンプレートパラメーターは、先頭と末尾にドル記号が付いた特別なトークンです (例: $time$)。次の 2 つのパラメーターは、テンプレートに基づくプロジェクトのカスタマイズを有効にする場合に特に役立ちます。

$GUID[1-10]$ は新しい Guid に置き換えられます。最大 10 の GUID を指定できます (たとえば、$guid1$)。
$safeprojectname$ は、[新しいプロジェクト] ダイアログボックスでユーザーによって指定された名前であり、安全でない文字とスペースをすべて削除するように変更されています。

テンプレートパラメーターの完全な一覧については、「テンプレートパラメーター」を参照してください。

プロジェクトテンプレートパラメーターを置換するには

SimpleProjectNode.cs ファイルで、AddFileFromTemplate メソッドを削除します。
\Templates\Projects\ConsoleApp\SimpleProject.myproj ファイルで、<RootNamespace> プロパティを探し、その値を $safeprojectname$ に変更します。
```
<RootNamespace>$safeprojectname$</RootNamespace>
```

\Templates\Projects\SimpleProject\Program.cs ファイルで、ファイルの内容を次のコードに置き換えます。

using System;
using System.Collections.Generic;
using System.Text;
using System.Runtime.InteropServices;    // Guid

namespace $safeprojectname$
{
    [Guid("$guid1$")]
    public class $safeprojectname$
    {
        static void Main(string[] args)
        {
            Console.WriteLine("Hello VSX!!!");
            Console.ReadKey();
        }
    }
}

SimpleProject プロジェクトをリビルドし、デバッグを開始します。実験用インスタンスが表示されます。
新しい SimpleProject コンソールアプリケーションを作成します ([プロジェクトの種類] ウィンドウで、[SimpleProject] を選択します。Visual Studio にインストールされているテンプレート] で、[コンソールアプリケーション] を選択します)。

新しく作成されたプロジェクトで Program.cs を開きます。次のようになります (ファイル内の GUID 値は異なります)。

using System;
using System.Collections.Generic;
using System.Text;
using System.Runtime.InteropServices;    // Guid

namespace Console_Application1
{
    [Guid("00000000-0000-0000-00000000-00000000)"]
    public class Console_Application1
    {
        static void Main(string[] args)
        {
            Console.WriteLine("Hello VSX!!!");
            Console.ReadKey();
        }
    }
}

プロジェクトのプロパティページを作成する

ユーザーが自分のテンプレートに基づくプロジェクトのプロパティを表示および変更できるように、プロジェクトタイプのプロパティページを作成できます。このセクションでは、構成に依存しないプロパティページを作成する方法について説明します。この基本的なプロパティページでは、プロパティグリッドを使用して、プロパティページクラスで公開するパブリックプロパティを表示します。

SettingsPage 基底クラスからプロパティページクラスを派生させます。 SettingsPage クラスによって提供されるプロパティグリッドは、ほとんどのプリミティブデータ型と、それらを表示する方法を認識します。また、SettingsPage クラスは、プロパティ値をプロジェクトファイルに保持する方法を認識します。

このセクションで作成するプロパティページでは、次のプロジェクトのプロパティを変更して保存できます。

AssemblyName
OutputType
RootNamespace

SimpleProjectPackage.cs ファイルで、次の ProvideObject 属性を SimpleProjectPackage クラスに追加します。
```
[ProvideObject(typeof(GeneralPropertyPage))]
public sealed class SimpleProjectPackage : ProjectPackage
```
これにより、プロパティページクラス GeneralPropertyPage が COM に登録されます。
SimpleProjectNode.cs ファイルで、次の 2 つのオーバーライドされたメソッドを SimpleProjectNode クラスに追加します。
```
protected override Guid[] GetConfigurationIndependentPropertyPages()
{
    Guid[] result = new Guid[1];
    result[0] = typeof(GeneralPropertyPage).GUID;
    return result;
}
protected override Guid[] GetPriorityProjectDesignerPages()
{
    Guid[] result = new Guid[1];
    result[0] = typeof(GeneralPropertyPage).GUID;
    return result;
}
```
これらのメソッドはどちらも、プロパティページの GUID の配列を返します。 GeneralPropertyPage GUID は配列内の唯一の要素であるため、[プロパティページ] ダイアログボックスには 1 ページしか表示されません。
GeneralPropertyPage.cs という名前のクラスファイルを SimpleProject プロジェクトに追加します。

次のコードを使用してこのファイルの内容を置き換えます。

using System;
using System.Runtime.InteropServices;
using Microsoft.VisualStudio;
using Microsoft.VisualStudio.Project;
using System.ComponentModel;

namespace SimpleProject
{
    [ComVisible(true)]
    [Guid("6BC7046B-B110-40d8-9F23-34263D8D2936")]
    public class GeneralPropertyPage : SettingsPage
    {
        private string assemblyName;
        private OutputType outputType;
        private string defaultNamespace;

        public GeneralPropertyPage()
        {
            this.Name = "General";
        }

        [Category("AssemblyName")]
        [DisplayName("AssemblyName")]
        [Description("The output file holding assembly metadata.")]
        public string AssemblyName
        {
            get { return this.assemblyName; }
        }
        [Category("Application")]
        [DisplayName("OutputType")]
        [Description("The type of application to build.")]
        public OutputType OutputType
        {
            get { return this.outputType; }
            set { this.outputType = value; this.IsDirty = true; }
        }
        [Category("Application")]
        [DisplayName("DefaultNamespace")]
        [Description("Specifies the default namespace for added items.")]
        public string DefaultNamespace
        {
            get { return this.defaultNamespace; }
            set { this.defaultNamespace = value; this.IsDirty = true; }
        }

        protected override void BindProperties()
        {
            this.assemblyName = this.ProjectMgr.GetProjectProperty("AssemblyName", true);
            this.defaultNamespace = this.ProjectMgr.GetProjectProperty("RootNamespace", false);

            string outputType = this.ProjectMgr.GetProjectProperty("OutputType", false);
            this.outputType = (OutputType)Enum.Parse(typeof(OutputType), outputType);
        }

        protected override int ApplyChanges()
        {
            this.ProjectMgr.SetProjectProperty("AssemblyName", this.assemblyName);
            this.ProjectMgr.SetProjectProperty("OutputType", this.outputType.ToString());
            this.ProjectMgr.SetProjectProperty("RootNamespace", this.defaultNamespace);
            this.IsDirty = false;

            return VSConstants.S_OK;
        }
    }
}

GeneralPropertyPage クラスでは、AssemblyName、OutputType、RootNamespace という 3 つのパブリックプロパティを公開します。 AssemblyName には設定メソッドがないため、読み取り専用プロパティとして表示されます。 OutputType は列挙型定数であるため、ドロップダウンリストとして表示されます。

SettingsPage 基底クラスでは、プロパティを保持するために ProjectMgr を提供します。 BindProperties メソッドでは、ProjectMgr を使用して保持されたプロパティ値を取得し、対応するプロパティを設定します。 ApplyChanges メソッドでは、ProjectMgr を使用してプロパティの値を取得し、プロジェクトファイルに保持します。プロパティ設定メソッドでは、プロパティを保持する必要があることを示すために IsDirty が true に設定されます。永続化は、プロジェクトまたはソリューションを保存するときに行われます。

SimpleProject ソリューションをリビルドし、デバッグを開始します。実験用インスタンスが表示されます。
実験用インスタンスで、新しい SimpleProject アプリケーションを作成します。
Visual Studio では、Visual Studio テンプレートを使用してプロジェクトを作成するために、プロジェクトファクトリが呼び出されます。コードエディターで新しい Program.cs ファイルが開かれます。
ソリューションエクスプローラーでプロジェクトノードを右クリックし、[プロパティ] をクリックします。 [プロパティページ] ダイアログボックスが表示されます。

プロジェクトのプロパティページをテストする

これで、プロパティ値を変更できるかどうかをテストできるようになりました。

[MyConsoleApplication プロパティページ] ダイアログボックスで、[DefaultNamespace] を [MyApplication] に変更します。
[OutputType] プロパティを選択し、[クラスライブラリ] を選択します。
適用をクリックし、OK をクリックします。
[プロパティページ] ダイアログボックスを再び開き、変更が保存されていることを確認します。
Visual Studio の実験用インスタンスを終了します。
実験用インスタンスを再び開きます。
[プロパティページ] ダイアログボックスを再び開き、変更が保存されていることを確認します。
Visual Studio の実験用インスタンスを終了します。

基本的なプロジェクト システムの作成、パート 2

Visual Studio テンプレートを作成する

最小限の .vsct ファイルを追加する

Visual Studio テンプレートのビルド手順を確認する

Visual Studio テンプレートをデプロイする

Visual Studio テンプレートをテストする

プロジェクト タイプの子ノードを作成する

プロジェクト タイプの子ノードをテストする

プロジェクト テンプレート パラメーターを置換する

プロジェクト テンプレート パラメーターを置換するには

プロジェクトのプロパティ ページを作成する

プロジェクトのプロパティ ページをテストする

その他のリソース