次の方法で共有

Xrm.Page.ui quickForms (クライアント側の参照)

  • [アーティクル]

 

公開日: 2017年1月

対象: Dynamics 365 (online)、Dynamics 365 (on-premises)、Dynamics CRM 2016、Dynamics CRM Online

Xrm.Page.ui.quickForms コレクションは、新しいフォーム レンダリング エンジン (「ターボ」と呼ばれる) を使用するときに、Microsoft Dynamics 365 上のすべての簡易表示コントロールおよび構成コントロールにアクセスする方法を提供します。 簡易表示コントロールは、Microsoft Dynamics 365 のメイン フォームに追加される簡易表示フォームで、メイン フォーム内のエンティティの関連レコードに関する情報を表示することができます。 簡易表示コントロールの構成コントロールでは編集できません。 簡易表示コントロールや簡易表示フォームの詳細については、「TechNet: 簡易表示フォームの作成および編集」を参照してください。

注意

この機能は、CRM Online 2016 更新プログラム 1 および CRM 2016 Service Pack 1 (設置型) で導入されました。

このトピックでは、Dynamics 365 で新しいフォームのレンダリング エンジンを使用する場合にのみ適用されます。Dynamics 365 でレガシ フォームのレンダリング (「フォームを更新」とも呼ばれる) を使用すると、標準コントロール オブジェクトを使用して簡易表示コントロールおよび構成コントロールにアクセスできます。Xrm.Page.ui コントロール (クライアント側の参照) を参照してください。

重要

Dynamics 365 でのレガシ フォームの廃止のお知らせに伴い、レガシ フォームのレンダリングを使用している場合は、新しいフォームのレンダリング エンジンを使用する計画をする必要があります。 レガシ フォームのレンダリングおよび新しいフォーム レンダリングでは、簡易表示コントロールへのアクセス方法に違いがあるため、新しいフォーム レンダリング エンジンに切り替える場合には、このトピックに記載されたメソッドを使用して、簡易表示コントロールの対象となる既存のコードを更新してテストする必要があります。 レガシ フォームのレンダリングの廃止についての詳細については、レガシ フォームのレンダリング オプションの削除 を参照してください。

このトピックの内容

quickForms コレクションのメソッド

quickForms オブジェクトのメソッド

quickForms コレクションのメソッド

quickForms コレクションは、フォームに存在するすべての簡易表示コントロールへのアクセスを提供します。quickForms コレクションは、Dynamics 365 のコレクションのすべての標準的な方法がサポートされています。 「コレクション (クライアント側の参照)」を参照してください。

次の例は、簡易表示コントロール インスタンスのインデックス値 (整数) または名前 (文字列) を引数として指定して、9b85e46f-ca6e-4313-af04-4290e3c6ab8b#BKMK_get メソッドを使用して、quickForms コレクションの簡易表示コントロール インスタンスを取得する方法を示します。

quickViewControl = Xrm.Page.ui.quickForms.get(arg)

quickForms オブジェクトのメソッド

quickForms オブジェクトは簡易表示コントロールのインスタンスを表します。 フォーム上の簡易表示フォームのインスタンスでは、次のメソッドがサポートされています。

  • getControl

  • getControlType

  • getName

  • getParent

  • getVisible

  • ラベル メソッド

  • isLoaded

  • 最新の情報に更新

getControl

簡易表示コントロールの構成コントロールを取得します。

quickViewControl.getControl()

簡易表示コントロール内の構成コントロールの名前またはインデックス値として引数を渡すことによって、構成コントロール コレクション内の単一のコントロールにアクセスできます。 たとえば、quickViewControl.getControl("firstname") や quickViewControl.getControl(0) などです。

  • 戻り値
    種類:引数なしでメソッドを使用する場合は オブジェクトコレクションであり、引数を指定してメソッドを使用する場合は、オブジェクトです。

  • 備考
    簡易表示コントロールの構成コントロールの取得後、構成コントロール データを変更しない構成コントロール上の Dynamics 365 コントロールをサポートする任意のメソッドを使用できます。 これは、簡易表示コントロールの構成コントロールが読み取りなためです。 たとえば、quickViewControl.getControl(0).getAttribute() を使用できます。Dynamics 365 コントロールがサポートするメソッドの詳細については、Xrm.Page.ui コントロール (クライアント側の参照) を参照してください。

    重要

    51828fe3-f6ff-4f97-80ed-b06b3a354955#BKMK_getAttribute または構成コントロール上の関連メソッドのデータは、メイン フォーム f451f339-bcee-4260-9904-abc8c0efa153#BKMK_OnloadEvent で動作しない可能性があります。メイン フォームが読み込まれたとき、バインドされている簡易表示フォームが完全には読み込まれていないためです。 簡易表示コントロール インスタンスの isLoaded メソッドを使用すると、バインドされている簡易表示フォームの読み込みが完了したかどうかを特定するのに役立ちます。 詳細: isLoaded

    または、フォームの簡易表示フォームの構成コントロールを新しいフォーム レンダリング エンジンを使用して取得する方法は、レガシ フォームの場合とは異なります。 レガシ フォームを使用して簡易表示コントロールで構成コントロールを対象としているコードがある場合は、Dynamics 365 の新しいフォーム レンダリング エンジンを使用することを決定する場合にコードを更新する必要があります。

