Windows フォームに基づくドメイン固有言語を作成する

[アーティクル]
06/19/2023

DSL 図を使用する代わりに Windows フォームを使用して、ドメイン固有言語 (DSL) モデルの状態を表示できます。このトピックでは、Visual Studio Visualization and Modeling SDK を使用して Windows フォームを DSL にバインドする手順について説明します。

次の図は、ある DSL インスタンスの Windows フォーム UI とモデルエクスプローラーを示しています。

DSL instance in Visual Studio

Windows フォームの DSL を作成する

最小 WinForm デザイナー DSL テンプレートでは、独自の要件に合わせて変更できる最小限の DSL を作成できます。

最小 WinForm デザイナー テンプレートから DSL を作成します。

このチュートリアルでは、次の名前を想定しています。
- ソリューションと DSL の名前: FarmApp
- 名前空間: Company.FarmApp
テンプレートに用意されている最初の例を試します。
1. [すべてのテンプレートの変換] を実行します。
2. サンプルをビルドして実行します (Ctrl+F5 キー)。
3. Visual Studio の実験用インスタンスで、デバッグプロジェクト内の Sample ファイルを開きます。
  
  これが Windows フォームコントロールに表示されていることを確認してください。
  
  また、モデルの要素がエクスプローラーに表示されていることも確認できます。
  
  フォームまたはエクスプローラーのどちらか一方でいくつかの要素を追加し、それらが他方の表示画面に表示されていることを確認します。
Visual Studio の主要なインスタンスでは、DSL ソリューションに関する次の点にご注意ください。

DslDefinition.dsl にはダイアグラム要素が含まれていません。この DSL のインスタンスモデルの表示には DSL 図を使用しないためです。代わりに、Windows フォームをモデルにバインドすると、フォーム上の要素にモデルが表示されます。
Dsl および DslPackage プロジェクトに加えて、このソリューションには UI. という名前の 3 つ目のプロジェクトも含まれています。UI プロジェクトには、Windows フォームコントロールの定義が含まれています。 DslPackage は UI に依存しており、UI は Dsl に依存しています。
DslPackage プロジェクトの UI\DocView.cs には、UI プロジェクトで定義されている Windows フォームコントロールを表示するコードが含まれています。
UI プロジェクトには、DSL にバインドされたフォームコントロールの作業用サンプルが含まれています。ただし、DSL 定義を変更した場合は機能しなくなります。 UI プロジェクト名には以下が含まれています。
- ModelViewControl という名前の Windows フォームクラス。
- ModelViewControl の追加の部分定義を含む、DataBinding.cs という名前のファイル。その内容を確認するには、ソリューションエクスプローラーで、そのファイルのショートカットメニューを開き、 [コードの表示] を選択します。

UI プロジェクトについて

DSL 定義ファイルを更新して独自の DSL を定義する場合は、その DSL を表示するように UI プロジェクト内のコントロールを更新する必要があります。 Dsl や DslPackage のプロジェクトとは異なり、DslDefinitionl.dsl から UI のサンプルプロジェクトは生成されません。必要に応じて、.tt ファイルを追加してコードを生成できます (ただし、これについては、このチュートリアルでは説明しません)。

DSL 定義を更新する

次の図は、このチュートリアルで使用する DSL 定義を示しています。

DSL definition

DSL デザイナーで DslDefinition.dsl を開きます。
ExampleElement を削除します
ExampleModel ドメインクラスの名前を Farm に変更します。

これに、Size という名前の Int32 型と、IsOrganic という名前の Boolean 型の追加のドメインプロパティを指定します。

Note

ルートドメインクラスを削除してから新しいルートを作成する場合は、[エディターのルートクラス] プロパティをリセットする必要があります。 DSL エクスプローラーで、 [エディター] を選択します。次に、プロパティウィンドウで、 [ルートクラス] を Farm に設定します。
[名前付きドメインクラス] ツールを使用して、次のドメインクラスを作成します。
- Field - これに Size という名前の追加のドメインプロパティを指定します。
- Animal - プロパティウィンドウで、 [継承修飾子] を [抽象] に設定します。
Note

このセクションで説明する名前付きドメインクラス ツールやその他のツールは、[ツールボックス] ツールウィンドウにあります。このウィンドウは、[表示]>[ツールボックス] で開いたり非表示にしたりできます。
[ドメインクラス] ツールを使用して、次のクラスを作成します。
- Sheep
- Goat
[継承] ツールを使用して、Goat と Sheep を Animal から継承させます。
[埋め込み] ツールを使用して、Field と Animal を Farm の下に埋め込みます。
図を整理することをお勧めします。重複する要素の数を減らすには、リーフ要素のショートカットメニュー上の [ここにサブツリーを表示] を使用します。
ソリューションエクスプローラーのツールバーで [すべてのテンプレートの変換] を実行します。
Dsl プロジェクトをビルドします。

