イベントハンドラーによって変更内容がモデル外に反映される

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

視覚化およびモデリング SDK でストアイベントハンドラーを定義して、ストアの外部にあるリソースに変更を反映できます (ストア以外の変数、ファイル、他のストア内のモデル、他の Visual Studio 拡張機能など)。ストアイベントハンドラーは、トリガーイベントが発生したトランザクションの終了後に実行されます。それらは、[元に戻す] 操作または [やり直す] 操作でも実行されます。そのため、ストアルールとは異なり、ストアイベントは、ストアの外部にある値を更新する場合に最も役立ちます。 .NET イベントとは異なり、ストアイベントハンドラーはクラスをリッスンするように登録されます。インスタンスごとに個別のハンドラーを登録する必要はありません。変更を処理するさまざまな方法を選択する方法の詳細については、「変更に対する応答と反映」を参照してください。

グラフィック画面やその他のユーザーインターフェイスコントロールは、ストアイベントによって処理できる外部リソースの例です。

ストアイベントを定義するには

監視するイベントの種類を選択します。完全な一覧については、EventManagerDirectory のプロパティを参照してください。各プロパティは、イベントの種類に対応します。最も頻繁に使用されるイベントの種類は次のとおりです。
- ElementAdded -モデル要素、リレーションシップリンク、シェイプ、またはコネクタが作成されたときにトリガーされます。
- ElementPropertyChanged - Normal ドメインプロパティの値が変更されたときにトリガーされます。イベントは、新しい値と古い値が等しくない場合にのみトリガーされます。計算されたストレージプロパティとカスタムストレージプロパティにこのイベントを適用することはできません。
  
  リレーションシップリンクに対応するロールプロパティには適用できません。代わりに、ElementAdded を使用してドメインリレーションシップを監視します。
- ElementDeleted - モデル要素、リレーションシップ、図形、またはコネクタが削除された後にトリガーされます。要素のプロパティ値には引き続きアクセスできますが、他の要素とのリレーションシップはなくなります。
DslPackage プロジェクト内の別のコードファイルに YourDslDocData の部分クラス定義を追加します。
次の例に示すように、イベントのコードをメソッドとして記述します。 DocData にアクセスする場合を除き、static にすることができます。
OnDocumentLoaded() をオーバーライドしてハンドラーを登録します。複数のハンドラーがある場合は、それらすべてを同じ場所に登録できます。

登録コードの場所は重要ではありません。場所として DocView.LoadView() を選択できます。

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using Microsoft.VisualStudio.Modeling;

namespace Company.MusicLib
{
  partial class MusicLibDocData
  {
    // Register store events here or in DocView.LoadView().
    protected override void OnDocumentLoaded()
    {
      base.OnDocumentLoaded(); // Don't forget this.

      #region Store event handler registration.
      Store store = this.Store;
      EventManagerDirectory emd = store.EventManagerDirectory;
      DomainRelationshipInfo linkInfo = store.DomainDataDirectory
          .FindDomainRelationship(typeof(ArtistAppearsInAlbum));
      emd.ElementAdded.Add(linkInfo,
          new EventHandler<ElementAddedEventArgs>(AddLink));
      emd.ElementDeleted.Add(linkInfo,
          new EventHandler<ElementDeletedEventArgs>(RemoveLink));

      #endregion Store event handlers.
    }

    private void AddLink(object sender, ElementAddedEventArgs e)
    {
      ArtistAppearsInAlbum link = e.ModelElement as ArtistAppearsInAlbum;
      if (link != null)
            ExternalDatabase.Add(link.Artist.Name, link.Album.Title);
    }
    private void RemoveLink(object sender, ElementDeletedEventArgs e)
    {
      ArtistAppearsInAlbum link = e.ModelElement as ArtistAppearsInAlbum;
      if (link != null)
            ExternalDatabase.Delete(link.Artist.Name, link.Album.Title);
    }
  }
}

イベントを使用してストアで取り消し可能な調整を行う

イベントハンドラーはトランザクションがコミットされた後に実行されるため、通常は、ストア内の変更を反映するのにストアイベントは使用されません。代わりに、ストアルールを使用します。詳細については、「ルールによってモデル内の変更が反映される」を参照してください。

ただし、ユーザーが元のイベントとは別に追加の更新を元に戻せるようにする場合は、イベントハンドラーを使用してストアに対する追加の更新を行うことができます。たとえば、アルバムタイトルは小文字であることが通例であるとします。ユーザーによってタイトルが大文字で入力された後、それを小文字に修正するストアイベントハンドラーを記述できます。ただし、ユーザーは、[元に戻す] コマンドを使用して、修正をキャンセルして大文字を復元できます。 2 回目の [元に戻す] によって、ユーザーの変更が削除されます。

これに対し、同じことを行うストアルールを記述した場合、ユーザーによる変更とそれを修正する操作は同じトランザクション内で行われるため、ユーザーは元の変更を失うことなく調整を元に戻すことはできません。

