次の方法で共有

ツールおよびツールボックスのカスタマイズ

  • [アーティクル]

ユーザーがモデルに追加可能な要素についてツールボックス項目を定義する必要があります。 ツールには要素ツールと接続ツールの 2 種類があります。 生成されたデザイナーで、ユーザーは要素ツールを選択して図形を図へドラッグすることができ、接続ツールを選択して図形間のリンクを描画できます。 一般にユーザーは、要素ツールを使用するとドメイン クラスのインスタンスをモデルに追加することができ、接続ツールを使用するとドメイン リレーションシップのインスタンスを追加できます。

このトピックの内容

  • ツールボックスの定義方法

  • 要素ツールのカスタマイズ

  • ツールによる要素のグループの作成

  • 接続ツールのカスタマイズ

ツールボックスの定義方法

DSL エクスプローラーで、エディター ノードとその下のノードを展開します。 一般に、次のような階層が表示されます。

Editor
     Toobox Tabs
        MyDsl          //a tab
           Tools
               ExampleElement      // an element tool
               ExampleRelationship // a connection tool

DSL エクスプローラーのこの部分で、次の操作を実行できます。

  • 新しいタブを作成します。 タブはツールボックス内のセクション見出しを定義します。

  • 新しいツールを作成します。

  • ツールをコピーして貼り付けます。

  • 一覧内のツールを上下に移動します。

  • タブとツールを削除します。

重要

DSL エクスプローラー内の項目を追加または貼り付けるには、新しいノードの親の親を右クリックします。たとえば、ツールを追加するには、[ツール] ノードではなく、タブを右クリックします。タブを追加するには、[エディター] ノードを右クリックします。

すべてのツールの [ツールボックス アイコン] プロパティは 16x16 ビットマップ ファイルを参照します。 これらのファイルは通常、Dsl\Resources フォルダー内に維持されます。

要素ツールの [クラス] プロパティは具象ドメイン クラスを参照します。 既定では、ツールはこのクラスのインスタンスを作成します。 ただし、コードを作成して、ツールに要素のグループまたはさまざまな種類の要素を作成させることができます。

接続ツールの [接続ビルダー] プロパティは、接続ビルダーを参照します。それは、ツールで接続可能な要素の種類、およびそれらの間に作成されるリレーションシップを定義します。 DSL エクスプローラーで、接続ビルダーはノードとして定義されます。 接続ビルダーは、ドメイン リレーションシップを定義すると自動的に作成されますが、コードを作成してカスタマイズできます。

ツールボックスにツールを追加するには

  1. 通常、図形クラスを作成し、それをドメイン クラスにマップした後で、要素ツールを作成します。

    通常、コネクタ クラスを作成し、それを参照リレーションシップにマップした後で、コネクタ ツールを作成します。

  2. DSL エクスプローラーで、[エディター] ノードと [ツールボックス タブ] ノードを展開します。

    ツールボックス タブ ノードを右クリックし、[新しい要素ツールの追加] または [新しい接続ツールの追加] をクリックします。

  3. [ツールボックス アイコン] プロパティが 16x16 ビットマップを参照するように設定します。

    新しいアイコンを定義する場合、ソリューション エクスプローラーの Dsl\Resources フォルダーにビットマップ ファイルを作成します。 このファイルはプロパティ値として、Build Action = Content および Copy to Output Directory = Do not copy を含む必要があります。

  4. 要素ツールの場合: ツールの [クラス] プロパティが図形にマップされる具象ドメイン クラスを参照するように設定します。

    コネクタ ツールの場合: ツールの [接続ビルダー] プロパティをドロップダウン リスト内に提供される項目のいずれかに設定します。 接続ビルダーは、コネクタをドメイン リレーションシップにマップすると、自動的に作成されます。 最近、コネクタを作成した場合、通常、関連する接続ビルダーを選択しています。

  5. DSL をテストするには、F5 キーまたは CTRL+F5 キーを押し、Visual Studio の実験用インスタンスでサンプル モデル ファイルを開きます。 ツールボックスに新しいツールが表示されます。 それを図の上にドラッグし、新しい要素が作成されることを確認します。

    ツールが表示されない場合、実験用の Visual Studio を停止します。 Windows の [スタート] メニューで、[Microsoft Visual Studio 2010 実験用インスタンスのリセット] を実行します。 Visual Studio の [ビルド] メニューで、[ソリューションのリビルド] をクリックします。 再度 DSL をテストします。

要素ツールのカスタマイズ

