navigateTo (dokumentacja interfejsu API klienta)

Przechodzi do określonej listy tabel, rekordu tabeli, zasobu internetowego HTML lub strony niestandardowej.

Składnia

Użyj następującej składni, aby wywołać metodę Xrm.Navigation.navigateTo().

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

Parameters

Metoda akceptuje następujące parametry.

pageInput Parametr

Definicja obiektu zmienia się w zależności od typu strony, do których ma przejść: lista jednostek, rekord jednostki, pulpit nawigacyjny, zasób internetowy HTML, strona niestandardowa lub strona generowania.

Lista encji

Obiekt listy jednostek zawiera następujące wartości.

Rekord encji

Obiekt rekordu jednostki zawiera następujące wartości.

Obiekt relacji

Obiekt relacji używany w rekordzie jednostki zawiera następujące wartości.

Pulpit nawigacyjny

Użyj tego obiektu jako parametru pageInput , gdy chcesz otworzyć pulpit nawigacyjny.

Obiekt pulpitu nawigacyjnego zawiera następujące wartości.

Zasób internetowy HTML

Użyj tego obiektu jako parametru pageInput , gdy chcesz otworzyć zasób internetowy HTML.

Obiekt zasobu internetowego HTML zawiera następujące wartości.

Strona niestandardowa

Użyj tego obiektu jako parametru pageInput , gdy chcesz otworzyć stronę niestandardową.

Obiekt strony niestandardowej zawiera następujące wartości.

Strona generowania

Użyj tego obiektu jako parametru pageInput , gdy chcesz otworzyć stronę generowania.

Aby użyć recordIdelementu , entityNamelub data, należy skonfigurować docelową stronę generowania w celu akceptowania parametrów wejściowych.

Obiekt strony generowania zawiera następujące wartości.

Zobacz przykłady pokazujące, jak przejść do i ze strony generowania przy użyciu interfejsu API klienta

navigationOptions Parametr

Obiekt navigationOptions zawiera następujące wartości.

Wartość zwracana

Zwraca obietnicę. Wartość przekazywana, gdy obietnica zostanie rozpoznana, zależy od docelowego i typu strony:

• Wbudowane: obietnica jest rozpoznawana po zakończeniu nawigacji i nie zwraca wartości.
• Okno dialogowe: obietnica jest rozpoznawana po zamknięciu okna dialogowego.
  • W przypadku rekordu jednostki otwartego w trybie tworzenia obietnica jest rozpoznawana za pomocą obiektu zawierającego tablicę savedEntityReference .
  • W przypadku strony generowania obietnica jest rozpoznawana za pomocą obiektu, którego returnValue właściwość zawiera ostatnio przekazaną wartość do dataApi.setPageOutput(value). Jeśli strona generowania nie ustawi wartości wyjściowej, zamknięcie okna dialogowego przez wybranie pozycji Anuluj lub przycisk zamknięcia powoduje niezdefiniowane returnValuepolecenie .
  • Inne typy stron nie zwracają wartości po zamknięciu okna dialogowego.

Tablica savedEntityReference zwrócona dla rekordu jednostki zawiera następujące właściwości:

• entityType: logiczna nazwa tabeli.
• id: ciąg reprezentujący identyfikator GUID rekordu.
• name: wartość kolumny podstawowej rekordu.

Example

W poniższych przykładach pokazano przechodzenie do różnych typów stron w tekście i w oknie dialogowym.

Przykład 1. Otwieranie listy kont

Otwiera główną listę kont w tekście.

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

Przykład 2: Otwieranie istniejącego rekordu konta w oknie dialogowym

Otwiera istniejący formularz konta w oknie dialogowym.

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

Przykład 3: Otwieranie formularza konta w trybie tworzenia w oknie dialogowym

Otwiera formularz konta w trybie tworzenia w oknie dialogowym i zwraca odwołanie do utworzonego rekordu po zapisaniu.

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

Przykład 4. Otwieranie zasobu internetowego HTML w oknie dialogowym

Otwiera zasób internetowy HTML w oknie dialogowym.

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

Przykład 5. Otwieranie strony generowania z parametrami wejściowymi w oknie dialogowym

Otwiera stronę generowania jako wyśrodkowane okno dialogowe, przekazując identyfikator rekordu, nazwę jednostki i parametry danych niestandardowych. Aby zaakceptować te parametry, należy skonfigurować stronę generowania.

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

Powiązane artykuły

Xrm.Navigation
Przechodzenie do i ze strony generowania
Przechodzenie do i ze strony niestandardowej (wersja zapoznawcza)