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

 

公開日: 2017年1月

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

controlオブジェクトには、コントロールの表示や動作を変更して、対応する属性を指定する方法が用意されています。

コントロールには、以下のコレクション、Xrm.Page.ui.controls、Xrm.Page.ui Section.controls、または Xrm.Page.data.entity Attribute.controlsを使用してアクセスします。Xrm.Page.getControl メソッドは、Xrm.Page.ui.controls.get にアクセスするためのショートカット メソッドです。

このトピックの構文例は、コントロールにアクセスする Xrm.Page.getControl メソッドの使用について示します。 コントロールはメソッドにパスされる引数により異なります。 単一コントロールにアクセスする args パラメーターは、コントロール名またはインデックス名のいずれかです。

フォームのヘッダーに業務プロセス フローのコントロールが表示される場合、業務プロセス フローに表示される各属性のために、さらにコントロールが追加されます。 これらのコントロールは、header_process_<attribute name> などの、一意の名前があります。

フォームのヘッダーに表示されるコントロールはアクセスでき、header_<attribute name> などの一意の名前があります。

属性にバインドされたコントロールの場合、コントロールは一般的に Xrm.Page.data.entity Attribute.controls コレクションを介してアクセスします。

Dynamics 365 モバイル クライアント (電話やタブレット PC) 用のカスタム コントロールは、次を除くすべてのコントロール プロパティとメソッドをサポートします。オートコンプリートのメソッド、getValue、キープレス メソッド、検索コントロールのメソッドおよびイベント。

Microsoft Dynamics CRM Online 2016 更新プログラム 1 および Microsoft Dynamics CRM 2016 Service Pack 1 (設置型) のリリースでは、次のメソッドが新しいフォーム表示エンジン (「ターボ フォーム」とも呼ばれる) の Timer コントロールで、サポートされています。getControlType、getName、getParent、ラベル メソッド、refresh、および 表示する メソッドです。

コントロールのプロパティとメソッド

• オートコンプリートのメソッド
  Dynamics 365 フォーム内のテキスト コントロールのオート コンプリート機能を構成します。 これらのメソッドは、Dynamics 365 で導入されました。

• 無効
  状態を検出し、getDisabled および setDisabled メソッドを使用して、コントロールを有効または無効にします。

• getAttribute
  コントロールがバインドされる属性を取得します。

• getControlType
  コントロールの種類に関する情報を入手します。

• getName
  コントロール名の取得

• getParent
  コントロールが含まれるセクション オブジェクトを取得します。

• getValue
  ユーザーが特定のテキスト フィールドまたは数値フィールドに文字を入力したときに、コントロールの最新の値を取得します。 このメソッドは、Dynamics 365 で導入されました。

• キープレス メソッド
  ユーザーがコントロール内のキーを押したときに、機能を追加、削除、または実行します。 これらのメソッドは、Dynamics 365 で導入されました。

• サポート情報のコントロールのメソッド
  これらのメソッドは、ナレッジ マネージメント機能が有効化されている Dynamics 365 インスタンスのサポート情報検索コントロールに対してのみ使用できます。

  このコントロールの詳細については、「サポート情報の検索コントロール (クライアント側の参照)」を参照してください。

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

• 検索コントロールのメソッドおよびイベント
  addCustomFilter、addCustomView、getDefaultView、setDefaultView メソッドを使用して、いつ検索コントロールの値をセットするかを選択するユーザーのために、結果表示をコントロールします。

  PreSearch イベント 用イベント ハンドラーは、addPreSearch および removePreSearch メソッドを使用して追加または削除できます。

• 通知
  setNotification、addNotification、および clearNotification メソッドを使用して、コントロールに関するユーザー通知を表示または削除します。

• OptionSet コントロール メソッド
  addOption、clearOptions、および removeOption メソッドを使用して、OptionSet コントロールに表示されるオプションを変更します。

• ShowTime
  setShowTime を使用して、日付コントロールに日付の時刻の部分を表示するかどうかを指定します。getShowTime を使用して、日付の時刻の部分が現在表示されているかどうかを決定します。

