EA_OnPreDeleteElement

<< 目次を表示 >>

ページ位置:  API・アドイン・スクリプト > アドイン > ブロードキャストされるイベント > 要素に関連するイベント >

EA_OnPreDeleteElement

このイベントはユーザーが要素を削除しようとした場合に発生します。イベントは削除の直前に発生しますので、削除を不許可とできます。

このイベント発生以降、ユーザー操作によって削除がキャンセルされる場合がありますので、ここで戻り値をTrueとしても削除されるかどうかは保証されません。

 

 

文法

public bool EA_OnPreDeleteElement(EA.Repository Repository, EA.EventProperties Info)

 

EA_OnPreDeleteElement メソッドには次の引数があります。

引数

方向

説明

Repository

EA.Repository

IN

現在開かれているプロジェクトのリポジトリオブジェクトです。

プロジェクトの情報を取得したい場合に利用します。

Info

EA.EventProperties

IN

削除しようとしている要素の情報が通知されます。

1つのEventPropertyオブジェクトが通知されます。以下の文字列がEventPropertyのName属性に設定され、値がValue属性に設定されます。

設定される文字列や値の詳細は「Element」をご覧ください。

文字列(Name)

説明

ElementID

Element.ElementIDの値

 

 

戻り値

削除を許可する場合にはTrueを戻します。Falseを戻した場合、削除を許可しません。