navigateTo (referência da API do cliente)

Navega até a lista de tabelas, o registro de tabela, o recurso da Web HTML ou a página personalizada especificada.

Sintaxe

Use a sintaxe a seguir para chamar Xrm.Navigation.navigateTo().

Xrm.Navigation.navigateTo(pageInput,navigationOptions).then(successCallback,errorCallback);

Parâmetros

O método aceita os seguintes parâmetros.

Parâmetro pageInput

A definição de objeto muda dependendo do tipo de página para navegar até: lista de entidades, registro de entidade, painel, recurso da Web HTML, página personalizada ou página generativa.

Lista de entidades

O objeto de lista de entidades contém os valores a seguir.

Registro da entidade

O objeto de registro de entidade contém os valores a seguir.

Objeto Relationship

O objeto de relação, usado no registro Entity, contém os valores a seguir.

Dashboard

Use esse objeto como o pageInput parâmetro quando quiser abrir um painel.

O objeto dashboard contém os valores a seguir.

Recurso da Web HTML

Use esse objeto como o pageInput parâmetro quando você quiser abrir um recurso da Web HTML.

O objeto de recurso da Web HTML contém os valores a seguir.

Página personalizada

Use esse objeto como o pageInput parâmetro quando quiser abrir uma página personalizada.

O objeto de página personalizado contém os valores a seguir.

Página generativa

Use esse objeto como o pageInput parâmetro quando quiser abrir uma página de geração.

Para usar recordId, entityNameou data, a página de geração de destino deve ser configurada para aceitar parâmetros de entrada.

O objeto de página gerativa contém os valores a seguir.

Veja exemplos mostrando como navegar de e para uma página de geração usando a API do cliente

Parâmetro navigationOptions

O navigationOptions objeto contém os valores a seguir.

Valor de retorno

Retorna uma promessa. O valor passado quando a promessa é resolvida depende do destino:

• embutido: a promessa é resolvida imediatamente e não retorna nenhum valor.

• caixa de diálogo: a promessa é resolvida quando a caixa de diálogo é fechada. Um objeto será passado somente se você pageType = entityRecord abriu o formulário no modo de criação. O objeto tem uma savedEntityReference matriz com as seguintes propriedades para identificar o registro de tabela criado:

  • entityType: o nome lógico da tabela.
  • id: uma representação de cadeia de caracteres de um valor GUID para o registro.
  • nome: o valor da coluna primária do registro exibido ou criado.

Example

Os exemplos a seguir demonstram navegar para diferentes tipos de página embutidos e em uma caixa de diálogo.

Exemplo 1: Abrir lista de contas

Abre a lista de contas principal embutida.

var pageInput = {
    pageType: "entitylist",
    entityName: "account"
};
Xrm.Navigation.navigateTo(pageInput).then(
    function success() {
            // Run code on success
    },
    function error() {
            // Handle errors
    }
);

Exemplo 2: abrir um registro de conta existente em uma caixa de diálogo

Abre um formulário de conta existente dentro de uma caixa de diálogo.

var pageInput = {
    pageType: "entityrecord",
    entityName: "account",
    entityId: "00aa00aa-bb11-cc22-dd33-44ee44ee44ee" //replace with actual ID
};
var navigationOptions = {
    target: 2,
    height: {value: 80, unit:"%"},
    width: {value: 70, unit:"%"},
    position: 1
};
Xrm.Navigation.navigateTo(pageInput, navigationOptions).then(
    function success() {
            // Run code on success
    },
    function error() {
            // Handle errors
    }
);

Exemplo 3: Abrir um formulário de conta no modo de criação em uma caixa de diálogo

Abre um formulário de conta no modo de criação em uma caixa de diálogo e retorna a referência de registro criada quando salva.

var pageInput = {
    pageType: "entityrecord",
    entityName: "account"    
};
var navigationOptions = {
    target: 2,
    height: {value: 80, unit:"%"},
    width: {value: 70, unit:"%"},
    position: 1
};
Xrm.Navigation.navigateTo(pageInput, navigationOptions).then(
    function success(result) {
            console.log("Record created with ID: " + result.savedEntityReference[0].id + 
            " Name: " + result.savedEntityReference[0].name)
            // Handle dialog closed
    },
    function error() {
            // Handle errors
    }
);

Exemplo 4: Abrir um recurso da Web HTML em uma caixa de diálogo

Abre um recurso da Web HTML em uma caixa de diálogo.

var pageInput = {
    pageType: "webresource",
    webresourceName: "new_sample_webresource.htm"
};
var navigationOptions = {
    target: 2,
    width: 500, // value specified in pixel
    height: 400, // value specified in pixel
    position: 1
};
Xrm.Navigation.navigateTo(pageInput, navigationOptions).then(
    function success() {
            // Run code on success
    },
    function error() {
            // Handle errors
    }
);

Exemplo 5: Abrir uma página gerativa com parâmetros de entrada em uma caixa de diálogo

Abre uma página generativa como uma caixa de diálogo centralizada, passando uma ID de registro, um nome de entidade e parâmetros de dados personalizados. A página de geração deve ser configurada para aceitar esses parâmetros.

var pageInput = {
    pageType: "generative",
    pageId: "<genPageID>", // replace with the ID of your generative page
    recordId: "00aa00aa-bb11-cc22-dd33-44ee44ee44ee", // replace with actual record GUID
    entityName: "account",
    data: { status: "active", category: "premium" }
};
var navigationOptions = {
    target: 2,
    height: {value: 80, unit: "%"},
    width: {value: 70, unit: "%"},
    position: 1
};
Xrm.Navigation.navigateTo(pageInput, navigationOptions).then(
    function success() {
            // Run code on success
    },
    function error() {
            // Handle errors
    }
);

Artigos relacionados

Xrm.Navigation
Navegar de e para uma página gerativa
Navegando de e para uma página personalizada (versão prévia)