• サブグリッド コントロールのメソッド
  CRM Online 2015 更新プログラム 1 を使用する組織の場合、サブグリッド コントロールを操作する新機能があります。詳細:グリッド (読み取り専用) のオブジェクトとメソッド (クライアント側の参照)

  その他の組織の場合は、refresh メソッドがサブグリッド コントロールで使用できる唯一の固有のメソッドです。 このメソッドは、サブグリッドに表示されるデータを更新します。

• 表示する
  getVisible および setVisible メソッドを使用して、どのコントロールを表示または非表示にするか決定します。

• Web リソースおよび IFRAME コントロール メソッド
  getData、setData、getInitialUrl、getObject、setSrc および getSrc メソッドを使用して、Web リソースと IFRAME コントロール間の通信をします。

オートコンプリートのメソッド

showAutoComplete および hideAutoComplete メソッドを使用して、フォームのテキスト コントロールにオートコンプリート エクスペリエンスを構成します。

オートコンプリート機能を示すサンプルの JavaScript コードについては、「サンプル: Dynamics 365 コントロールでのオートコンプリート」を参照してください。

showAutoComplete

ユーザーが特定のテキスト フィールドに文字を入力するためにキーを押すとき、ドロップダウン リストに最大 10 文字の一致文字列を表示するために使用します。 ドロップダウン リストの下部にあるアイコンを使用したカスタム コマンドを追加することもできます。 ドロップダウン リストで項目を選択すると、テキスト フィールド内の値が選択した項目になり、ドロップダウン リストが消えて、テキスト フィールドの OnChange イベントが呼び出されます。

Xrm.Page.getControl(arg).showAutoComplete(object)

• パラメーター
  種類: 結果セットを定義するオブジェクトで、オートコンプリート ドロップダウン リストに表示されるresultsとcommandsを含みます。

  注釈:addOnKeyPress メソッドを使用して、keypress イベントに対して実行するように追加した関数で、このメソッドを呼び出します。

  例: 次の例は、showAutoComplete メソッドに渡されるオブジェクトの定義を示しています。

  var resultset = { 
     results: [{ 
           id: <value1>, 
           icon: <url>, 
           fields: [<fieldValue1>]}, 
  
           {...}, 
  
           { 
           id: <valueN>, 
           icon: <url>, 
           fields: [<fieldValue1, fieldValue2,..., fieldValueN>]}],
     commands:{ 
           id: <value>, 
           icon: <url>, 
           label: <value>, 
           action: <function reference> 
     } 
  }
  

hideAutoComplete

特定のテキスト フィールドのために構成した自動入力ドロップダウン リストを非表示にするために、この機能を使用します。

Xrm.Page.getControl(arg).hideAutoComplete()

無効

getDisabled および setDisabled を使用して、コントロールが無効であるか検知し、それを有効または無効にします。

コントロールの種類: 標準、検索、オプション セット。

getDisabled

コントロールが無効かどうかを返します。

Xrm.Page.getControl(arg).getDisabled()

• 戻り値
  種類: ブール値。 コントロールが無効である場合は true、それ以外の場合は false です。

setDisabled

コントロールが無効かどうかを設定します。

Xrm.Page.getControl(arg).setDisabled(bool)

• 引数
  種類: ブール値。 コントロールを無効にする場合は true、それ以外の場合は false です。

getAttribute

コントロールがバインドされる属性を戻します。

コントロールの種類: 標準、検索、オプション セット。

Xrm.Page.getControl(arg).getAttribute()

• 戻り値
  種類: 対象: 属性。

備考

簡易表示コントロール内のコントロール コレクションには、コントロール コレクションが含まれ、これらのコントロールには getAttribute メソッドがあります。 ただし、その属性はエンティティの属性コレクションの一部ではありません。 その属性の値は getValue を使用して取得し、setValue を使用して変更することさえできますが、加えられた変更はエンティティで保存されません。

次のコードは、取引先担当者の mobilephone 属性が、contactQuickForm という名前の簡易表示コントロールを使用する取引先企業のエンティティ フォームに表示されるときに、その値を使用することを示します。 このコードは、属性値が null の場合にコントロールを非表示にします。

