navigateTo (Informazioni di riferimento sulle API client)

Consente di passare all'elenco di tabelle, al record di tabella, alla risorsa Web HTML o alla pagina personalizzata specificata.

Sintassi

Usare la sintassi seguente per chiamare Xrm.Navigation.navigateTo().

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

Parameters

Il metodo accetta i parametri seguenti.

parametro pageInput

La definizione dell'oggetto cambia a seconda del tipo di pagina a cui passare: elenco di entità, record di entità, dashboard, risorsa Web HTML, pagina personalizzata o pagina generativa.

Elenco entità

L'oggetto elenco di entità contiene i valori seguenti.

Record dell'entità

L'oggetto record di entità contiene i valori seguenti.

Oggetto Relationship

L'oggetto relazione, utilizzato nel record Entity, contiene i valori seguenti.

Dashboard

Usare questo oggetto come pageInput parametro quando si vuole aprire un dashboard.

L'oggetto dashboard contiene i valori seguenti.

Risorsa Web HTML

Usare questo oggetto come pageInput parametro quando si desidera aprire una risorsa Web HTML.

L'oggetto risorsa Web HTML contiene i valori seguenti.

Pagina personalizzata

Utilizzare questo oggetto come pageInput parametro quando si desidera aprire una pagina personalizzata.

L'oggetto pagina personalizzato contiene i valori seguenti.

Pagina generativa

Usare questo oggetto come pageInput parametro quando si desidera aprire una pagina generativa.

Per usare recordId, entityNameo data, la pagina generativa di destinazione deve essere configurata per accettare i parametri di input.

L'oggetto pagina generativa contiene i valori seguenti.

Vedere esempi che illustrano come passare a e da una pagina generativa usando l'API client

parametro navigationOptions

L'oggetto navigationOptions contiene i valori seguenti.

Valore restituito

Restituisce una promessa. Il valore passato quando la promessa viene risolta dipende dal tipo di destinazione e di pagina:

• Inline: la promessa viene risolta al termine della navigazione e non restituisce un valore.
• Finestra di dialogo: la promessa viene risolta alla chiusura del dialogo.
  • Per un record di entità aperto in modalità di creazione, la promessa viene risolta con un oggetto contenente una savedEntityReference matrice.
  • Per una pagina generativa, la promessa viene risolta con un oggetto la cui returnValue proprietà contiene il valore passato più di recente a dataApi.setPageOutput(value). Se la pagina generativa non imposta un valore di output, la chiusura della finestra di dialogo selezionando Annulla o il pulsante di chiusura restituisce un valore non definito returnValue.
  • Altri tipi di pagina non restituiscono un valore quando la finestra di dialogo viene chiusa.

La savedEntityReference matrice restituita per un record di entità contiene queste proprietà:

• entityType: nome logico della tabella.
• id: rappresentazione di stringa del GUID del record.
• name: valore della colonna primaria del record.

Example

Gli esempi seguenti illustrano l'esplorazione inline di diversi tipi di pagina e in una finestra di dialogo.

Esempio 1: Aprire l'elenco di account

Apre l'elenco di account principale inline.

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

Esempio 2: Aprire un record di account esistente all'interno di una finestra di dialogo

Apre un modulo di account esistente all'interno di una finestra di dialogo.

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

Esempio 3: Aprire un modulo account nella modalità di creazione all'interno di una finestra di dialogo

Apre un modulo account in modalità di creazione all'interno di una finestra di dialogo e restituisce il riferimento al record creato al momento del salvataggio.

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

Esempio 4: Aprire una risorsa Web HTML in una finestra di dialogo

Apre una risorsa Web HTML in una finestra di dialogo.

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

Esempio 5: Aprire una pagina generativa con parametri di input in una finestra di dialogo

Apre una pagina generativa come finestra di dialogo centrata, passando un ID record, un nome di entità e parametri di dati personalizzati. La pagina generativa deve essere configurata per accettare questi parametri.

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

Articoli correlati

Xrm.Navigation
Passare a e da una pagina generativa
Navigazione da e verso una pagina personalizzata (anteprima)