自訂刪除行為
刪除項目通常會導致相關項目也被刪除。 會刪除與它連接的所有關聯性以及任何子項目。 這種行為名為「刪除傳播」(delete propagation)。 您可以自訂刪除傳播以 (舉例而言) 安排刪除其他相關項目。 藉由撰寫程式碼，您可以根據模型的狀態執行刪除傳播。 您也可以促使其他變更因回應刪除而發生。
本主題包含下列章節：
預設刪除行為
設定角色的傳播刪除選項
覆寫刪除關閉 – 請在刪除可能導致刪除相鄰項目的情況下使用此方法。
使用 OnDeleting 和 OnDeleted – 請在回應可能包括其他動作 (例如在市集的內部或外部更新值) 的情況下使用這些方法。
刪除規則 – 在一項變更可能導致其他變更的情況下，在市集內使用規則來傳播任何類型的更新。
刪除事件 – 在市集外使用市集事件將 更新傳播至(舉例而言) 其他 Visual Studio 文件。
取消合併 – 使用「取消合併」作業可復原將子項目連結至其父項的合併作業。
預設刪除行為
根據預設，下列規則管理刪除傳播：
如果刪除了某個項目，也會刪除所有內嵌的項目。 內嵌的項目為內嵌關聯性的目標，而內嵌關聯性的來源是此項目。 例如，如果有從 Album 到 Song 的內嵌關聯性，則在刪除特定 Album 時，也會刪除其中的所有 Song。
相反地，刪除 Song 卻不會刪除 Album。
根據預設，刪除不會沿著參考關聯性傳播。 如果有從 Album 到 Artist 的參考關聯性 ArtistPlaysOnAlbum，刪除 Album 不會刪除任何相關 Artist，且刪除 Artist 不會刪除任何 Album。
不過，刪除確實會沿著某些內建關聯性傳播。 例如，刪除某個模型項目時，也會刪除它在圖表上的圖形。 項目與圖形因 PresentationViewsSubject 參考關聯性而彼此相關。
每個連接到項目 (無論位於來源或目標角色) 的關聯性都會被刪除。 位於相反角色之項目的角色屬性將不再包含刪除的項目。
設定角色的傳播刪除選項
您可以讓刪除沿著參考關聯性傳播，或是從內嵌子系傳播到其父系。
設定刪除傳播
在 DSL 定義圖上，選取您要傳播刪除的「角色」(role)。 該角色由網域關聯性方塊的左側或右側線條所表示。
例如，如果您要指定 Album 遭到刪除時，也刪除相關的 Artist，請選取連接到網域類別 Artist 的角色。
在 [屬性] 視窗中設定 [傳播刪除] 屬性。
按 F5 並確認：
刪除此關聯性的執行個體時，也會刪除位於所選角色的項目。
刪除位於相反角色的項目時，將會刪除此關聯性的執行個體，而且會刪除位於此角色的相關項目。
您也可以查看 [DSL 詳細資料] 視窗中的 [傳播刪除] 選項。 選取網域類別，然後在 [DSL 詳細資料] 視窗中，按一下視窗側邊的按鈕以開啟 [刪除行為] 頁面。 隨即顯示每一個關聯性的相反角色之 [傳播] 選項。 [刪除樣式] 資料行指出 [傳播] 選項是否為預設設定，但是沒有任何個別的作用。
使用程式碼來刪除傳播
DSL 定義檔案中的選項只能讓您選擇刪除是否傳播至相鄰項目。 若要實作更複雜的刪除傳播配置，可以撰寫程式碼。
.gif "注意事項") 注意事項 |
|---|
若要將程式碼加入 DSL 定義，請在 Dsl 專案中建立個別程式碼檔，並撰寫部分定義以擴大 Generated Code 資料夾中的類別。如需詳細資訊，請參閱Writing Code to Customise a Domain-Specific Language。 |
定義刪除關閉
在提供初始選擇的情況下，刪除作業使用類別 YourModelDeleteClosure 決定要刪除哪些項目。 它重複呼叫 ShouldVisitRelationship() 和 ShouldVisitRolePlayer()，查核關聯性的圖形。 您可以覆寫這些方法。 ShouldVisitRolePlayer 隨附於連結的識別以及位於其中一個連結之角色的項目。 它應傳回下列其中一個值：
VisitorFilterResult.Yes– 應刪除該項目，同時查核器應繼續嘗試該項目的其他連結。
VisitorFilterResult.DoNotCare – 不應刪除該項目，除非另一個查詢回覆應刪除它。
VisitorFilterResult.Never – 即使另一個查詢回答 Yes，也不得刪除該項目，同時查核器不應嘗試該項目的其他連結。
// When a musician is deleted, delete their albums with a low rating.
// Override methods in <YourDsl>DeleteClosure in DomainModel.cs
partial class MusicLibDeleteClosure
{
public override VisitorFilterResult ShouldVisitRolePlayer
(ElementWalker walker, ModelElement sourceElement, ElementLink elementLink,
DomainRoleInfo targetDomainRole, ModelElement targetRolePlayer)
{
ArtistAppearsInAlbum link = elementLink as ArtistAppearsInAlbum;
if (link != null
&& targetDomainRole.RolePlayer.Id == Album.DomainClassId)
{
// Count other unvisited links to the Album of this link.
if (ArtistAppearsInAlbum.GetLinksToArtists(link.Album)
.Where(linkAlbumArtist =>
linkAlbumArtist != link &&
!walker.Visited(linkAlbumArtist))
.Count() == 0)
{
// Should delete this role player:
return VisitorFilterResult.Yes;
}
else
// Don’t delete unless another relationship deletes it:
return VisitorFilterResult.DoNotCare;
}
else
{
// Test for and respond to other relationships and roles here.
// Not the relationship or role we’re interested in.
return base.ShouldVisitRolePlayer(walker, sourceElement,
elementLink, targetDomainRole, targetRolePlayer);
}
}
}
關閉技術可確認在刪除開始之前就已確定要刪除的項目和連結集。 查核器還會將您的關閉結果與來自模型其他部分的結果結合。
不過，此技術假設刪除僅影響關聯性圖形中的相鄰項目：您無法使用此方法刪除模型另一個部分中的項目。 如果您要加入項目或是進行其他變更以回應刪除，則無法使用它。
使用 OnDeleting 和 OnDeleted
您可以在網域類別或網域關聯性中覆寫 OnDeleting() 或 OnDeleted()。
當項目即將被刪除時會呼叫 OnDeleting，但是會在中斷連接其關聯性之前呼叫。 仍然可以在其他項目中來回巡覽它，而它也仍然在 store.ElementDirectory 中。
如果同時刪除數個項目，在執行刪除之前，會針對它們全部呼叫 OnDeleting。
IsDeleting 為 true。
刪除該項目時，會呼叫 OnDeleted。 它會留存在 CLR 堆積中，以便在需要時執行復原，但是它已與其他項目取消連結並從 store.ElementDirectory 中遭到移除。 針對關聯性，該角色仍然參考舊的角色扮演者。IsDeleted 為 true。
當使用者在建立項目之後呼叫復原，以及在取消復原中重複提早刪除時，會呼叫 OnDeleting 和 OnDeleted。 請使用 this.Store.InUndoRedoOrRollback 以避免在這些情況下更新市集項目。 如需詳細資訊，請參閱How to: Use Transactions to Update the Model。
例如，下列程式碼會在其最後一個子系 Song 被刪除時刪除 Album：
// Delete the parent Album when the last Song is deleted.
// Override methods in the embedding relationship between Album and Song:
partial class AlbumHasSongs
{
protected override void OnDeleted()
{
base.OnDeleted();
// Don't perform in-store actions in undo:
if (this.Store.InUndoRedoOrRollback) return;
// Relationship source and target still work:
// Don't bother if source is already on its way out:
if (!this.Album.IsDeleting && !this.Album.IsDeleted)
{
if (this.Album.Songs.Count == 0)
{
this.Album.Delete();
} } } }
從刪除關聯性觸發經常會比從角色項目觸發有用，因為前者在項目被刪除以及關聯性本身被刪除時都適用。 然而，如果是參考關聯性，您可能需要在相關項目被刪除時 (而不是在關聯性本身被刪除時) 傳播刪除。 本範例會在最後一位參與的 Artist 被刪除時刪除 Album，但是它不會在關聯性被刪除時回應：
using System.Linq; ...
// Assumes a many-many reference relationship
// between Artist and Album.
partial class Artist
{
protected override void OnDeleting()
{
base.OnDeleting();
if (this.Store.InUndoRedoOrRollback) return;
List<Album> toDelete = new List<Album>();
foreach (Album album in this.Albums)
{
if (album.Artists.Where(artist => !artist.IsDeleting)
.Count() == 0)
{
toDelete.Add(album);
}
}
foreach (Album album in toDelete)
{
album.Delete();
} } }
當您對某個項目執行 Delete 時，將會呼叫 OnDeleting 和 OnDeleted。 這些方法不會一律都內嵌執行，也就是不會在實際刪除前後立即執行。 如果您的程式碼刪除兩個或多個項目，將會在所有項目上輪流呼叫 OnDeleting 和 OnDeleted。
刪除規則和事件
OnDelete 處理常式的替代方法是，您可以定義刪除規則和刪除事件。
Deleting 和 Delete 規則只會在異動中觸發，不會在復原或取消復原中觸發。 您可以將它們排入佇列，在進行刪除的異動結尾處執行規則。 Deleting 規則的執行一律會早於在佇列中的任何 Deleted 規則。
請使用規則來傳播僅影響市集中項目的變更，包括關聯性、圖表項目及其屬性。 一般而言，Deleting 規則用來傳播刪除，而 Delete 規則用來建立取代項目和關聯性。
如需詳細資訊，請參閱Rules Propagate Changes Within the Model。
Deleted 市集事件會在異動結尾叫用，並在復原或取消復原之後呼叫。 因此可以使用它來傳播刪除到市集外的物件，如 Visual Studio 中的檔案、資料庫項目或其他物件。
如需詳細資訊，請參閱Event Handlers Propagate Changes Outside the Model。
警告
刪除某個項目時，您可以存取其網域屬性值，但是無法巡覽關聯性連結。不過，如果您對某個關聯性設定已刪除事件，您也可以存取原先為其角色扮演者的兩個項目。因此，如果您要回應模型項目的刪除，但是想要存取它連結的項目，請對關聯性 (而非模型項目的網域類別) 設定刪除事件。
Deletion 規則範例
[RuleOn(typeof(Album), FireTime = TimeToFire.TopLevelCommit)]
internal class AlbumDeletingRule : DeletingRule
{
public override void ElementDeleting(ElementDeletingEventArgs e)
{
base.ElementDeleting(e);
// ...perform tasks to propagate imminent deletion
}
}
[RuleOn(typeof(Album), FireTime = TimeToFire.TopLevelCommit)]
internal class AlbumDeletedRule : DeleteRule
{
public override void ElementDeleted(ElementDeletedEventArgs e)
{
base.ElementDeleted(e);
// ...perform tasks such as creating new elements
}
}
// The rule must be registered:
public partial class MusicLibDomainModel
{
protected override Type[] GetCustomDomainModelTypes()
{
List<Type> types = new List<Type>(base.GetCustomDomainModelTypes());
types.Add(typeof(AlbumDeletingRule));
types.Add(typeof(AlbumDeletedRule));
// If you add more rules, list them here.
return types.ToArray();
}
}
Deleted 事件範例
partial class NestedShapesSampleDocData
{
protected override void OnDocumentLoaded(EventArgs e)
{
base.OnDocumentLoaded(e);
DomainRelationshipInfo commentRelationship =
this.Store.DomainDataDirectory
.FindDomainRelationship(typeof(CommentsReferenceComponents));
this.Store.EventManagerDirectory.ElementDeleted.Add(commentRelationship,
new EventHandler<ElementDeletedEventArgs>(CommentLinkDeleted));
}
private void CommentLinkDeleted (object sender, ElementDeletedEventArgs e)
{
CommentsReferenceComponents link = e.ModelElement as CommentsReferenceComponents;
Comment comment = link.Comment;
Component component = link.Subject;
if (comment.IsDeleted)
{
// The link was deleted because the comment was deleted.
System.Windows.Forms.MessageBox.Show("Removed comment on " + component.Name);
}
else
{
// It was just the link that was deleted - the comment itself remains.
System.Windows.Forms.MessageBox.Show("Removed comment link to "
+ component.Name);
}
}
}
取消合併
將子項目連結至其父項的作業稱為「合併」(merge)。 從工具箱建立一個或一組新項目，從模型的另一個部分移動一個或一組新項目，或是從剪貼簿複製一個或一組新項目時，就會發生該動作。 除了在父系與其新子系之間建立和內嵌關聯性之外，合併作業還可以設定其他關聯性、建立輔助項目，以及在項目中設定屬性值。 合併作業封裝在項目合併指示詞 (EMD) 中。
EMD 也封裝補充的「取消合併」(unmerge) 或 MergeDisconnect 作業。 如果您有使用合併所建構的項目叢集，而且您想要使其餘的項目保持一致的狀態，建議您使用相關聯的取消合併從中移除項目。 取消合併作業通常會使用先前的章節所述的技巧。
如需詳細資訊，請參閱Customizing Element Creation and Movement。
請參閱
概念
Customizing Element Creation and Movement