lookupObjects (クライアント API 参照)

検索コントロールを開いて 1 つまたは複数のアイテムを選びます。

構文

Xrm.Utility.lookupObjects(lookupOptions).then(successCallback, errorCallback)

Parameters

件名 タイプ Required プロパティ
lookupOptions lookupOptions 可 検索ダイアログを開くためのオプションを定義します。
successCallback Function いいえ 検索コントロールが呼び出された場合に呼び出す関数。 この関数は、次のプロパティを持つオブジェクトの配列を受け取ります。
- entityType: 文字列。 ルックアップ コントロールで選択されたレコードのテーブルの種類。
- id: 文字列。 検索コントロールで選択されたレコードの ID。
- name: 文字列。 検索コントロールで選択されたレコードの名前。
errorCallback Function いいえ 処理が失敗したときに呼び出す関数。 ユーザーが操作を取り消した場合、エラーとは見なされません。

lookupOptions プロパティ

lookupOptions には、次のプロパティがあります。

プロパティ名 タイプ Required プロパティ
allowMultiSelect ブール値 いいえ 検索で複数のアイテムを選択できるかどうかを指定します。
defaultEntityType 文字列 いいえ 使用するデフォルトのテーブル タイプ。
defaultViewId 文字列 いいえ 使用する既定のビュー。
disableMru ブール値 いいえ 最近使用した (MRU) アイテムを表示するかどうかを判断します。
統一インターフェイスでのみ使用できます。
entityTypes Array 可 表示するテーブルの種類。
filters オブジェクトの配列 いいえ 結果をフィルター処理するのに使用します。 配列の各オブジェクトには、以下の値が含まれています:
- filterXml: 文字列。 適用する FetchXML フィルター要素。
- entityLogicalName: 文字列。 このフィルターを適用するテーブル タイプです。
searchText 文字列 いいえ ルックアップ コントロールの既定の検索語句を示します。 この値は、 統合インターフェイスでのみサポートされます。
viewIds Array いいえ ビュー ピッカーで使用できるビュー。 システム ビューのみサポートされます。

例

//define data for lookupOptions
const lookupOptions = {
  defaultEntityType: "account",
  entityTypes: ["account"],
  allowMultiSelect: false,
  defaultViewId: "0D5D377B-5E7C-47B5-BAB1-A5CB8B4AC10",
  viewIds: [
    "0D5D377B-5E7C-47B5-BAB1-A5CB8B4AC10",
    "00000000-0000-0000-00AA-000010001003"
  ],
  searchText: "Allison",
  filters: [
    {
      filterXml: `
        <filter type="or">
          <condition attribute="name" operator="like" value="A%" />
        </filter>`,
      entityLogicalName: "account"
    }
  ]
};

// Get account records based on the lookup Options
Xrm.Utility.lookupObjects(lookupOptions).then(
  (success) => console.log(success),
  (error) => console.log(error)
);

Xrm.Utility