既定では、ツールは指定されたクラスの単一インスタンスを作成しますが、次の 2 つの方法で変更できます。

  • 他のクラスで要素マージ ディレクティブを定義し、このクラスの新しいインスタンスが受け入れられ、新しい要素が作成されるときに追加のリンクが作成されるようにします。 たとえば、ユーザーが別の要素にコメントをドロップし、両者の間に参照リンクを作成可能にすることができます。

    これらのカスタマイズは、ユーザーが要素を貼り付けたりドラッグ アンド ドロップしたりするときに発生することにも影響します。

    詳細については、「要素作成処理および要素移動処理のカスタマイズ」を参照してください。

  • コードを作成して、ツールをカスタマイズし、要素のグループを作成可能にします。 ツールはオーバーライド可能な ToolboxHelper.cs 内のメソッドにより初期化されます。 詳細については、「ツールによる要素のグループの作成」を参照してください。

ツールによる要素のグループの作成

各要素ツールは作成する要素のプロトタイプを含みます。 既定では、各要素ツールは単一の要素を作成しますが、1 つのツールで関連するオブジェクトのグループを作成することも可能です。 そのためには、関連項目を含む ElementGroupPrototype を使用してツールを初期化します。

次の例は、型 Transistor がある DSL から取得しています。 各 Transistor には名前の付いた Terminal が 3 つあります。 Transistor の要素ツールは、4 つのモデル要素と 3 つのリレーションシップ リンクを含むプロトタイプを格納します。 ユーザーがツールを図の上にドラッグすると、プロトタイプはインスタンス化され、モデル ルートにリンクされます。

このコードは Dsl\GeneratedCode\ToolboxHelper.cs で定義されているメソッドをオーバーライドします。

プログラム コードを使用したモデルのカスタマイズの詳細については、「プログラム コードにおけるモデル内の移動およびモデルの更新」を参照してください。

using Microsoft.VisualStudio.Modeling;
using Microsoft.VisualStudio.Modeling.Diagrams;

  public partial class CircuitsToolboxHelper
  {
    /// <summary>
    /// Toolbox initialization, called for each element tool on the toolbox.
    /// This version deals with each Component subtype separately.
    /// </summary>
    /// <param name="store"></param>
    /// <param name="domainClassId">Identifies the domain class this tool should instantiate.</param>
    /// <returns>prototype of the object or group of objects to be created by tool</returns>
    protected override ElementGroupPrototype CreateElementToolPrototype(Store store, Guid domainClassId)
    {
        if (domainClassId == Transistor.DomainClassId)
        {
            Transistor transistor = new Transistor(store);

            transistor.Base = new ComponentTerminal(store);
            transistor.Collector = new ComponentTerminal(store);
            transistor.Emitter = new ComponentTerminal(store);

            transistor.Base.Name = "base";
            transistor.Collector.Name = "collector";
            transistor.Emitter.Name = "emitter";

            // Create an ElementGroup for the Toolbox.
            ElementGroup elementGroup = new ElementGroup(store.DefaultPartition);
            elementGroup.AddGraph(transistor, true);
            // AddGraph includes the embedded parts

            return elementGroup.CreatePrototype();
        }
        else
        {
            return base.CreateElementToolPrototype(store, domainClassId);
}  }    }

接続ツールのカスタマイズ

通常、新しいコネクタ クラスを作成するときに要素ツールを作成します。 または、両端の種類でリレーションシップの種類を確認可能にすることで、1 つのツールをオーバーロードできます。 たとえば、Person-Person リレーションシップと Person-Town リレーションシップの両方を作成可能な 1 つの接続ツールを定義できます。

接続ツールは接続ビルダーを呼び出します。 接続ビルダーを使用して、ユーザーが生成されたデザイナー内で要素をリンク可能な方法を指定します。 接続ビルダーは、リンク可能な要素と要素間に作成されるリンクの種類を指定します。

ドメイン クラス間に参照リレーションシップを作成すると、接続ビルダーは自動的に作成されます。 接続ツールをマップするときにこの接続ビルダーを使用します。 接続ツールを作成する方法の詳細については、「ツールおよびツールボックスのカスタマイズ」を参照してください。

既定の接続ビルダーを変更して、異なる範囲のソース型とターゲット型を扱い、異なる種類のリレーションシップを作成できます。

接続ビルダー用にカスタム コードを作成し、接続用のソース クラスとターゲット クラスの指定、作成される接続の種類の定義、および接続の作成に関連するその他の処理を実行できます。

接続ビルダーの構造

