方法: シェイプまたはデコレーターに対するクリック操作を受け取る

[アーティクル]
05/19/2015

次の手順では、図形またはアイコンのデコレータのクリックを受け取る方法を示します。をダブルクリックし、ドラッグおよびそのほかのジェスチャを傍受して要素を答えさせます。

傍受すると、図形をクリックします

生成されたコードファイルとは別のコードファイルの Dsl プロジェクトでは、グラフィックスクラスの部分クラス定義を作成します。 On...で始まる名前を持つ 1 またはそのほかのメソッドの OnDoubleClick() 一つをオーバーライドします。次に例を示します。

public partial class MyShape // change
  {
    public override void OnDoubleClick(DiagramPointEventArgs e)
    {
      base.OnDoubleClick(e);
      System.Windows.Forms.MessageBox.Show("Click");
      e.Handled = true;
  }  }

注意

イベントに格納されているシェイプまたは図に渡されるしない場合は、 trueに e.Handled を設定します。

傍受すると、デコレータをオンにします

イメージデコレータは OnDoubleClick のメソッドを持つ ImageField のクラスのインスタンスで運ばれます。 ImageField のサブクラスを作成する場合のクリックを傍受できます。フィールドは InitializeShapeFields のメソッドで設定します。このため、レギュラー ImageField の代わりにサブクラスをインスタンス化するにそのメソッドを変更します。 InitializeShapeFields のメソッドは、図形のクラスのコード生成にあります。次の手順で説明するように Generates Double Derived のプロパティを設定して図形のクラスをオーバーライドできます。

InitializeShapeFields はインスタンスメソッドですが、一度だけ各クラスに対して呼び出されます。したがって、 ClickableImageField の 1 個のインスタンスのみ各クラスの各フィールド、図の各図形の 1 のインスタンスではありません。ユーザーがインスタンスをダブルクリックすると、例のコードに示すように、インスタンスが完全にヒットする識別します。

アイコンデコレータのクリックを傍受するには

DSL のソリューションを開くか作成します。
選択するか、またはアイコンのデコレータ持つを作成し、ドメインクラスに図形をマップする必要があります。

GeneratedCode フォルダーのファイルとは別のコードファイルで、 ImageField の新しいサブクラスを作成する:

using Microsoft.VisualStudio.Modeling;
using Microsoft.VisualStudio.Modeling.Design;
using Microsoft.VisualStudio.Modeling.Diagrams;
using System.Collections.Generic;
using System.Linq;

namespace Fabrikam.MyDsl { // Change to your namespace
internal class ClickableImageField : ImageField
{
  // You can also override OnClick and so on.
  public override void OnDoubleClick(DiagramPointEventArgs e)
  {
    base.OnDoubleClick(e);
    // Work out which instance was hit.
    MyShape shapeHit = e.HitDiagramItem.Shape as MyShape;
    if (shapeHit != null)
    {
      MyDomainClass element = 
          shapeHit.ModelElement as MyDomainClass;
      System.Windows.Forms.MessageBox.Show(
         "Double click on shape for " + element.Name);
      // If we do not set Handled, the event will
      // be passed to the containing shape:
      e.Handled = true;
    }
  }