var quickViewMobilePhoneControl = Xrm.Page.getControl("contactQuickForm_contactQuickForm_contact_mobilephone");
 if (quickViewMobilePhoneControl.getAttribute().getValue() == null)
 {
  quickViewMobilePhoneControl.setVisible(false);
 }

getControlType

コントロールを分類する値を戻します。

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

Xrm.Page.getControl(arg).getControlType()

• 戻り値
  種類: 文字列

  getControlType の可能な戻り値:

  戻り値	説明
  standard	標準のコントロール。
  iframe	IFRAME コントロール
  lookup	検索コントロール。
  optionset	オプション セット コントロール。
  subgrid	サブグリッド コントロール。
  webresource	Web リソース コントロール。
  notes	メモ コントロール。
  timercontrol	タイマー コントロール。
  kbsearch	サポート情報検索コントロール。
  customcontrol: <namespace>.<name>	Dynamics 365 モバイル クライアント (電話やタブレット PC) のカスタム コントロールです。
  customsubgrid:<namespace>.<name>	Dynamics 365 モバイル クライアント (電話やタブレット PC) のカスタム データセット コントロールです。

getName

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

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

Xrm.Page.getControl(arg).getName()

• 戻り値
  種類: 文字列。 コントロールの名前です。

getParent

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

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

Xrm.Page.getControl(arg).getParent()

• 戻り値
  種類:Xrm.Page.ui セクション (クライアント側の参照) オブジェクト。

getValue

ユーザーが特定のテキスト フィールドまたは数値フィールドに文字を入力したときに、コントロールの最新の値を取得します。 このメソッドでは、データを検証し、コントロールに文字を入力するときにユーザーに警告することによって、インタラクティブなエクスペリエンスを作成できます。

getValue メソッドは、属性の getValue メソッドとは異なります。コントロール メソッドはユーザーがコントロールに入力するときにコントロールから値を取得するのに対し、属性の getValue メソッドはユーザーがフィールドをコミット (保存) した後に値を取得します。

getValue メソッドを使用してオートコンプリート エクスペリエンスを構成するサンプル JavaScript コードについては、「サンプル: Dynamics 365 コントロールでのオートコンプリート」を参照してください。

Xrm.Page.getControl(arg).getValue()

• 戻り値
  種類: 文字列。 コントロールの最新のデータ値です。

キープレス メソッド

addOnKeyPress、removeOnKeyPress、および fireOnKeyPress メソッドを使用して、ユーザーがコントロールに入力するにつれて即時フィードバックを提供または操作を実行します。 これらのメソッドを使用すると、ユーザーがフォームで値をコミット (保存) する前に、コントロールのデータ検証を実行できます。

addOnKeyPress

特定のテキスト フィールドまたは数値フィールドに文字を入力したときに機能が呼び出されるようにする、キープレス イベントのイベント ハンドラーとしての機能を追加するために使用します。

addOnKeyPress メソッドを使用してオートコンプリート エクスペリエンスを構成するサンプル JavaScript コードについては、「サンプル: Dynamics 365 コントロールでのオートコンプリート」を参照してください。

Xrm.Page.getControl(arg).addOnKeyPress([function reference])

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

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

  後でフィールドのイベント ハンドラーを削除する場合は、匿名関数ではなく、名前付き関数への参照を使用する必要があります。

removeOnKeyPress

addOnKeyPress を使用して追加した、テキスト フィールドまたは数値フィールド用イベント ハンドラーを削除するために使用します。

Xrm.Page.getControl(arg).removeOnKeyPress([function reference])

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

  注釈: 匿名関数が addOnKeyPress を使用して設定されている場合、このメソッドを使用して削除することはできません。

fireOnKeyPress

keypress イベントで実行される特定のテキスト フィールドまたは数値フィールドのために作成したイベント ハンドラーを、手動で起動するために使用します。

Xrm.Page.getControl(arg).fireOnKeyPress()

サポート情報のコントロールのメソッド

