実行コンテキスト (クライアント側の参照)

[アーティクル]
07/06/2017

公開日: 2016年11月

対象: Dynamics CRM 2015

実行コンテキストは、イベントハンドラーを使用して JavaScript ライブラリ関数に渡すことのできるオプションパラメーターです。このオプションは、関数の名前を指定するときに、ハンドラーのプロパティダイアログに表示されます。このオプションは、<Handler> (FormXml) 要素に対して、passExecutionContext 属性を使用して設定されます。

実行コンテキストは、Xrm.Page.data.addOnSave と Xrm.Page.data.entityAttribute.addOnChange、および Xrm.Page.ui Control.addPreSearch メソッドを使用して関数セットに自動的に渡されます。

実行コンテキストのメソッド

getContext
クライアント側コンテキスト(クライアント側の参照) オブジェクトを返すメソッドです。
getDepth
このハンドラーの実行順序を示す値を返すメソッドです。
getEventArgs
Save イベントを管理するメソッドを持つオブジェクトを返すメソッドです。
getEventSource
イベントが発生したオブジェクトへの参照を返すメソッドです。
共有変数
共有変数により、同じイベントの他のハンドラーと変数を共有できます。共有変数を操作するには、setSharedVariable と getSharedVariable メソッドを使用します。

getContext

クライアント側コンテキスト(クライアント側の参照) オブジェクトを返すメソッドです。

ExecutionContextObj.getContext()

戻り値
種類: オブジェクト

getDepth

このハンドラーの実行順序を示す値を返すメソッドです。

戻り値
種類: 番号

順序は 0 から始まります。

getEventArgs

Save イベントを管理するメソッドを持つオブジェクトを返すメソッドです。

注意

このメソッドは、Save イベント以外のイベントの null を返します。

ExecutionContextObj.getEventArgs()

戻り値
種類: オブジェクト

詳細:イベント引数の保存(クライアント側を参照)。

getEventSource

イベントが発生したオブジェクトへの参照を返すメソッドです。

ExecutionContextObj.getEventSource()

戻り値
種類: オブジェクト

このメソッドは、HTMLDOM オブジェクトではなく、イベントのソースである Xrm.Page オブジェクトモデルのオブジェクトを返します。たとえば OnChange イベントの場合、このメソッドは、変更された属性を表す Xrm.Page.data.entity 属性オブジェクトを返します。

共有変数

共有変数により、同じイベントの他のハンドラーと変数を共有できます。関数の間で変数を受け渡すには、setSharedVariable メソッドと getSharedVariable メソッドを使用します。

setSharedVariable

現在のハンドラーの終了後に別のハンドラーから使用できる変数の値を設定します。

ExecutionContextObj.setSharedVariable(key, value)

引数
String: 変数の名前

Object: 設定する値。

getSharedVariable

setSharedVariable を使用して設定された変数を返します。

ExecutionContextObj.getSharedVariable(key)

引数
String: 変数の名前。
戻り値
種類: オブジェクト

オブジェクトの値に基づいて決まる特定の種類です。

Share via