   public ClickableImageField(string fieldName)
     : base(fieldName)
   { }
}

イベントに格納されているシェイプに渡されて処理しない場合は true に設定する必要があります。

次の部分クラス定義を追加して図形の classs の InitializeShapeFields のメソッドをオーバーライドします。

public partial class MyShape // change
{
 protected override void InitializeShapeFields
      (IList<ShapeField> shapeFields)
 {
  base.InitializeShapeFields(shapeFields);
  // You can see the above method in MyShapeBase 
  // in the generated Shapes.cs
  // It has already added fields for the Icons.
  // So you will have to retrieve them and replace with your own.
  ShapeField unwantedField = shapeFields.First
      (field => field.Name == "IconDecorator1");
  shapeFields.Remove(unwantedField);

  // Now replicate the generated code from the base class 
  // in Shape.cs, but with your own image constructor.
  ImageField field2 = new ClickableImageField("IconDecorator1");      
  field2.DefaultImage = ImageHelper.GetImage(
    MyDslDomainModel.SingletonResourceManager
    .GetObject("MyShapeIconDecorator1DefaultImage"));
      shapeFields.Add(field2);
}

ソリューションをビルドして実行します。
図形のインスタンスのアイコンをダブルクリックします。テストのメッセージが表示されます。

CompartmentShape の一覧に傍受をクリックし、ドラッグします

コンパートメント内の項目を並べ替える次のサンプル割り当てのユーザーをドラッグして、説明しました。このコードを実行する:

クラス図 のソリューションテンプレートを使用して新しい DSL のソリューションを作成します。

また、図形のコンパートメントを含むソリューションで使用できます。このコードは、図形によって表されるモデル要素間に埋め込むリレーションシップを持つコンパートメントのリスト項目で表される要素と仮定します。
図形のコンパートメントの 派生 double 型を生成します のプロパティを設定します。
Dsl のプロジェクトファイルで、次のコードを追加します。
DSL を独自に一致するようにこのコードのドメインクラスと図形の名前を調整します。

まとめると、コードは次のように動作します。この例では、 ClassShape は、図形のコンパートメントの名前です。

作成されると、一連のマウスイベントハンドラーは、コンパートメントのインスタンスに接続されます。
ClassShape.MouseDown のイベントは現在の項目を格納します。
マウスが現在の項目を表示するときに、カーソルを設定し、解放されるまでマウスをキャプチャ MouseAction のインスタンスが作成されます。

項目のテキストの選択などの他のマウス操作と、干渉することを避けるには MouseAction は、マウスが元の項目を離れたまで作成されません。

MouseAction を作成する代わりに MouseUp を待機する方法です。ただし、ユーザーがのコンパートメントの外部にあるデータをドラッグした後、マウスを解放すると正しく行われません。 MouseAction は、マウスが解放される場所に適切なアクションを実行できます。
マウスを離すと、 MouseAction.MouseUp は、モデル要素間のリンクの順序を再配置します。
ロールの順序の変更の表示を更新する規則を発生させます。この動作は、既に定義され、追加コードは必要ではありません。

using Microsoft.VisualStudio.Modeling;
using Microsoft.VisualStudio.Modeling.Design;
using Microsoft.VisualStudio.Modeling.Diagrams;
using System.Collections.Generic;
using System.Linq;

// This sample allows users to re-order items in a compartment shape by dragging.

// This example is built on the "Class Diagrams" solution template of VMSDK (DSL Tools).
// You will need to change the following domain class names to your own:
// ClassShape = a compartment shape
// ClassModelElement = the domain class displayed using a ClassShape
// This code assumes that the embedding relationships 
// displayed in the compartments don't use inheritance 
// (don't have base or derived domain relationships).

namespace Company.CompartmentDrag
{
 /// <summary>
 /// Manage the mouse while dragging a compartment item.
 /// </summary>
 public class CompartmentDragMouseAction : MouseAction
 {
  private ModelElement sourceChild;
  private ClassShape sourceShape;
  private RectangleD sourceCompartmentBounds;

  public CompartmentDragMouseAction(ModelElement sourceChildElement, ClassShape sourceParentShape, RectangleD bounds)
   : base (sourceParentShape.Diagram)
  {
   sourceChild = sourceChildElement;
   sourceShape = sourceParentShape;
   sourceCompartmentBounds = bounds; // For cursor.
  }
   
  /// <summary>
  /// Call back to the source shape to drop the dragged item.
  /// </summary>
  /// <param name="e"></param>
  protected override void OnMouseUp(DiagramMouseEventArgs e)
  {
   base.OnMouseUp(e);
   sourceShape.DoMouseUp(sourceChild, e);
   this.Cancel(e.DiagramClientView);
   e.Handled = true;
  }