getControlType

簡易表示コントロールを分類する文字列値を返します。

quickViewControl.getControlType()

簡易表示コントロールの場合、メソッドは quickform を返します。

簡易表示コントロールの構成コントロールでは、メソッドはコントロールの実際の分類を返します。 その他の可能な戻り値については、「51828fe3-f6ff-4f97-80ed-b06b3a354955#BKMK_getControlType」を参照してください。

getName

簡易表示コントロールに割り当てられた名前を返します。

quickViewControl.getName()
  • 戻り値
    種類: 文字列。 簡易表示コントロールの名前。

getParent

コントロールを含むセクション オブジェクトへの参照を返します。

コントロールの種類: すべて。

quickViewControl.getParent()

getVisible

簡易表示コントロールが現在表示可能かどうかを示す値を返します。

注意

このコントロールに含まれるセクションまたはタブが表示されない場合も、このメソッドは true を返します。 コントロールが実際に表示可能ですることを確かめるには、含まれる要素の可視性も確認する必要があります。

quickViewControl.getVisible()
  • 戻り値
    種類: ブール値。 簡易表示コントロールが可視である場合は True、それ以外の場合は false です。

ラベル メソッド

getLabel メソッドまたは setLabel メソッドを使用して、簡易表示コントロールのラベルを取得または変更します。

getLabel

簡易表示コントロールのラベルを返します。

quickViewControl.getLabel()
  • 戻り値
    種類: 文字列。 簡易表示コントロールのラベル。

setLabel

簡易表示コントロールのラベルを設定します。

quickViewControl.setLabel("label")
  • 引数
    種類: 文字列。 新しい簡易表示コントロールのラベル。

isLoaded

簡易表示コントロールの構成コントロールでデータ バインドが完了したかどうかを返します。

quickViewControl.isLoaded()

  • 戻り値
    種類: ブール値。 構成コントロールでデータ バインドが完了した場合には True、それ以外の場合は False です。

  • 備考
    簡易表示コントロールの構成コントロールのデータ バインドは、f451f339-bcee-4260-9904-abc8c0efa153#BKMK_OnloadEvent メイン フォームでは完了していない場合があります。コントロールがバインドされている簡易表示フォームが完全には読み込まれていないためです。 その結果、51828fe3-f6ff-4f97-80ed-b06b3a354955#BKMK_getAttribute または構成コントロールのデータ関連メソッドは動作しません。 簡易表示コントロールの isLoaded メソッドは、簡易表示コントロールの構成コントロールのバインド状況を特定するのに役立ちます。

次のコード サンプルは、isLoaded メソッドを使用して、バインド状況を確認し簡易表示コントロールの構成コントロールがバインドされている属性の値を取得する方法を示します。

function getAttributeValue() {
    var quickViewControl = Xrm.Page.ui.quickForms.get("<QuickViewControlName>");
    if (quickViewControl != undefined)
    {
        if (quickViewControl.isLoaded())
        {
            // Access the value of the attribute bound to the constituent control
            var myValue = quickViewControl.getControl(0).getAttribute().getValue();
            console.log(myValue);
            return;
        }
        else
        {
            // Wait for some time and check again
            setTimeout(getAttributeValue, 10);
        }
    }
    else
    {
        console.log("No data to display in the quick view control.");
        return;
    }    
}

最新の情報に更新

簡易表示コントロールに表示されているデータを最新の状態に更新します。

quickViewControl.refresh()

関連項目

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

Microsoft Dynamics 365

© 2017 Microsoft. All rights reserved. 著作権