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

  • [アーティクル]

 

公開日: 2017年1月

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

Xrm.Page.uiには、ユーザー インターフェイスに関する情報を取得するプロパティおよびメソッド、およびフォームのいくつかのサブコンポーネントのコレクションが含まれます。

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

  • 閉じる
    フォームを閉じるメソッド。

  • controls
    ページのすべてのコントロールのコレクション。

  • formSelector
    formSelector.getCurrentItem メソッドを使用して、現在使用中のフォームに関する情報と、ユーザーに使用可能なフォームすべての情報を含む formSelector.items コレクションに関する情報を取得します。

  • getCurrentControl
    現在フォームにフォーカスしているコントロール オブジェクトを取得するメソッド。

    注意

    このメソッドは、Microsoft Dynamics CRM 2013 更新プログラムのロールアップ 2 では削除されました。

  • getFormType
    レコードのフォーム コンテキストを取得するメソッド。

  • navigation.items
    ページのすべてのナビゲーション アイテムのコレクション。

  • フォーム 通知
    setFormNotification を使用して、フォーム レベル通知の表示し、clearFormNotification を使用して、通知を削除します。

  • quickForms
    ページのすべての簡易表示コントロールのコレクション。

  • refreshRibbon
    リボンが表示内容を制御するデータを再評価するようにするメソッド。

  • タブ
    ページのすべてのタブのコレクション。

  • ViewPort メソッド
    ViewPort は、フォームデータが含まれているページの領域です。 これは、フォームの本文に対応し、ページのナビゲーション、ヘッダー、フッター、フォーム アシスタント領域は含みません。getViewPortHeightと getViewPortWidthメソッドを使用して、ViewPortの現在のサイズを取得します。

閉じる

フォームを閉じるメソッド。

Xrm.Page.ui.close()

備考:

HTMLWindow.close メソッドは削除されました。 フォーム ウィンドウを閉じるには、このメソッドを使用する必要があります。 フォームに未保存の変更内容がある場合は、ウィンドウを閉じる前にユーザーに変更を保存するかどうかの確認メッセージが表示されます。

タブレット PC 用 Microsoft Dynamics 365 では、このメソッドは、[戻る]ナビゲーションボタンの動作をまねます。

controls

ページのすべてのコントロールのコレクション。

コレクション メソッドに関する詳細については、「コレクション (クライアント側の参照)」、コレクションのコントロール オブジェクトに関する情報については、「Xrm.Page.ui コントロール (クライアント側の参照)」を参照してください。

formSelector

formSelector.getCurrentItem メソッドを使用して、現在使用中のフォームに関する情報と、ユーザーに使用可能なフォームすべての情報を含む formSelector.items コレクションに関する情報を取得します。

注意

formSelectoritems コレクションは存在しませんし、formSelector.getCurrentItem メソッドは Dynamics 365 モバイル クライアント (電話やタブレット) および対話型サービス ハブでサポートされていません。

formSelector.getCurrentItem

現在表示されているフォームへの参照を返すメソッド。

注意

フォームが一つしか存在しない場合、このメソッドはnullを返します。

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

formSelector.items

現在のユーザーがアクセスできるすべてフォーム アイテムのコレクション。

注意

ユーザーのセキュリティ ロールの 1 つとの関連付けを共有するフォームだけが、このコレクションで使用できます。

コレクション メソッドに関する詳細については、「コレクション (クライアント側の参照)」、コレクションのアイテムに関する情報については、「Xrm.Page.ui.formSelector アイテム (クライアント側の参照)」を参照してください。

getCurrentControl

現在フォームにフォーカスしているコントロール オブジェクトを取得するメソッド。 Web リソースおよびIFRAME コントロールは、このメソッドでは返されません。

注意

このメソッドは、Microsoft Dynamics CRM 2013 更新プログラムのロールアップ 2 では削除されました。

このメソッドは、ユーザーが編集した最後のフィールドがラジオ ボタンまたはチェック ボックス コントロールとしてフォーマットされたブール値属性の場合、現在のコントロールへの参照を返しません。 このメソッドでは、Xrm.Page.ui コントロール setFocus メソッドを使用した後すぐに参照を返すのに失敗します。

Xrm.Page.ui.getCurrentControl()
  • 戻り値
    種類:オブジェクト

getFormType

レコードのフォーム コンテキストを取得するメソッド。

