navigateTo (Client-API-Referenz)
Navigiert zur angegebenen Tabellenliste, zum Tabellendatensatz, zur HTML-Webressource oder zur benutzerdefinierten Seite.
Hinweis
Diese Methode wird nur für die einheitliche Oberfläche unterstützt.
Syntax
Xrm.Navigation.navigateTo(pageInput,navigationOptions).then(successCallback,errorCallback);
Parameter
Name des Dataflows | Art | Erforderlich | Beschreibung |
---|---|---|---|
pageInput | Object | Ja | Eingabe über die Seite, zu der navigiert werden soll. Siehe pageInput-Parameter |
navigationOptions | Object | Nein | Optionen für das Navigieren zu einer Seite: ob inline oder in einem Dialog geöffnet werden soll. Wird dieser Parameter nicht angegeben, wird die Seite standardmäßig inline geöffnet. |
successCallback |
function | Nein | Eine Funktion, die beim Inline-Navigation bei der erfolgreichen Navigation zur Seite und beim Navigieren zu einem Dialogfeld beim Schließen des Dialogfelds ausgeführt wird. |
errorCallback |
Function | Nein | Eine auszuführende Funktion, wenn der Vorgang fehlgeschlagen ist. |
pageInput-Parameter
Die Objektdefinition ändert sich je nach Art der Seite, zu der navigiert werden soll: Liste der Entitäten, Entitätsdatensatz, Dashboard, HTML-Webressource, oder Benutzerdefinierte Seite.
Entitätsliste
Das Entitätslistenobjekt enthält die folgenden Werte.
Name des Dataflows | Type | Beschreibung |
---|---|---|
pageType |
String | Geben Sie entitylist an. |
entityName |
String | Der logische Name der Tabelle, die in das Listensteuerelement geladen werden soll. |
viewId |
String | (Optional) Die ID der zu ladenden Ansicht. Wenn Sie es nicht angeben, navigieren Sie zur Standardhauptansicht für die Tabelle. |
viewType |
String | (Optional) Typ der zu ladenden Ansicht. Geben Sie savedquery oder userquery an. |
Entitätsdatensatz
Das Entitätsdatensatzobjekt enthält die folgenden Werte.
Name des Dataflows | Type | Beschreibung |
---|---|---|
pageType |
String | Geben Sie entityrecord an. |
entityName |
String | Logischer Name der Tabelle, für die das Formular angezeigt werden soll. |
entityId |
String | (Optional) ID des Tabellendatensatzes, für den das Formular angezeigt wird. Wenn Sie diesen Wert nicht angeben, wird das Formular im Erstellungsmodus geöffnet. |
createFromEntity |
Nachschlagefeld | (Opional) Gibt einen Datensatz an, der Standardwerte basierend auf zugeordneten Spaltenwerten bereitstellt. Das Suchobjekt hat die folgenden Zeichenfolgeneigenschaften: entityType, ID, and name (optional). |
data |
Object | (Optional) Ein Wörterbuchobjekt, das dem Formular zusätzliche Parameter übergibt. Die Parameter können Tabellenspalten mit Standardwerten sein, die auf neuen Formularen gesetzt werden (vgl. Spaltenwerte mithilfe von Parametern festlegen, die an ein Formular übergeben werden) oder benutzerdefinierte Parameter, auf die mit |
formId |
String | (Optional) ID der anzuzeigenden Formularinstanz. |
isCrossEntityNavigate |
Boolesch | (Optional) Gibt an, ob von einer anderen Tabelle zu dem Formular navigiert wird, indem die Kreuztabelle Geschäftsprozessfluss verwendet wird. |
isOfflineSyncError |
Boolesch | (Optional) Gibt an, ob Offline-Synchronisierungsfehler vorliegen. |
processId |
String | (Optional) ID des im Formular anzuzeigenden Geschäftsprozesses. |
processInstanceId |
String | (Optional) ID der im Formular anzuzeigenden Geschäftsprozessinstanz. |
relationship |
Object | (Optional) Definieren eines Beziehungsobjekts, um die zugehörigen Datensätze im Formular anzuzeigen. Siehe Beziehung. |
selectedStageId |
String | (Optional) ID der ausgewählten Phase in der Geschäftsprozessinstanz. |
tabName |
String | (Optional) Setzt den Fokus auf die Registerkarte des Formulars. |
Beziehungsobjekt
Das Beziehungsobjekt, verwendet im Entitätsdatensatz, enthält die folgenden Werte.
Name des Dataflows | Type | Beschreibung |
---|---|---|
attributeName |
String | Name der Spalte, die für die Beziehung verwendet wird. |
name |
String | Name der Beziehung. |
navigationPropertyName |
String | Name der Navigationseigenschaft für die Beziehung. |
relationshipType |
Number | Beziehungstyp. Geben Sie einen der folgenden Werte an: 0:OneToMany, 1:ManyToMany. |
roleType |
Number | Beziehungsrollentyp. Geben Sie einen der folgenden Werte an: 1:Referencing, 2:AssociationEntity. |
Übersicht
Das Dashboardobjekt enthält die folgenden Werte.
Name des Dataflows | Type | Beschreibung |
---|---|---|
pageType |
String | Geben Sie dashboard an. |
dashboardId |
String | Die ID des zu ladenden Dashboards Wenn Sie die ID nicht angeben, navigieren Sie zum Standard-Dashboard. |
HTML-Webressource
Die HTML-Webressource enthält die folgenden Werte.
Name des Dataflows | Type | Beschreibung |
---|---|---|
pageType |
String | Geben Sie webresource an. |
webresourceName |
String | Der Name der zu ladenden Webressource. |
data |
String | (Optional) Die Daten, die an die Webressource übergeben werden sollen. |
Benutzerdefinierte Seite
Das benutzerdefinierte Objekt enthält die folgenden Werte.
Name des Dataflows | Type | Beschreibung |
---|---|---|
pageType |
String | Geben Sie custom an. |
name |
String | Der logische Name der zu öffnenden benutzerdefinierten Seite. |
entityName |
String | (Optional) Der logische Name der Tabelle, die in der benutzerdefinierten Seite über Param("entityName") verfügbar gemacht werden soll. |
recordId |
String | (Optional) Die ID des Tabellendatensatzes, die auf der benutzerdefinierten Seite über Param("recordId") verfügbar gemacht werden soll. |
navigationOptions-Parameter
Das navigationOptions enthält die folgenden Werte.
Name des Dataflows | Type | Beschreibung |
---|---|---|
target |
Number | Geben Sie 1 an, um die Seite inline zu öffnen; 2 , um die Seite in einem Dialog zu öffnen.Auch der Rest der Werte (Breite, Höhe, und Position) sind nur gültig, wenn Sie angegeben haben 2 in diesem Wert (Seite in einem Dialog öffnen). Hinweis: Entitätslisten können nur inline geöffnet werden; Entitätsdatensätze und Webressourcen können entweder inline oder in einem Dialog geöffnet werden. |
width |
Nummer oder Objekt | (Optional) Die Breite des Dialogfelds. Um die Breite in Pixel anzugeben, geben Sie einfach einen numerischen Wert ein. Um die Breite in Prozent anzugeben, geben Sie ein Objekt vom Typ SizeValue mit folgenden Eigenschaften an: - value : Der numerische Wert vom Typ „Nummer”.- unit : Die Maßeinheit vom Typ „Zeichenfolge”. Geben Sie % oder px an. Standardwert ist px . |
height |
Nummer oder Objekt | (Optional) Die Höhe des Dialogfelds. Um die Höhe in Pixel anzugeben, geben Sie einfach einen numerischen Wert ein. Um die Breite in Prozent anzugeben, geben Sie ein Objekt vom Typ SizeValue mit folgenden Eigenschaften an: - Wert: Der numerische Wert vom Typ Number. - Einheit: Die Maßeinheit vom Typ „Zeichenfolge”. Geben Sie % oder px an. Standardwert ist px . |
position |
Number | (Optional) Geben Sie 1 an, um das Dialogfeld in der Mitte zu öffnen; 2 , um den Dialog auf der anderen Seite zu öffnen. Standard ist 1 (Mitte). |
title |
String | (Optional) Der Dialogtitel über dem mittleren oder seitlichen Dialog. |
Rückgabewert
Gibt eine Zusage zurück. Der Wert, der beim Auflösen des Versprechens übergeben wird, hängt vom Ziel ab:
inline : Das Versprechen wird sofort aufgelöst und gibt keinen Wert zurück.
dialog: Das Versprechen wird aufgelöst, wenn der Dialog geschlossen wird. Ein Objekt wird nur übergeben, wenn
pageType
=entityRecord
und Sie das Formular im Erstellungsmodus geöffnet haben. Das Ziel ist einsavedEntityReference
-Array mit den folgenden Eigenschaften, um den erstellten Tabellendatensatz zu identifizieren:- entityType: Der logische Name der Tabelle.
- id: Eine Zeichenfolgendarstellung eines GUID-Werts für den Datensatz.
- name: der primäre Spaltenwert des erstellten oder angezeigten Datensatzes.
Beispiel
Beispiel 1: Kontoliste öffnen
var pageInput = {
pageType: "entitylist",
entityName: "account"
};
Xrm.Navigation.navigateTo(pageInput).then(
function success() {
// Run code on success
},
function error() {
// Handle errors
}
);
Beispiel 2: Öffnen Sie einen vorhandenen Kontodatensatz in einem Dialogfeld
var pageInput = {
pageType: "entityrecord",
entityName: "account",
entityId: "5a57f2c3-5672-ea11-a812-000d3a339706" //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
}
);
Beispiel 3: Ein Firmenformular im Erstellungsmodus in einem Dialogfeld öffnen
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
}
);
Beispiel 4:Eine HTML-Webressource in einem Dialogfeld öffnen
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
}
);
Ähnliche Artikel
Xrm.Navigation
Navigieren zu und von einer benutzerdefinierten Seite (Vorschau)
Hinweis
Können Sie uns Ihre Präferenzen für die Dokumentationssprache mitteilen? Nehmen Sie an einer kurzen Umfrage teil. (Beachten Sie, dass diese Umfrage auf Englisch ist.)
Die Umfrage dauert etwa sieben Minuten. Es werden keine personenbezogenen Daten erhoben. (Datenschutzbestimmungen).