これらのメソッドは、サポート情報検索コントロールに対してのみ使用できます。そのコントロールは、Dynamics 365 組織でナレッジ マネージメント機能が有効化されている場合に使用できます。 これらのコントロールの詳細については、「サポート情報の検索コントロール (クライアント側の参照)」を参照してください。

ラベル

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

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

getLabel

コントロールのラベルを返します。

Xrm.Page.getControl(arg).getLabel()

• 戻り値
  種類: 文字列。 コントロールのラベル。

setLabel

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

Xrm.Page.getControl(arg).setLabel(label)

• 引数
  種類: 文字列。 コントロールの新しいラベル。

検索コントロールのメソッドおよびイベント

addCustomFilter、addCustomView、getDefaultView、およびsetDefaultView メソッドを使用して、いつ検索コントロールの値をセットするかを選択するユーザーのために、結果表示をコントロールします。 また、Lookupコントロールにより PreSearch イベント が表示されるため、addPreSearch および removePreSearch メソッドを使用して、プログラムによりイベント ハンドラーを追加できます。

コントロールの種類: 検索。

addCustomFilter

検索に表示される結果に、add フィルターを使用します。 各フィルターは "AND" 条件として、前に追加したフィルターと結合します。

Xrm.Page.getControl(arg).addCustomFilter(filter, entityLogicaName)

• 引数

  • filterXml
    種類: 文字列: 適用する fetchXml フィルター要素。 たとえば、次のようになります。

    <filter type="and">
     <condition attribute="address1_city" operator="eq" value="Redmond" />
    </filter>
    

  • entityLogicalName
    種類: 文字列: (オプション) これがセットされる場合、フィルターはそのエンティティの種類にのみ適用されます。 それ以外の場合、返されたすべての種類のエンティティに適用されます。

• 備考
  詳細:FetchXML schema。

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

  このメソッドは、検索コントロール PreSearch イベント用のイベント ハンドラー内の関数でのみ使用できます。

  次のコード サンプルは、営業案件フォームの [取引先企業] (parentaccountid) 検索用です。Sdk.setParentAccountIdFilter 関数がフォーム Onload イベント ハンドラーに設定されている場合、Sdk.filterCustomAccounts 関数が検索用 PreSearch イベントに追加されます。 結果として、[カテゴリ] (accountcategorycode) の値が [優先する顧客] (1) である取引先企業のみが戻されます。

  var Sdk = window.Sdk || {};
  
  Sdk.filterCustomerAccounts = function () {
      //Only show accounts with the type 'Preferred Customer'
      var customerAccountFilter = "<filter type='and'><condition attribute='accountcategorycode' operator='eq' value='1'/></filter>";
      Xrm.Page.getControl("parentaccountid").addCustomFilter(customerAccountFilter, "account");
  }
  //set 'Sdk.setParentAccountIdFilter' in the Opportunity form onload event handler
  Sdk.setParentAccountIdFilter = function () {
      Xrm.Page.getControl("parentaccountid").addPreSearch(Sdk.filterCustomerAccounts);
  }
  

addCustomView

検索ダイアログ ボックスに新しいビューを追加します。

Xrm.Page.getControl(arg).addCustomView(viewId, entityName, viewDisplayName, fetchXml, layoutXml, isDefault)

• 引数

  • viewId
    種類:文字列: ビューの GUID 列を表す文字列。

    注意

    この値は保存されず、検索で利用できる他のビュー内で一意である必要があります。 有効ではない GUID 用の文字列は、“{00000000-0000-0000-0000-000000000001}” などの形をとります。 有効な GUID を生成するため、guidgen.exe などのツールを使用することをお勧めします。guidgen.exe ツールは Windows SDKに含まれています。

  • entityName
    種類: 文字列: エンティティの名前。

  • viewDisplayName
    種類: 文字列: ビューの名前。

  • fetchXml
    文字列: ビューの fetchXml クエリ。

  • layoutXml
    種類:文字列: ビューのレイアウトを定義する XML。

  • 既定
    種類:ブール型: ビューを既定のビューにする必要があるかどうか。

• 備考
  このメソッドは、[所有者] 検索では使用できません。 所有者検索は、ユーザー所有レコードの割り当てに使用されます。