Xrm.Page.ui.getFormType()

  • 戻り値
    種類:番号

    次の表は、戻り値と対応するフォームの種類を示します。

    値

    [フォームの種類]

    0

    未定義

    1

    作成

    2

    更新

    3

    読み取り専用

    4

    [無効]

    6

    一括編集

    注意

    簡易作成フォームは 1 を返します。 値 5 は、削除された簡易作成フォームの以前のタイプのために使用されていました。

ページのすべてのナビゲーション アイテムのコレクション。

注意

このコレクションは タブレット PC 用 Microsoft Dynamics 365には存在しません。

コレクション メソッドに関する詳細については、「コレクション (クライアント側の参照)」、コレクションのアイテムに関する情報については、「Xrm.Page.ui.navigation アイテム (クライアント側の参照)」を参照してください。

フォーム 通知

setFormNotification を使用して、フォーム レベル通知の表示し、clearFormNotification を使用して、通知を削除します。

clearFormNotification

このメソッドを使用して、フォーム レベル通知を削除します。

Xrm.Page.ui.clearFormNotification(uniqueId)

  • パラメーター

    • uniqueId
      種類: 文字列です。 通知を設定するsetFormNotification で使用されるメッセージの一意識別子です。

  • 戻り値
    種類: ブール値です。 メソッドが成功すると True、それ以外の場合は False です。

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

setFormNotification

このメソッドを使用して、フォーム レベル通知を表示します。 任意の数の通知を表示できます。また、それらの通知はclearFormNotificationを使用して削除するまで表示されます。 通知領域の高さは限られていますので、各新しいメッセージは、上部に追加されます。 ユーザーは、削除されていない以前のメッセージを見るにはスクロールする必要がある場合があります。

Xrm.Page.ui.setFormNotification(message, level, uniqueId);

  • パラメーター

    • message
      種類: 文字列です。 メッセージのテキスト。

    • level
      種類: 文字列です。 メッセージのレベル。

      レベルは、メッセージがどのように表示されるかを定義します。

      • ERROR : 通知はシステム エラーアイコンを使用します。

      • WARNING : 通知はシステム警告アイコンを使用します。

      • INFO : 通知はシステム情報アイコンを使用します。

    • uniqueId
      種類: 文字列です。 通知を削除するclearFormNotification で使用されるメッセージの一意識別子です。

  • 戻り値
    種類: ブール値です。 メソッドが成功すると True、それ以外の場合は False です。

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

quickForms

新しいフォームのレンダリング エンジンを使用するフォームのすべての簡易表示コントロールのコレクション(「ターボ フォーム」とも呼ばれる)。 このコレクションとこのコレクション内のオブジェクトでサポートされているメソッドとプロパティについては、Xrm.Page.ui quickForms (クライアント側の参照)を参照してください。

refreshRibbon

リボンが表示内容を制御するデータを再評価するようにするメソッド。

Xrm.Page.ui.refreshRibbon()

  • 戻り値
    種類: なし

    注意: この機能は、通常はリボン<EnableRule> (RibbonDiffXml) がフォームの値に依存する場合に使用します。 コードがルールによって使用される値を変更した後は、このメソッドを使用して、このルールが適用されるようにリボンがフォームのデータを再評価するようにします。

タブ

ページのすべてのタブのコレクション。

コレクション メソッドに関する詳細については、「コレクション (クライアント側の参照)」、コレクションのアイテムに関する情報については、「Xrm.Page.ui タブ (クライアント側の参照)」を参照してください。

ViewPort メソッド

ViewPort は、フォームデータが含まれているページの領域です。 これは、フォームの本文に対応し、ページのナビゲーション、ヘッダー、フッター、フォーム アシスタント領域は含みません。getViewPortHeightと getViewPortWidthメソッドを使用して、ViewPortの現在のサイズを取得します。

注意

これらのメソッドは タブレット PC 用 Microsoft Dynamics 365 では使用できません。

getViewPortHeight

ビューポートの高さをピクセルで取得するメソッド。

Xrm.Page.ui.getViewPortHeight()
  • 戻り値
    種類:番号

getViewPortWidth

ビューポートの幅をピクセルで取得するメソッド。

Xrm.Page.ui.getViewPortWidth()
  • 戻り値
    種類:番号

関連項目

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

Microsoft Dynamics 365

© 2017 Microsoft. All rights reserved. 著作権