Xrm.Page.data.entity (クライアント側の参照)

  • [アーティクル]

 

公開日: 2016年11月

対象: Dynamics CRM 2015

Xrm.Page.data.entity は、ページに表示されるレコードに固有の情報を取得するメソッド、Save メソッド、およびフォームに含まれるすべての属性のコレクションを提供します。 属性データは、フォーム上のフィールドによって表される属性に制限されています。

Xrm.Page.data.entity のプロパティおよびメソッド

  • 属性
    エンティティの属性のコレクションです。

  • getDataXml
    レコードが保存されるときにサーバーに送信されるxmlを表す文字列を返します。

  • getEntityName
    レコードのエンティティの論理名を表す文字列を返します。

  • getId
    レコードのGUID ID 値を表す文字列を返します。

  • getIsDirty
    フォームのフィールドが変更されたかを示すブール値を返します。

  • OnSave
    addOnSave と removeOnSave メソッドを使用して、イベント ハンドラを保存イベントに追加または削除する

  • getPrimaryAttributeValue
    エンティティのプライマリ属性値の文字列を取得します。

  • 上書き保存​​
    保存が完了したら、フォームを閉じるか、新しいフォームを開くかのオプションを選択してレコードを保存します。

属性

Xrm.Page.data.entity.attributes コレクションは、フォームに表示されているレコードのデータにアクセスするためのメソッドを提供します。 このコレクションの詳細については、「コレクション (クライアント側の参照)」を参照してください。 このコレクションのオブジェクトに使用できるプロパティおよびメソッドについては、「Xrm.Page.data.entity 属性 (クライアント側の参照)」を参照してください。

getDataXml

レコードが保存されるときにサーバーに送信されるXMLを表す文字列を返します。 変更されたフィールドのデータのみがサーパーに設定されます。

注意

この関数は、タブレット PC 用 Microsoft Dynamics CRM では動作しません。

Xrm.Page.data.entity.getDataXml()

  • 戻り値
    種類: 文字列

    例: この例では、取引先企業レコードの次の 3 つのフィールドが更新されました。

    • 名前

    • accountnumber

    • telephone2

    "<account><name>Contoso</name><accountnumber>55555</accountnumber><telephone2>425 555-1234</telephone2></account>"

getEntityName

レコードのエンティティの論理名を表す文字列を返します。

Xrm.Page.data.entity.getEntityName()

  • 戻り値
    種類: 文字列。 エンティティの名前。

    例: この例では、取引先企業レコードが編集されました。

    "account"

getId

レコードのGUID ID 値を表す文字列を返します。

Xrm.Page.data.entity.getId()

  • 戻り値
    種類: 文字列

    例: レコードの GUID ID 値。

    "{825CB223-A651-DF11-AA8B-00155DBA3804}"

getIsDirty

フォームのフィールドが変更されたかを示すブール値を返します。

Xrm.Page.data.entity.getIsDirty()
  • 戻り値
    種類: ブール値

OnSave

addOnSave と removeOnSave メソッドを使用して、イベント ハンドラを保存イベントに追加または削除する

addOnSave

レコードが保存されるときに呼び出される関数を追加します。

Xrm.Page.data.entity.addOnSave([function reference])

  • パラメーター
    種類: 関数参照

    注意: その機能はイベント ハンドラー パイプラインの一番下に追加されます。 実行コンテキストは、このメソッドを使用するイベント ハンドラー セットに渡す最初のパラメーターとして渡すように自動的に設定されます。 詳細については、「実行コンテキスト (クライアント側の参照)」を参照してください。

    例:この例では、JavaScript のライブラリには 2 つの関数があります。addMessageToOnSave関数をフォーム OnLoad イベントに追加すると、OnSaveイベントのハンドラーとしてdisplayOrgName関数が追加されます。

    function displayOrgName(execContext)
{
    try {
        alert(execContext.getContext().getOrgUniqueName());
    }
    catch (e) {
        alert(e.message);
    }
}

function addMessageToOnSave() {
    Xrm.Page.data.entity.addOnSave(displayOrgName);
}

removeOnSave

レコードが保存されるときに呼び出される関数を削除します。

Xrm.Page.data.entity.removeOnSave([function reference])

  • パラメーター
    種類: 関数参照

    例:この例では、JavaScript のライブラリには 2 つの関数があります。removeMessageFromOnSave関数をフォーム イベントに追加すると、displayOrgName イベントのハンドラーとしてOnSave関数が削除されます。

    function displayOrgName(execContext)
{
    try {
        alert(execContext.getContext().getOrgUniqueName());
    }
    catch (e) {
        alert(e.message);
    }
}

function removeMessageFromOnSave() {
    Xrm.Page.data.entity.removeOnSave(displayOrgName);
}

getPrimaryAttributeValue

エンティティのプライマリ属性値の文字列を取得します。

Xrm.Page.data.entity.getPrimaryAttributeValue()

各エンティティは、PrimaryNameAttributeとして設計された 1 つの文字列属性があります。 この属性の値は、レコードへのリンクが表示されるときに使用されます。

  • 戻り値
    種類: 文字列。 エンティティのプライマリ属性の値。

  • 備考
    このメソッドは、更新されたエンティティ でのみ使用できます。

上書き保存​​

保存が完了したら、フォームを閉じるか、新しいフォームを開くかのオプションを選択してレコードを同期的に保存します。

Xrm.Page.data.save と Xrm.Page.data.entity.save の両方がレコードを保存しますが、Xrm.Page.data.saveは保存操作が完了するとコールバック関数を提供します。

Xrm.Page.data.entity.save( null | "saveandclose" |"saveandnew" )

  • 引数

    • save()
      パラメータが含まれていない場合、レコードが保存されるだけです。 これは、保存 コマンドを使うのと同じことです。

    • save("saveandclose")
      これは、保存して閉じる コマンドを使うのと同じことです。

    • save("saveandnew")
      これは、保存して新規作成 コマンドを使うのと同じことです。

  • 備考
    Web アプリケーションの簡易作成フォームを作成すると、saveandnew オプションは適用されません。 常に、saveandclose が使用されたように動作します。タブレット PC 用 Microsoft Dynamics CRM の簡易作成フォームは saveandnew 動作を適用します。

関連項目

クライアント側のプログラミング リファレンス
フォーム スクリプトの簡易参照
Xrm.Page.data.entity 属性 (クライアント側の参照)
Microsoft Dynamics CRM 2015 フォームのコードを記述する
Xrm.Page オブジェクト モデルの使用

© 2017 Microsoft. All rights reserved. 著作権