DefaultView

ユーザーが検索でレコードを選択できるように表示される既定ビューがどのビューかを検知できます。getDefaultView および setDefaultView を使用して既定のビューを変更できます。

getDefaultView

既定の検索ダイアログ ビューの ID 値を返します。

Xrm.Page.getControl(arg).getDefaultView()

• 戻り値
  種類: 文字列。 既定のビューの ID 値。

setDefaultView

検索コントロール ダイアログ ボックスの既定のビューを設定します。

Xrm.Page.getControl(arg).setDefaultView(viewGuid)

• 引数
  種類: 文字列。 既定のビューとして設定されるビューの ID。

例: この setDefaultViewSample 機能は、 account エンティティ フォームの取引先責任者検索の既定のビューを 自分のアクティブな取引先担当者 に設定します。

function setDefaultViewSample() {
    Xrm.Page.getControl("primarycontactid").setDefaultView("{00000000-0000-0000-00AA-000010001003}");
}​

PreSearch イベント

検索コントロール PreSearch イベント 用イベント ハンドラーは、addPreSearch および removePreSearch メソッドを使用して追加または削除できます。

PreSearch イベントを使用して、ユーザーがレコード検索を開始するときのフォーム データを使用するコントロールのために、どの結果を表示するかをコントロールします。

両方のメソッドは、最初のパラメーターとして 実行コンテキスト (クライアント側の参照) をパスします。

addPreSearch

このメソッドを使用して、ユーザーが検索結果を表示しようとするときの値に基づき、検索に変更を適用します。

Xrm.Page.getControl(arg).addPreSearch(handler)

• 引数
  種類: 追加する機能。

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

引数は、検索発生時に検索が結果を提供する直前に実行される関数です。 このハンドラーを使用してその他の検索コントロールのいずれかを呼び出すことができ、検索に表示される結果を改善できます。

removePreSearch

このメソッドを使用して、PreSearch イベントに設定ずみのイベント ハンドラー関数を削除します。

Xrm.Page.getControl(arg).removePreSearch(handler)

• 引数
  種類: 削除する関数。

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

通知

これらのメソッドを使用して、コントロールの通知を表示およびクリアします。

setNotification

データが無効であることを示すコントロールのエラー メッセージを表示します。 このメソッドを使用するとき、赤い "X" アイコンがコントロールの隣に表示されます。Dynamics 365 モバイル クライアント上でアイコンをタップするとメッセージが表示されます。

Xrm.Page.getControl(arg).setNotification(message,uniqueId)

備考

コントロールにエラー通知を設定すると、フォームの保存がブロックされます。

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

引数

• メッセージ
  種類: 文字列: 表示されるメッセージ。

• uniqueId
  種類: 文字列: clearNotification を使用時に、このメッセージのみをクリアするために使用する ID。 省略可。

戻り値

種類: ブール型: メソッドが成功したかどうかを示します。

addNotification

エラー または 推奨 通知をコントロールに対して表示し、通知に基づいて実行するアクションを指定することができます。 通知のエラーの種類を指定するときは、赤の "X" アイコンはコントロールの横に表示されます。 通知の推奨の種類を指定するときは、"i" アイコンはコントロールの横に表示されます。Dynamics 365 モバイル クライアント上でアイコンをタップすると、メッセージが表示され、[適用] ボタンをクリックするまたはメッセージを閉じることによって、設定済みのアクションを実行することができます。

Xrm.Page.getControl(arg).addNotification(object)

備考

コントロール上でエラー通知を設定することによって、フォームの保存がブロックされます。推奨通知を設定すると、フォームの保存はブロックされません。

このメソッドは Dynamics 365 用 2016 年 12 月の更新プログラム (オンラインおよび設置型) で導入され、更新されたエンティティ でのみ利用することができます。

引数

メソッドは次の属性を使用してオブジェクトを受け取ります:

属性	[データの種類]	必須出席者	説明
messages	Array	不可	通知で表示されるメッセージ。 現在のリリースでは、配列で指定され最初のメッセージのみが表示されます。 ここで指定する文字列は太字のテキストとして通知に表示され、通常、通知のタイトルまたは件名に使用されます。 最適な結果を得るため、メッセージは 50 文字に制限する必要があります。
notificationLevel	文字列	不可	通知の種類を定義します。 有効な値は、ERROR または RECOMMENDATION。 オブジェクト定義でこの属性を指定しない場合、既定では ERROR に設定されます。
uniqueId	文字列	不可	clearNotification を使用するときにこの通知をクリアするのに使用される ID です。
actions	オブジェクトの配列	不可	次の属性を含むオブジェクトのコレクションです: message: 文字列。 ユーザーに表示される通知の副文または本文です。 最適な結果を得るため、メッセージは 100 文字に制限します。 actions: 配列。 メッセージに対応するアクションです。 現在のリリースでは、単一のメッセージ本文と対応するアクションのみがサポートされています。 ただし、操作ブロックで JavaScript コードを使用して実行される複数のタスクを定義できます。

戻り値

種類: ブール型: メソッドが成功したかどうかを示します。

例

次のサンプル コードによって、[取引先企業名] フィールドに "Microsoft" が含まれている場合は、取引先企業フォームの [取引先企業名] フィールド上で通知が表示され、[株式銘柄コード] を設定します。 通知で [適用] をクリックすると [株式銘柄コード] フィールドは "MSFT" に設定されます。

function addTickerSymbolRecommendation() {
    var myControl = Xrm.Page.getControl('name');
    var accountName = Xrm.Page.data.entity.attributes.get('name');
    var tickerSymbol = Xrm.Page.data.entity.attributes.get('tickersymbol');

    if (accountName.getValue('Microsoft') && tickerSymbol.getValue() != 'MSFT') {
        var actionCollection = {
            message: 'Set the Ticker Symbol to MSFT?',
            actions: null
        };

        actionCollection.actions = [function () {
            tickerSymbol.setValue('MSFT');
            myControl.clearNotification('my_unique_id');
        }];

        myControl.addNotification({
            messages: ['Set Ticker Symbol'],
            notificationLevel: 'RECOMMENDATION',
            uniqueId: 'my_unique_id',
            actions: [actionCollection]
        });
    }
    else
        console.log("Notification not set");
}

clearNotification

コントロールに対して既に表示されているメッセージを削除。

Xrm.Page.getControl(arg).clearNotification(uniqueId)

引数

• uniqueId
  種類: 文字列: setNotification または addNotification を使用して特定のメッセージ セットをクリアするために使用する ID。

  uniqueId パラメーターが指定されない場合、表示されている現在の通知は削除されます。

備考

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

戻り値

種類: ブール型: メソッドが成功したかどうかを示します。

OptionSet コントロール メソッド

addOption、clearOptions、および removeOption メソッドを使用して、OptionSet コントロールで利用できるオプションを操作します。

addOption

オプション セット コントロールにオプションを追加します。

Xrm.Page.getControl(arg).addOption(option, [index])

• 引数

  • option
    種類: 対象: OptionSet に追加するオプションのオブジェクト。

  • インデックス
    種類: 数: (オプション) 新しいオプションを配置するインデックスの位置。 指定されていない場合、オプションは末尾に追加されます。

clearOptions

オプション セット コントロールからすべてのオプションをクリアします。

Xrm.Page.getControl(arg).clearOptions()

removeOption

オプション セット コントロールからオプションを削除します。

Xrm.Page.getControl(arg).removeOption(number)

• 引数
  タイプ: 数: 削除するオプション値。

setFocus

コントロールにフォーカスを設定します。

Xrm.Page.getControl(arg).setFocus()

ShowTime

setShowTime を使用して、日付コントロールに日付の時刻の部分を表示するかどうかを指定します。getShowTime を使用して、日付の時刻の部分が現在表示されているかどうかを決定します。

getShowTime

日付コントロールに日付の時刻の部分が表示されているかどうかを取得します。

コントロールの種類:datetime 属性の標準コントロール。

var showsTime = Xrm.Page.getControl(arg).getShowTime();

備考