接続ビルダーには 1 つ以上のリンク接続ディレクティブが含まれ、それによってドメイン リレーションシップとソース要素およびターゲット要素が指定されます。 たとえば、Task Flow ソリューション テンプレートで、DSL エクスプローラーには CommentReferencesSubjectsBuilder が表示されます。 この接続ビルダーには CommentReferencesSubjects という名前のリンク接続ディレクティブが含まれ、ドメイン リレーションシップ CommentReferencesSubjects にマップされます。 このリンク接続ディレクティブには、Comment ドメイン クラスを指し示すソース ロール ディレクティブと FlowElement ドメイン クラスを指し示すターゲット ロール ディレクティブが含まれます。

接続ビルダーを使用したソース ロールとターゲット ロールの制限

接続ビルダーを使用して、指定されたドメイン リレーションシップのソース ロールまたはターゲット ロールのどちらかで、特定のクラスの出現を制限できます。 たとえば、別のドメイン クラスへのドメイン リレーションシップを伴う基底ドメイン クラスがあるが、そのリレーションシップにおいて、その基底クラスのすべての派生クラスのロールが同じロールになるのは望ましくないという場合があるかもしれません。 Task Flow ソリューションには、抽象ドメイン クラス FlowElement から直接継承する 4 つの具象ドメイン クラス (StartPoint、EndPoint、MergeBranch、および Synchronization) と間接的に継承する 2 つの具象ドメイン クラス (Task および ObjectInState) があります。 ソース ロールとターゲット ロールの両方で FlowElement ドメイン クラスを取得する Flow 参照リレーションシップもあります。 ただし、EndPoint ドメイン クラスのインスタンスを Flow リレーションシップのインスタンスのソースにすることはできず、StartPoint クラスのインスタンスを Flow リレーションシップのインスタンスのターゲットにすることもできません。 FlowBuilder 接続ビルダーは、どのドメイン クラスがソース ロール (Task、MergeBranch、StartPoint、および Synchronization) を演じ、どのドメイン クラスがターゲット ロール (MergeBranch、Endpoint、および Synchronization) を演じることができるかを指定する、Flow という名前のリンク接続ディレクティブを持ちます。

複数のリンク接続ディレクティブを持つ接続ビルダー

接続ビルダーには複数のリンク接続ディレクティブを追加できます。 これはドメイン モデルの複雑さの一部をユーザーから隠し、ツールボックスが煩雑になるのを防ぐのに役立ちます。 単一の接続ビルダーにいくつかの異なるドメイン リレーションシップのリンク接続ディレクティブを追加できます。 ただし、ほぼ同一の関数を実行するときはドメイン リレーションシップを結合する必要があります。

Task Flow ソリューションで、Flow 接続ツールは、Flow と ObjectFlow の両方のドメイン リレーションシップのインスタンスを描画するために使用します。 FlowBuilder 接続ビルダーには、前述の Flow リンク接続ディレクティブに加えて、ObjectFlow という名前の 2 つのリンク接続ディレクティブがあります。 これらのディレクティブは、ObjectFlow リレーションシップのインスタンスを ObjectInState ドメイン クラスのインスタンス間に描画するか、Task の 2 つのインスタンス間ではなく ObjectInState のインスタンスから Task のインスタンスへ描画するか、または Task のインスタンスから ObjectInState のインスタンスへ描画することが可能であることを指定します。 ただし、Flow リレーションシップのインスタンスは Task の 2 つのインスタンス間に描画できます。 Task Flow ソリューションをコンパイルして実行する場合、ObjectInState のインスタンスから Task のインスタンスへ Flow を描画すると ObjectFlow のインスタンスが作成されますが、Task の 2 つのインスタンス間に Flow を描画すると Flow のインスタンスが作成されるのがわかります。

接続ビルダーのカスタム コード

ユーザー インターフェイスには接続ビルダーの異なる種類のカスタマイズを定義する 4 つのチェック ボックスがあります。

  • ソースまたはターゲット ロール ディレクティブ上の [カスタム受け入れ] チェック ボックス

  • ソースまたはターゲット ロール ディレクティブ上の [カスタム接続] チェック ボックス

  • 接続ディレクティブ上の [カスタム接続を使用] チェック ボックス

  • 接続ビルダーの [カスタム] プロパティ

これらのカスタマイズを実施するためにプログラム コードを準備する必要があります。 どのようなコードを準備する必要があるのかを知るためには、これらのボックスのいずれかをチェックし、[すべてのテンプレートの変換] をクリックして、ソリューションをビルドします。 エラー レポートが生成されます。 エラー レポートをダブルクリックし、追加する必要があるコードを説明しているコメントを確認します。

注意