  /// <summary>
  /// Ideally, this shouldn't happen. This action should only be active
  /// while the mouse is still pressed. However, it can happen if you
  /// move the mouse rapidly out of the source shape, let go, and then 
  /// click somewhere else in the source shape.
  /// </summary>
  /// <param name="e"></param>
  protected override void OnMouseDown(DiagramMouseEventArgs e)
  {
   base.OnMouseDown(e);
   this.Cancel(e.DiagramClientView);
   e.Handled = false;
  }

  /// <summary>
  /// Display an appropriate cursor while the drag is in progress:
  /// Up-down arrow if we are inside the original compartment.
  /// No entry if we are elsewhere.
  /// </summary>
  /// <param name="currentCursor"></param>
  /// <param name="diagramClientView"></param>
  /// <param name="mousePosition"></param>
  /// <returns></returns>
  public override System.Windows.Forms.Cursor GetCursor(System.Windows.Forms.Cursor currentCursor, DiagramClientView diagramClientView, PointD mousePosition)
  {
   // If the cursor is inside the original compartment, show up-down cursor.
   return sourceCompartmentBounds.Contains(mousePosition) 
    ? System.Windows.Forms.Cursors.SizeNS // Up-down arrow.
    : System.Windows.Forms.Cursors.No;
  }
 }

 /// <summary>
 /// Override some methods of the compartment shape.
 /// *** GenerateDoubleDerived must be set for this shape in DslDefinition.dsl. ****
 /// </summary>
 public partial class ClassShape
 {
  /// <summary>
  /// Model element that is being dragged.
  /// </summary>
  private static ClassModelElement dragStartElement = null;
  /// <summary>
  /// Absolute bounds of the compartment, used to set the cursor.
  /// </summary>
  private static RectangleD compartmentBounds;

  /// <summary>
  /// Attach mouse listeners to the compartments for the shape.
  /// This is called once per compartment shape.
  /// The base method creates the compartments for this shape.
  /// </summary>
  public override void EnsureCompartments()
  {
   base.EnsureCompartments();
   foreach (Compartment compartment in this.NestedChildShapes.OfType<Compartment>())
   {
    compartment.MouseDown += new DiagramMouseEventHandler(compartment_MouseDown);
    compartment.MouseUp += new DiagramMouseEventHandler(compartment_MouseUp);
    compartment.MouseMove += new DiagramMouseEventHandler(compartment_MouseMove);
   }
  }


  /// <summary>
  /// Remember which item the mouse was dragged from.
  /// We don't create an Action immediately, as this would inhibit the
  /// inline text editing feature. Instead, we just remember the details
  /// and will create an Action when/if the mouse moves off this list item.
  /// </summary>
  /// <param name="sender"></param>
  /// <param name="e"></param>
  void compartment_MouseDown(object sender, DiagramMouseEventArgs e)
  {
   dragStartElement = e.HitDiagramItem.RepresentedElements
     .OfType<ClassModelElement>().FirstOrDefault();
   compartmentBounds = e.HitDiagramItem.Shape.AbsoluteBoundingBox;
  }

  /// <summary>
  /// When the mouse moves away from the initial list item,
  /// but still inside the compartment, create an Action 
  /// to supervise the cursor and handle subsequent mouse events.
  /// Transfer the details of the initial mouse position to the Action.
  /// </summary>
  /// <param name="sender"></param>
  /// <param name="e"></param>
  void compartment_MouseMove(object sender, DiagramMouseEventArgs e)
  {
   if (dragStartElement != null)
   {
    if (dragStartElement != e.HitDiagramItem.RepresentedElements.OfType<ClassModelElement>().FirstOrDefault())
    {
     e.DiagramClientView.ActiveMouseAction = new CompartmentDragMouseAction(dragStartElement, this, compartmentBounds);
     dragStartElement = null;
    }
   }
  }

  /// <summary>
  /// User has released the mouse button. 
  /// </summary>
  /// <param name="sender"></param>
  /// <param name="e"></param>
  void compartment_MouseUp(object sender, DiagramMouseEventArgs e)
  {
    dragStartElement = null;
  }