注意

この段階では、他のプロジェクトはエラーのない状態でビルドされません。ただし、Dsl プロジェクトは、データソースウィザードでそのアセンブリを使用できるようにビルドする必要があります。

UI プロジェクトを更新する

DSL モデルに格納されている情報を表示する新しいユーザーコントロールを作成できるようになりました。ユーザーコントロールをモデルに接続する最も簡単な方法は、データバインディングを使用することです。 ModelingBindingSource という名前のデータバインディングアダプタータイプは、DSL を VMSDK 以外のインターフェイスに接続するように特別に設計されています。

DSL モデルをデータソースとして定義する

[データ] メニューの [データソースの表示] をクリックします。

[データソース] ウィンドウが開きます。

[新しいデータソースの追加] を選択します。 データソース構成ウィザードが開きます。
[オブジェクト] 、 [次へ] の順に選択します。

[Dsl] 、 [Company.FarmApp] の順に展開し、モデルのルートクラスである [Farm] を選択します。 [完了] を選択します。

ソリューションエクスプローラーでは、UI プロジェクトに Properties\DataSources\Farm.datasource が含まれるようになりました

モデルクラスのプロパティとリレーションシップが [データソース] ウィンドウに表示されます。

モデルをフォームに接続する

UI プロジェクトで、既存の .cs ファイルをすべて削除します。
FarmControl という名前の新しい ユーザーコントロール ファイルを UI プロジェクトに追加します。
[データソース] ウィンドウの [Farm] のドロップダウンメニューで、 [詳細] を選択します。

他のプロパティの既定の設定はそのままにします。
デザインビューで FarmControl.cs を開きます。

[データソース] ウィンドウから FarmControl に [Farm] をドラッグします。

一連のコントロールが、各プロパティに 1 つずつ表示されます。リレーションシップのプロパティでは、コントロールは生成されません。
[farmBindingNavigator] を削除します。これは FarmControl デザイナーでも自動的に生成されますが、このアプリケーションには役立ちません。
ツールボックスを使用して、 [DataGridView] のインスタンスを 2 つ作成し、「AnimalGridView」および「FieldGridView」という名前を付けます。

注意

代替手順として、[データソース] ウィンドウからそのコントロールに [Animals] と [Fields] の各項目をドラッグすることもできます。このアクションにより、グリッドビューとデータソースの間にデータグリッドおよびバインディングが自動的に作成されます。ただし、このバインディングは DSL では正しく機能しません。そのため、データグリッドおよびバインディングは手動で作成することをお勧めします。
ツールボックスに [ModelingBindingSource] ツールが含まれていない場合は、それを追加します。 [データ] タブのショートカットメニューで、 [項目の選択] を選択します。 [ツールボックス項目の選択] ダイアログで、 [.NET Framework] タブの [ModelingBindingSource] を選択します。
ツールボックスを使用して、 [ModelingBindingSource] のインスタンスを 2 つ作成し、「AnimalBinding」および「FieldBinding」という名前を付けます。
各 [ModelingBindingSource] の [データソース] プロパティを [farmBindingSource] に設定します。

[データメンバー] プロパティを [Animals] または [Fields] に設定します。
AnimalGridView と FieldGridView の [DataSource] プロパティをそれぞれ AnimalBinding と FieldBinding に設定します。
Farm コントロールのレイアウトをご自分の好みに合わせて調整します。

ModelingBindingSource は、DSL に固有のいくつかの機能を実行するアダプターです。

VMSDK ストアトランザクション内の更新をラップします。

たとえば、ユーザーがデータビューグリッドから行を削除すると、通常のバインディングではトランザクション例外が発生します。
ユーザーが行を選択するときに、データグリッド行ではなく、対応するモデル要素のプロパティがプロパティウィンドウに表示されるようにします。

データソースとビューの間のリンクのスキーマ。

DSL へのバインドを完了する

UI プロジェクト内の別のコードファイルに次のコードを追加します。

using System.ComponentModel;
using Microsoft.VisualStudio.Modeling;
using Microsoft.VisualStudio.Modeling.Design;

namespace Company.FarmApp
{
  partial class FarmControl
  {
    public IContainer Components { get { return components; } }

    /// <summary>Binds the WinForms data source to the DSL model.
    /// </summary>
    /// <param name="nodelRoot">The root element of the model.</param>
    public void DataBind(ModelElement modelRoot)
    {
      WinFormsDataBindingHelper.PreInitializeDataSources(this);
      this.farmBindingSource.DataSource = modelRoot;
      WinFormsDataBindingHelper.InitializeDataSources(this);
    }
  }
}