このメソッドは、Microsoft Dynamics CRM Online 2015 更新プログラム 1 で導入されました。

setShowTime

日付コントロールで日付の時間の部分を表示するかどうかを指定します。

コントロールの種類:datetime 属性の標準コントロール。

Xrm.Page.getControl(arg).setShowTime(bool)

備考

このメソッドは、更新されたエンティティ でのみ使用できます。 このメソッドは、属性で DateAndTime 形式が使用されている日付コントロールの時刻コンポーネントを表示または非表示にします。 このメソッドは、DateOnly 形式が使用されている場合は無効です。

サブグリッド コントロールのメソッド

Microsoft Dynamics CRM Online 2015 更新プログラム 1 より前のリリースの場合は、サブグリッド コントロールで使用できる唯一のメソッドが refresh です。CRM Online 2015 更新プログラム 1 では、使用できる新機能があります。詳細:グリッド (読み取り専用) のオブジェクトとメソッド (クライアント側の参照)

refresh

サブグリッドの表示データを最新情報へ更新します。

Xrm.Page.getControl(arg).refresh()

表示する

getVisible および setVisible メソッドを使用して、どのコントロールを表示または非表示にするか決定します。

getVisible

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

Xrm.Page.getControl(arg).getVisible()

• 戻り値
  種類: ブール値。 コントロールが可視である場合は True、それ以外の場合は false です。

setVisible

コントロールが表示可能かどうかを示す値を設定します。

Xrm.Page.getControl(arg).setVisible(bool)

• 引数
  種類: ブール値。 コントロールを可視にする場合は True、それ以外の場合は false です。

Web リソースおよび IFRAME コントロール メソッド

これらのメソッドを使用して、Web リソースと IFRAME コントロール間の通信をします。

データ

Web リソースには、カスタム データを渡すための data という名前のクエリ文字列パラメーターがあります。getData および setData メソッドは、フォームに追加された Silverlight Web リソースのみで使用できます。詳細:フォームから埋め込み Silverlight Web リソースにデータを渡す方法

Web ページ (HTML) の Web リソースの場合、データ パラメーターが getSrc メソッドから取得、または setSrcメソッドを使用して設定できます。

getData

Silverlight Web リソースに渡すデータ クエリ文字列パラメーターの値を戻します。

Xrm.Page.getControl(arg).getData()

• 戻り値
  種類: 文字列。 データ値は、Silverlight Web リソース にパスされました。

setData

Silverlight Web リソースに渡すデータ クエリ文字列パラメーターの値を設定します。

Xrm.Page.getControl(arg).setData(string)

• 引数
  種類: 文字列。Silverlight Web リソース にパスするデータの値。

getInitialUrl

IFRAME コントロールを表示するように設定されている既定の URL を返します。 このメソッドでは、Web リソースでは使用できません。

Xrm.Page.getControl(arg).getInitialUrl()

• 戻り値
  種類: 文字列。 最初の URL です。

getObject

I-frame または Web リソースを示す、フォームのオブジェクトを戻します。

Xrm.Page.getControl(arg).getObject()

• 戻り値
  種類: オブジェクト。 オブジェクトはコントロールの種類によって異なります。

  IFRAME は、ドキュメント オブジェクト モデル (DOM) から IFrame 要素を返します。

  Silverlight Web リソースは DOM から オブジェクト 要素を戻し、これは埋め込みSilverlight プラグインを表します。

Src

IFrame または Web リソースには、埋め込みウィンドウに何を表示するか定義する src プロパティがあります。src プロパティは、getSrc および setSrc メソッドを使用して取得または変更できます。

getSrc

IFRAME または Web リソースに表示されている、現在の URL が返されます。

Xrm.Page.getControl(arg).getSrc()

• 戻り値
  種類: 文字列。 IFRAME または Web リソースの src プロパティを表す URL。

setSrc

IFRAME または Web リソースに表示される URL を設定します。

Xrm.Page.getControl(arg).setSrc(string)

• 引数
  種類: 文字列: URL。

関連項目

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

Microsoft Dynamics 365

© 2017 Microsoft. All rights reserved. 著作権