  /// <summary>
  /// Forget the source item if mouse up occurs outside the
  /// compartment.
  /// </summary>
  /// <param name="e"></param>
  public override void OnMouseUp(DiagramMouseEventArgs e)
  {
   base.OnMouseUp(e);
   dragStartElement = null;
  }


  /// <summary>
  /// Called by the Action when the user releases the mouse.
  /// If we are still on the same compartment but in a different list item,
  /// move the starting item to the position of the current one.
  /// </summary>
  /// <param name="dragFrom"></param>
  /// <param name="e"></param>
  public void DoMouseUp(ModelElement dragFrom, DiagramMouseEventArgs e)
  {
   // Original or "from" item:
   ClassModelElement dragFromElement = dragFrom as ClassModelElement;
   // Current or "to" item:
   ClassModelElement dragToElement = e.HitDiagramItem.RepresentedElements.OfType<ClassModelElement>().FirstOrDefault();
   if (dragFromElement != null && dragToElement != null)
   {
    // Find the common parent model element, and the relationship links:
    ElementLink parentToLink = GetEmbeddingLink(dragToElement);
    ElementLink parentFromLink = GetEmbeddingLink(dragFromElement);
    if (parentToLink != parentFromLink && parentFromLink != null && parentToLink != null)
    {
     // Get the static relationship and role (= end of relationship):
     DomainRelationshipInfo relationshipFrom = parentFromLink.GetDomainRelationship();
     DomainRoleInfo parentFromRole = relationshipFrom.DomainRoles[0];
     // Get the node in which the element is embedded, usually the element displayed in the shape:
     ModelElement parentFrom = parentFromLink.LinkedElements[0];

     // Same again for the target:
     DomainRelationshipInfo relationshipTo = parentToLink.GetDomainRelationship();
     DomainRoleInfo parentToRole = relationshipTo.DomainRoles[0];
     ModelElement parentTo = parentToLink.LinkedElements[0];

     // Mouse went down and up in same parent and same compartment:
     if (parentTo == parentFrom && relationshipTo == relationshipFrom)
     {
      // Find index of target position:
      int newIndex = 0;
      var elementLinks = parentToRole.GetElementLinks(parentTo);
      foreach (ElementLink link in elementLinks)
      {
       if (link == parentToLink) { break; }
       newIndex++;
      }

      if (newIndex < elementLinks.Count)
      {
       using (Transaction t = parentFrom.Store.TransactionManager.BeginTransaction("Move list item"))
       {
        parentFromLink.MoveToIndex(parentFromRole, newIndex);
        t.Commit();
       }
      }
     }
    }
   }
  }

  /// <summary>
  /// Get the embedding link to this element.
  /// Assumes there is no inheritance between embedding relationships.
  /// (If there is, you need to make sure you've got the relationship
  /// that is represented in the shape compartment.)
  /// </summary>
  /// <param name="child"></param>
  /// <returns></returns>
  ElementLink GetEmbeddingLink(ClassModelElement child)
  {
   foreach (DomainRoleInfo role in child.GetDomainClass().AllEmbeddedByDomainRoles)
   {
    foreach (ElementLink link in role.OppositeDomainRole.GetElementLinks(child))
    {
     // Just the assume the first embedding link is the only one.
     // Not a valid assumption if one relationship is derived from another.
     return link;
    }
   }
   return null;
  }
 }
}

参照

その他の技術情報

変更内容への対応および変更内容の反映

次の方法で共有

方法: シェイプまたはデコレーターに対するクリック操作を受け取る

傍受すると、図形をクリックします

傍受すると、デコレータをオンにします

アイコンデコレータのクリックを傍受するには

CompartmentShape の一覧に傍受をクリックし、ドラッグします

参照

関連項目

その他の技術情報

その他のリソース

次の方法で共有

方法: シェイプまたはデコレーターに対するクリック操作を受け取る

傍受すると、図形をクリックします

傍受すると、デコレータをオンにします

アイコン デコレータのクリックを傍受するには

CompartmentShape の一覧に傍受をクリックし、ドラッグします

参照

関連項目

その他の技術情報

その他のリソース

アイコンデコレータのクリックを傍受するには