navigateTo (referencia de la API de cliente)

Navega a la lista de tabla, registro de tabla, recurso web HTML o página personalizada especificados.

Syntax

Use la sintaxis siguiente para llamar a Xrm.Navigation.navigateTo().

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

Parámetros

El método acepta los parámetros siguientes.

Parámetro pageInput

La definición de objeto cambia en función del tipo de página para navegar a: lista de entidades, registro de entidad, panel, recurso web HTML, página personalizada o página generativa.

Lista de entidades

El objeto lista de entidades contiene los siguientes valores.

Registro de entidad

El objeto registro de entidades contiene los siguientes valores.

Objeto de relación

El objeto de relación, utilizado en el registro de entidades, contiene los siguientes valores.

Panel de información

Use este objeto como pageInput parámetro cuando desee abrir un panel.

El objeto del panel contiene los siguientes valores.

Recurso web HTML

Use este objeto como pageInput parámetro cuando desee abrir un recurso web HTML.

El objeto del recurso web HTML contiene los siguientes valores.

Página personalizada

Use este objeto como parámetro pageInput cuando desee abrir una página personalizada.

El objeto de página personalizado contiene los valores siguientes.

Página generativa

Use este objeto como pageInput parámetro cuando desee abrir una página generativa.

Para usar recordId, entityNameo data, la página generativa de destino debe configurarse para aceptar parámetros de entrada.

El objeto de página generativa contiene los siguientes valores.

Consulte ejemplos que muestran cómo navegar a una página generativa y desde ella mediante la API de cliente.

Parámetro navigationOptions

El navigationOptions objeto contiene los valores siguientes.

Valor devuelto

Devuelve una promesa. El valor pasado cuando la promesa se resuelve depende del tipo de página y destino:

• Insertado: la promesa se resuelve cuando se completa la navegación y no devuelve un valor.
• Cuadro de diálogo: la promesa se resuelve cuando se cierra el diálogo.
  • Para un registro de entidad abierto en modo de creación, la promesa se resuelve con un objeto que contiene una savedEntityReference matriz.
  • Para una página generativa, la promesa se resuelve con un objeto cuya returnValue propiedad contiene el valor pasado más recientemente a dataApi.setPageOutput(value). Si la página generativa no establece un valor de salida, al cerrar el cuadro de diálogo, seleccione Cancelar o el botón Cerrar dará como resultado un valor indefinido returnValue.
  • Otros tipos de página no devuelven un valor cuando se cierra el cuadro de diálogo.

La savedEntityReference matriz devuelta para un registro de entidad contiene estas propiedades:

• entityType: el nombre lógico de la tabla.
• id: representación de cadena del GUID de registro.
• name: el valor de la columna principal del registro.

Ejemplo

En los ejemplos siguientes se muestra cómo navegar a diferentes tipos de página insertados y en un cuadro de diálogo.

Ejemplo 1: lista de cuentas abiertas

Abre la lista de cuentas principal insertada.

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

Ejemplo 2: abrir un registro de cuenta existente dentro de un cuadro de diálogo

Abre un formulario de cuenta existente dentro de un cuadro 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
    }
);

Ejemplo 3: abrir un formulario de cuenta en modo de creación dentro de un cuadro de diálogo

Abre un formulario de cuenta en modo de creación dentro de un cuadro de diálogo y devuelve la referencia de registro creada cuando se guarda.

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

Ejemplo 4: abrir un recurso web HTML en un cuadro de diálogo

Abre un recurso web HTML en un cuadro 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
    }
);

Ejemplo 5: Abrir una página generativa con parámetros de entrada en un cuadro de diálogo

Abre una página generativa como un cuadro de diálogo centrado, pasando un identificador de registro, un nombre de entidad y parámetros de datos personalizados. La página generativa debe configurarse para aceptar estos 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(result) {
        const output = result?.returnValue;
        if (output) {
            console.log("Value returned by generative page:", output);
        }
    },
    function error(error) {
        console.log(error.message);
    }
);

Artículos relacionados

Xrm.Navigation
Navegar a y desde una página generativa
Navegar hacia y desde una página personalizada (versión preliminar)