partial class MusicLibDocView
{
    // Register store events here or in DocData.OnDocumentLoaded().
    protected override void LoadView()
    {
      /* Register store event handler for Album Title property. */
      // Get reflection data for property:
      DomainPropertyInfo propertyInfo =
        this.DocData.Store.DomainDataDirectory
        .FindDomainProperty(Album.TitleDomainPropertyId);
      // Add to property handler list:
      this.DocData.Store.EventManagerDirectory
        .ElementPropertyChanged.Add(propertyInfo,
        new EventHandler<ElementPropertyChangedEventArgs>
             (AlbumTitleAdjuster));

      /*
      // Alternatively, you can set one handler for
      // all properties of a class.
      // Your handler has to determine which property changed.
      DomainClassInfo classInfo = this.Store.DomainDataDirectory
           .FindDomainClass(typeof(Album));
      this.Store.EventManagerDirectory
          .ElementPropertyChanged.Add(classInfo,
        new EventHandler<ElementPropertyChangedEventArgs>
             (AlbumTitleAdjuster));
       */
      return base.LoadView();
    }

// Undoable adjustment after a property is changed.
// Method can be static since no local access.
private static void AlbumTitleAdjuster(object sender,
         ElementPropertyChangedEventArgs e)
{
  Album album = e.ModelElement as Album;
  Store store = album.Store;

  // We mustn't update the store in an Undo:
  if (store.InUndoRedoOrRollback
      || store.InSerializationTransaction)
      return;

  if (e.DomainProperty.Id == Album.TitleDomainPropertyId)
  {
    string newValue = (string)e.NewValue;
    string lowerCase = newValue.ToLowerInvariant();
    if (!newValue.Equals(lowerCase))
    {
      using (Transaction t = store.TransactionManager
            .BeginTransaction("adjust album title"))
      {
        album.Title = lowerCase;
        t.Commit();
      } // Beware! This could trigger the event again.
    }
  }
  // else other properties of this class.
}

ストアを更新するイベントを記述する場合:

[元に戻す] でモデル要素が変更されないようにするには、store.InUndoRedoOrRollback を使用します。トランザクションマネージャーによって、ストア内のすべてのものが元の状態に戻ります。
モデルがファイルから読み込まれている間に変更が行われないようにするには、store.InSerializationTransaction を使用します。
変更を加えると、さらにイベントがトリガーされます。無限ループにならないようにしてください。

ストアイベントの種類

各イベントの種類は、Store.EventManagerDirectory のコレクションに対応しています。イベントハンドラーはいつでも追加または削除できますが、通常はドキュメントの読み込み時に追加します。

`EventManagerDirectory` プロパティ名	実行するタイミング
ElementAdded	ドメインクラス、ドメインリレーションシップ、図形、コネクタ、または図のインスタンスが作成されます。
ElementDeleted	モデル要素がストアの要素ディレクトリから削除され、リレーションシップのソースまたはターゲットではなくなります。要素は実際にはメモリから削除されず、今後の [元に戻す] に備えて保持されます。
ElementEventsBegun	外側のトランザクションの終了時に呼び出されます。
ElementEventsEnded	他のすべてのイベントが処理されたときに呼び出されます。
ElementMoved	モデル要素は、あるストアパーティションから別のストアパーティションに移動されています。これは、図の図形の位置とは関係ありません。
ElementPropertyChanged	ドメインプロパティの値が変更されています。これは、古い値と新しい値が等しくない場合にのみ実行されます。
RolePlayerChanged	リレーションシップの 2 つのロール (両端) のいずれかが、新しい要素を参照しています。
RolePlayerOrderChanged	複数要素の接続性が 1 より大きいロールで、リンクの順序が変更されています。
TransactionBeginning
TransactionCommitted
TransactionRolledBack

注意

テキストテンプレート変換コンポーネントは、Visual Studio 拡張機能の開発ワークロードの一部として自動的にインストールされます。また、 [SDK、ライブラリ、およびフレームワーク] カテゴリの下にある Visual Studio インストーラーの [個別のコンポーネント] タブからインストールすることもできます。 [個別のコンポーネント] タブから Modeling SDK コンポーネントをインストールします。

次の方法で共有

イベントハンドラーによって変更内容がモデル外に反映される

ストアイベントを定義するには

イベントを使用してストアで取り消し可能な調整を行う

ストアイベントの種類

フィードバック

その他のリソース

次の方法で共有

イベント ハンドラーによって変更内容がモデル外に反映される

ストア イベントを定義するには

イベントを使用してストアで取り消し可能な調整を行う

ストア イベントの種類

関連するコンテンツ

フィードバック

その他のリソース

イベントハンドラーによって変更内容がモデル外に反映される

ストアイベントを定義するには

ストアイベントの種類