lookupObjects (référence de l’API client)

Ouvre une commande de recherche pour sélectionner un ou plusieurs éléments.

Syntaxe

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

Paramètres

Nom	Type	Requise	Description
lookupOptions	lookupOptions	Oui	Définit les options permettant d’ouvrir la boîte de dialogue de recherche.
successCallback	Function	Non	Fonction à appeler lorsque le contrôle de recherche est appelé. La fonction reçoit un tableau d’objets avec les propriétés suivantes : - entityType : chaîne. Type de tableau de l’enregistrement sélectionné dans le contrôle de recherche. - id : chaîne. ID de l’enregistrement sélectionné dans la commande de recherche. - name : chaîne. Nom l’enregistrement sélectionné dans la commande de recherche.
errorCallback	Function	Non	Fonction à appeler lorsque l’opération échoue. Il n’est pas considéré comme un échec si l’utilisateur annule l’opération.

propriétés lookupOptions

lookupOptions contient les propriétés suivantes :

Nom de propriété	Type	Requise	Description
allowMultiSelect	Valeur booléenne	Non	Indique si la recherche permet de sélectionner plusieurs éléments.
defaultEntityType	Chaîne	Non	Type de table par défaut à utiliser.
defaultViewId	Chaîne	Non	Vue par défaut à utiliser.
disableMru	Valeur booléenne	Non	Décide si l’élément (MRU) le plus récemment utilisé doit être affiché. Disponible uniquement pour Unified Interface.
entityTypes	Tableau	Oui	Types de tables à afficher.
filters	Tableau d’objets	Non	Permet de filtrer les résultats. Chaque objet du tableau contient les valeurs suivantes : - filterXml : chaîne. Élément de filtre FetchXML à appliquer. - entityLogicalName : chaîne. Le type de table auquel appliquer ce filtre.
searchText	Chaîne	Non	Indique la valeur par défaut critère de recherche pour le contrôle de recherche. Cette valeur est prise en charge uniquement sur l’interface unifiée.
viewIds	Tableau	Non	Vues à rendre disponibles dans le sélecteur de vues. Seules les vues système sont prises en charge.

Exemple

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

Articles associés

Xrm.Utility