addCustomFilter (referência da API do cliente)

O addCustomFilter método adiciona filtros aos resultados exibidos em um controle de pesquisa em aplicativos controlados por modelos. Cada filtro é combinado com todos os filtros adicionados anteriormente como uma condição AND .

Tipos de controle com suporte

Busca

Sintaxe

formContext.getControl(arg).addCustomFilter(filter, entityLogicalName)

Parâmetros

Nome Tipo Description
filter String O elemento de filtro FetchXML a ser aplicado.
entityLogicalName String Optional. Se você definir esse parâmetro, o filtro só se aplicará a esse tipo de tabela. Caso contrário, ele se aplica a todos os tipos de tabelas retornadas.

Por exemplo, use o seguinte XML para o filter parâmetro:

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

Observações

Use esse método em uma função em um manipulador de eventos para o evento PreSearch de Controle de Pesquisa.

Example

O exemplo de código a seguir é para a pesquisa de conta de formulário de oportunidade (parentaccountid). Quando você definir a Sdk.setParentAccountIdFilter função no manipulador de eventos de formulário Onload , adicione a Sdk.filterCustomerAccounts função ao PreSearch evento para essa pesquisa. Lembre-se de selecionar a opção para passar no contexto de execução ao definir a função no manipulador de eventos de formulário Onload . O resultado é que somente contas com o valor de Categoria (accountcategorycode) de Cliente Preferencial (1) são retornadas.

// A namespace defined for SDK sample code
// You should define a unique namespace for your libraries
const Sdk = (window.Sdk ??= {});

// set 'Sdk.setParentAccountIdFilter' in the Opportunity form onload event handler
Sdk.setParentAccountIdFilter = (executionContext) => {
  const formContext = executionContext.getFormContext();
    formContext.getControl("parentaccountid").addPreSearch(Sdk.filterCustomerAccounts);
};

Sdk.filterCustomerAccounts = (executionContext) => {
  const control = executionContext.getEventSource();
  const customerAccountFilter = `
    <filter type="and">
      <condition attribute="accountcategorycode" operator="eq" value="1" />
    </filter>`;
  control.addCustomFilter(customerAccountFilter, "account");
};

addPreSearch
formContext