カスタム コードを追加するには、GeneratedCode フォルダー内のコード ファイルとは別のコード ファイルに部分クラス定義を作成します。作業内容を失わないために、生成されたコード ファイルを編集しないでください。詳細については、「生成済みクラスのオーバーライドおよび拡張」を参照してください。

カスタム接続コードの作成

各リンク接続ディレクティブで、[ソース ロール ディレクティブ] タブはドラッグ元として指定可能な型を定義します。 同様に、[ターゲット ロール ディレクティブ] タブはドラッグ先として指定可能な型を定義します。 さらに各型に対して、[カスタム受け入れ] フラグを設定して追加コードを入力することにより、接続を許可するかどうか (そのリンク接続ディレクティブに関して) を指定できます。

接続が確立されたときに発生することをカスタマイズすることもできます。 たとえば、特定のクラスに対してドラッグが発生するただ 1 つのケース、あるリンク接続ディレクティブが規定するすべてのケース、または FlowBuilder 接続ビルダー全体をカスタマイズできます。 これらの各オプションについて、適切なレベルでカスタム フラグを設定できます。 すべてのテンプレートを変換し、ソリューションのビルドを試みると、エラー メッセージから生成されたコード内のコメントに誘導されます。 これらのコメントにより、提供する必要のあるものが特定されます。

コンポーネント図のサンプルで、Connection ドメイン リレーションシップの接続ビルダーはポート間に作成可能な接続を制限するようにカスタマイズされています。 次の図は、OutPort 要素から InPort 要素への接続のみ可能であること、しかし互いの内部でコンポーネントを入れ子にすることが可能であることを示しています。

入れ子になったコンポーネントから OutPort への接続

接続ビルダー

したがって、入れ子になったコンポーネントから OutPort への接続が可能であることを指定するのが適切です。 そうした接続を指定するには、次の図に示すように、[DSL Details] ウィンドウで [カスタム受け入れを使用] を、ソース ロールとして [InPort] 型に、ターゲット ロールとして [OutPort] 型に設定します。

DSL エクスプローラーにおけるリンク接続ディレクティブ

接続ビルダー イメージ

DSL 詳細ウィンドウにおけるリンク接続ディレクティブ

ConnectionBuilder_4b

次に、ConnectionBuilder クラスにメソッドを入力する必要があります。

  public partial class ConnectionBuilder
  {
    /// <summary>
    /// OK if this component has children
    /// </summary>
    private static bool CanAcceptInPortAsSource(InPort candidate)
    {
       return candidate.Component.Children.Count > 0;
    }

    /// <summary>
    /// Only if source is on parent of target.
    /// </summary>
    private static bool CanAcceptInPortAndInPortAsSourceAndTarget                (InPort sourceInPort, InPort targetInPort)
    {
      return sourceInPort.Component == targetInPort.Component.Parent;
    }
// And similar for OutPorts…

プログラム コードを使用したモデルのカスタマイズの詳細については、「プログラム コードにおけるモデル内の移動およびモデルの更新」を参照してください。

たとえば、同様のコードを使用して、ユーザーによる親子リンクを含むループの作成を防ぐことができます。 これらの制限は、どんな場合でもユーザーが違反することができないため、「ハード」な制約と見なされます。 ユーザーが保存できない無効な構成を作成することにより、一時的に迂回可能な「ソフト」な検証チェックを作成することもできます。

接続ビルダーを定義する際の適切なプラクティス

異なる種類のリレーションシップを作成するために、それらが概念的に関連する場合にのみ、1 つの接続ビルダーを定義する必要があります。 タスク フローのサンプルでは、同じビルダーを使用して、タスク間のフローのほか、タスクとオブジェクト間のフローも作成します。 ただし、コメントとタスク間のリレーションシップを作成するために同じビルダーを使用することは混乱を招くことがあります。

複数の種類のリレーションシップに対して接続ビルダーを定義する場合、ソース オブジェクトとターゲット オブジェクトの同じペアから複数の型が一致しないことを確認する必要があります。 そうでない場合、結果は予測不可能になります。

カスタム コードを使用して「ハード」な制約を適用できますが、ユーザーが一時的に無効な接続を確立できる必要があるかどうかを考慮してください。 その必要がある場合、制約を変更して、ユーザーが変更内容を保存しようとするまで、接続が検証されないようにすることができます。

参照

概念

要素作成処理および要素移動処理のカスタマイズ

コピー動作のカスタマイズ

方法: ドラッグ アンド ドロップ ハンドラーを追加する

プログラム コードにおけるモデル内の移動およびモデルの更新

その他の技術情報

回路図のサンプル DSL