DslPackage プロジェクトで、次の変数定義を更新するように DslPackage\DocView.tt を編集します。
```
string viewControlTypeName = "FarmControl";
```

DSL をテストする

DSL ソリューションをビルドして実行できるようになりましたが、後でさらに改善を加えることもできます。

ソリューションをビルドして実行します。
Visual Studio の実験用インスタンスで、Sample ファイルを開きます。
FarmApp エクスプローラーで、 [Farm] ルートノードのショートカットメニューを開き、 [Add New Goat] を選択します。

Goat1 が [Animals] ビューに表示されます。

警告

[Animals] ノードではなく、 [Farm] ノードのショートカットメニューを使用する必要があります。
[Farm] ルートノードを選択し、そのプロパティを表示します。

フォームビューで、Farm の [Name] または [Size] を変更します。

フォームの各フィールドから移動すると、対応するプロパティがプロパティウィンドウ内で変更されます。

DSL を拡張する

プロパティを直ちに更新する

FarmControl.cs のデザインビューで、[Name]、[Size]、[IsOrganic] などの単純なフィールドを選択します。
プロパティウィンドウで、 [DataBindings] を展開して [(詳細)] を開きます。

[フォーマットと詳細バインド] ダイアログの [データソース更新モード] で、 [OnPropertyChanged] を選択します。
ソリューションをビルドして実行します。

フィールドの内容を変更すると、Farm モデルの対応するプロパティがすぐに変更されることを確認します。

ボタンの追加機能を提供する

FarmControl.cs のデザインビューで、ツールボックスを使用してフォーム上にボタンを作成します。

そのボタンの名前やテキストを (New Sheep などに) 編集します。

(ボタンをダブルクリックするなどして) ボタンの背後にあるコードを開きます。

次のように編集します。

private void NewSheepButton_Click(object sender, EventArgs e)
{
  using (Transaction t = farm.Store.TransactionManager.BeginTransaction("Add sheep"))
  {
    elementOperations.MergeElementGroup(farm,
      new ElementGroup(new Sheep(farm.Partition)));
    t.Commit();
  }
}

// The following code is shared with other add buttons:
private ElementOperations operationsCache = null;
private ElementOperations elementOperations
{
  get
  {
    if (operationsCache == null)
    {
      operationsCache = new ElementOperations(farm.Store, farm.Partition);
    }
    return operationsCache;
  }
}
private Farm farm
{
  get { return this.farmBindingSource.DataSource as Farm; }
}

次のディレクティブを挿入する必要もあります。


using Microsoft.VisualStudio.Modeling;

Goats と Fields についても同様のボタンを追加します。
ソリューションをビルドして実行します。
新規作成のボタンによって項目が追加されることを確認します。 FarmApp エクスプローラーと適切なデータグリッドビューの両方に新しい項目が表示されます。

データグリッドビューでその要素の名前を編集できます。そこから削除することもできます。

要素を追加するコードについて

新しい要素のボタンについては、次の代替コードの方がややシンプルです。

private void NewSheepButton_Click(object sender, EventArgs e)
{
  using (Transaction t = farm.Store.TransactionManager.BeginTransaction("Add sheep"))
  {
    farm.Animals.Add(new Sheep(farm.Partition)); ;
    t.Commit();
  }
}

ただし、このコードでは、新しい項目の既定の名前は設定されません。 DSL の要素マージディレクティブで定義した可能性のあるカスタマイズされたマージは実行されず、定義されている可能性のあるカスタムマージコードも実行されません。

そのため、ElementOperations を使用して新しい要素を作成することをお勧めします。詳細については、「要素作成処理および要素移動処理のカスタマイズ」を参照してください。

次の方法で共有

Windows フォームに基づくドメイン固有言語を作成する

Windows フォームの DSL を作成する

UI プロジェクトについて

DSL 定義を更新する

UI プロジェクトを更新する

DSL モデルをデータソースとして定義する

モデルをフォームに接続する

DSL へのバインドを完了する

DSL をテストする

DSL を拡張する

プロパティを直ちに更新する

ボタンの追加機能を提供する

要素を追加するコードについて

フィードバック

その他のリソース

次の方法で共有

Windows フォームに基づくドメイン固有言語を作成する

Windows フォームの DSL を作成する

UI プロジェクトについて

DSL 定義を更新する

UI プロジェクトを更新する

DSL モデルをデータ ソースとして定義する

モデルをフォームに接続する

DSL へのバインドを完了する

DSL をテストする

DSL を拡張する

プロパティを直ちに更新する

ボタンの追加機能を提供する

要素を追加するコードについて

関連するコンテンツ

フィードバック

その他のリソース

DSL モデルをデータソースとして定義する