Udostępnij przez


navigateTo (dokumentacja interfejsu API klienta)

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

Uwaga / Notatka

Ta metoda jest obsługiwana tylko w ujednoliconym interfejsie.

Składnia

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

Parametry

Name Typ Wymagane Description
pageInput Object Tak Dane wejściowe dotyczące strony, do których ma przejść. Zobacz parametr pageInput
navigationOptions Object Nie. Opcje przechodzenia do strony: czy otworzyć wbudowane, czy w oknie dialogowym. Jeśli nie określisz tego parametru, strona jest domyślnie otwierana w tekście.
successCallback funkcja Nie. Funkcja wykonywana na pomyślnej nawigacji do strony podczas nawigowania w tekście i zamykania okna dialogowego podczas przechodzenia do okna dialogowego.
errorCallback Funkcja Nie. Funkcja do wykonania, gdy operacja zakończy się niepowodzeniem.

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 lub strona niestandardowa.

Lista encji

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

Name Typ Description
pageType Sznurek Podaj wartość entitylist.
entityName Sznurek Logiczna nazwa tabeli do załadowania w kontrolce listy.
viewId Sznurek (Opcjonalnie) Identyfikator widoku do załadowania. Jeśli nie określisz go, przejdzie do domyślnego widoku głównego tabeli.
viewType Sznurek (Opcjonalnie) Typ widoku do załadowania. Wybierz wartość savedquery lub userquery.

Rekord encji

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

Name Typ Description
pageType Sznurek Podaj wartość entityrecord.
entityName Sznurek Logiczna nazwa tabeli do wyświetlenia formularza.
entityId Sznurek (Opcjonalnie) Identyfikator rekordu tabeli do wyświetlenia formularza. Jeśli nie określisz tej wartości, formularz zostanie otwarty w trybie tworzenia.
createFromEntity Szukaj (Opcjonalnie) Wyznacza rekord, który będzie dostarczać wartości domyślne na podstawie zamapowanych wartości kolumn. Obiekt odnośnika ma następujące właściwości String: entityType, id i name (opcjonalnie).
data Object (Opcjonalnie) Obiekt słownika, który przekazuje dodatkowe parametry do formularza.

Parametry mogą być kolumnami tabeli z wartościami domyślnymi ustawionymi w nowych formularzach (zobacz Ustawianie wartości kolumn przy użyciu parametrów przekazywanych do formularza) lub niestandardowych parametrów, które są dostępne w formularzu przy użyciu ( formContext.data.attributes zobacz Konfigurowanie formularza w celu akceptowania niestandardowych parametrów ciągu zapytania i formContext.data). Nieprawidłowe parametry spowodują błąd.

formId Sznurek (Opcjonalnie) Identyfikator wystąpienia formularza do wyświetlenia.
isCrossEntityNavigate logiczny (Opcjonalnie) Wskazuje, czy formularz jest przechodzi do z innej tabeli przy użyciu przepływu procesów biznesowych między tabelami.
isOfflineSyncError logiczny (Opcjonalnie) Wskazuje, czy występują jakiekolwiek błędy synchronizacji w trybie offline.
processId Sznurek (Opcjonalnie) Identyfikator procesu biznesowego, który ma być wyświetlany w formularzu.
processInstanceId Sznurek (Opcjonalnie) Identyfikator wystąpienia procesu biznesowego, który ma być wyświetlany w formularzu.
relationship Object (Opcjonalnie) Zdefiniuj obiekt relacji, aby wyświetlić powiązane rekordy w formularzu. Zobacz relację.
selectedStageId Sznurek (Opcjonalnie) Identyfikator wybranego etapu w wystąpieniu procesu biznesowego.
tabName Sznurek (Opcjonalnie) Ustawia fokus na karcie formularza.
Obiekt relacji

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

