lookupObjects (справочник по API клиента)

Открывает элемент управления подстановки для выбора одного или нескольких элементов.

Синтаксис

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

Параметры

Имя Тип Обязательно Description
lookupOptions lookupOptions Да Определяет параметры открытия диалогового окна подстановки.
successCallback Функция нет Функция, вызываемая при вызове элемента управления подстановкой. Функция получает массив объектов со следующими свойствами:
- entityType:Струна. Тип таблицы записи, выбранной в элементе управления подстановки.
- id:Струна. Идентификатор записи, выбранной в элементе управления подстановки.
- name:Струна. Имя записи, выбранной в элементе управления подстановки.
errorCallback Функция нет Функция, вызываемая при сбое операции. Если пользователь отменяет операцию, это не считается ошибкой.

Свойства lookupOptions

lookupOptions имеет следующие свойства:

Название свойства Тип Обязательно Description
allowMultiSelect Boolean нет Указывает, разрешено ли выбор нескольких элементов.
defaultEntityType String нет Тип таблицы по умолчанию для использования.
defaultViewId String нет Используемое по умолчанию представление.
disableMru Boolean нет Определяет, следует ли отображать последний использованный элемент (MRU).
Доступно только для единого интерфейса.
entityTypes Массив Да Отображаемые типы таблиц.
filters Массив объектов нет Используется для фильтрации результатов. Каждый объект в массиве содержит следующие значения:
- filterXml:Струна. Применяемый элемент фильтра FetchXML.
- entityLogicalName:Струна. Тип таблицы, к которому применяется этот фильтр.
searchText String нет Указывает термин поиска по умолчанию для элемента управления подстановки. Это значение поддерживается только в едином интерфейсе.
viewIds Массив нет Представления, доступные в средстве выбора представлений. Поддерживаются только системные представления.

Example

//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