Name Typ Description
attributeName Sznurek Nazwa kolumny używanej dla relacji.
name Sznurek Nazwa relacji.
navigationPropertyName Sznurek Nazwa właściwości nawigacji dla tej relacji.
relationshipType Number Typ relacji. Określ jedną z następujących wartości: 0:OneToMany, 1:ManyToMany.
roleType Number Typ roli w relacji. Określ jedną z następujących wartości: 1:Odwoływanie się do wartości 2:AssociationEntity.

Dashboard

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

Name Typ Description
pageType Sznurek Podaj wartość dashboard.
dashboardId Sznurek Identyfikator pulpitu nawigacyjnego do załadowania. Jeśli nie określisz identyfikatora, przejdzie do domyślnego pulpitu nawigacyjnego.

Zasób internetowy HTML

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

Name Typ Description
pageType Sznurek Podaj wartość webresource.
webresourceName Sznurek Nazwa zasobu internetowego do załadowania.
data Sznurek (Opcjonalnie) Dane, które mają być przekazywane do zasobu internetowego.

Strona niestandardowa

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

Name Typ Description
pageType Sznurek Podaj wartość custom.
name Sznurek Nazwa logiczna strony niestandardowej do otwarcia.
entityName Sznurek (Opcjonalnie) Logiczna nazwa tabeli, która ma być udostępniona na stronie niestandardowej za pośrednictwem elementu Param("entityName").
recordId Sznurek (Opcjonalnie) Identyfikator rekordu tabeli, który ma zostać udostępniony na stronie niestandardowej za pośrednictwem elementu Param("recordId").

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

Name Typ Description
target Number Określ 1 , aby otworzyć stronę w tekście; 2 aby otworzyć stronę w oknie dialogowym.
Ponadto pozostałe wartości (szerokość, wysokość i pozycja) są prawidłowe tylko wtedy, gdy określono wartość 2 w tej wartości (otwórz stronę w oknie dialogowym).
Uwaga: listy jednostek można otwierać tylko w tekście; rekordy jednostek i zasoby internetowe można otwierać w tekście lub w oknie dialogowym.
width Liczba lub obiekt (Opcjonalnie) Szerokość okna dialogowego. Aby określić szerokość w pikselach, wystarczy wpisać wartość liczbową. Aby określić szerokość w procentach, określ obiekt typu SizeValue o następujących właściwościach:
- value: wartość liczbowa typu Liczba.
- unit: jednostka miary typu Ciąg. Wybierz wartość % lub px. Wartość domyślna to px.
height Liczba lub obiekt (Opcjonalnie) Wysokość okna dialogowego. Aby określić wysokość w pikselach, wystarczy wpisać wartość liczbową. Aby określić szerokość w procentach, określ obiekt typu SizeValue o następujących właściwościach:
- wartość: wartość liczbowa typu Liczba.
- jednostka: jednostka miary typu Ciąg. Wybierz wartość % lub px. Wartość domyślna to px.
position Number (Opcjonalnie) Określ 1 , aby otworzyć okno dialogowe w centrum; 2 aby otworzyć okno dialogowe po lewej stronie. Wartość domyślna to 1 (środek).
title Sznurek (Opcjonalnie) Tytuł okna dialogowego w górnej części okna dialogowego środkowego lub bocznego.

Wartość zwracana

Zwraca obietnicę. Wartość przekazywana, gdy obietnica zostanie rozpoznana, jest zależna od celu:

  • wbudowany: obietnica jest rozpoznawana od razu i nie zwraca żadnej wartości.

  • okno dialogowe: Obietnica jest rozpoznawana po zamknięciu okna dialogowego. Obiekt jest przekazywany tylko wtedy, gdy pageType = entityRecord obiekt i został otwarty w trybie tworzenia. Obiekt ma tablicę savedEntityReference z następującymi właściwościami, aby zidentyfikować utworzony rekord tabeli:

    • entityType: logiczna nazwa tabeli.
    • id: ciąg reprezentujący wartość identyfikatora GUID dla rekordu.
    • name: wartość kolumny podstawowej wyświetlanego lub utworzonego rekordu.

Example

Przykład 1. Otwieranie listy kont

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

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

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

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

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