navigateTo (חומר עזר עבור API של לקוח)

ניווט אל רשימת הטבלה, רשומת הטבלה, משאב האינטרנט של HTML או הדף המותאם אישית שצוינו.

הערה

שיטה זו נתמכת בממשק מאוחד בלבד.

תחביר

השתמש בתחביר הבא כדי לקרוא ל- Xrm.Navigation.navigateTo().

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

פרמטרים

פעולת השירות מקבלת את הפרמטרים הבאים.

שם	סוג	נדרש	תיאור
תפוקת דף	אובייקט	‏‏כן‬	קלט אודות הדף שאליה יש לנווט. ראה פרמטר pageInput
אפשרויות ניווט	אובייקט	לא	אפשרויות לניווט לעמוד: אם לפתוח קווים מוטבעים או בתיבת דו-שיח. אם לא תציין פרמטר זה, פעולת השירות תפתח את העמוד בתוך השורה כברירת מחדל.
`successCallback`	פונקציה	לא	פונקציה לביצוע בניווט מוצלח אל הדף בעת ניווט בתוך השורה וסגירת תיבת הדו-שיח בעת ניווט לתיבת דו-שיח.
`errorCallback`	פונקציה	לא	פונקציה לביצוע כאשר הפעולה נכשלת.

`pageInput` פרמטר

הגדרת האובייקט משתנה בהתאם לסוג הדף אליו יש לנווט: רשימת ישויות, רשומת ישות, לוח מחוונים, משאב אינטרנט של HTML , דף מותאם אישית או דף generative.

רשימת ישויות

אובייקט רשימת הישות מכיל את הערכים הבאים.

שם	סוג	תיאור
`pageType`	מחרוזת	ציין `entitylist`.
`entityName`	מחרוזת	השם הלוגי של הטבלה לטעינה בפקד הרשימה.
`viewId`	מחרוזת	(אופציונלי) המזהה של התצוגה שברצונך לטעון. אם לא תציין אותה, האפליקציה תנווט לתצוגה הראשית המהווה ברירת מחדל עבור הטבלה.
`viewType`	מחרוזת	(אופציונלי) סוג תצוגה לטעינה. ציין `savedquery` או `userquery`.

רשומת ישות

אובייקט רשומת הישות מכיל את הערכים הבאים.

שם	סוג	תיאור
`pageType`	מחרוזת	ציין `entityrecord`.
`entityName`	מחרוזת	שם לוגי של הטבלה שעבורה יש להציג את הטופס.
`entityId`	מחרוזת	(אופציונלי) מזהה של רשומת הטבלה שעבורה יש להציג את הטופס. אם לא תציין ערך זה, הטופס ייפתח במצב יצירה.
`createFromEntity`	חיפוש	(אופציונלי) הגדרת רשומה המספקת ערכי ברירת מחדל בהתבסס על ערכי עמודות ממופים. אובייקט בדיקת המידע מכיל את מאפייני המחרוזת הבאים: entityType, מזהה ושם (אופציונלי).
`data`	אובייקט	(אופציונלי) אובייקט מילון המעביר פרמטרים נוספים לטופס. הפרמטרים יכולים להיות עמודות טבלה עם ערכי ברירת מחדל המוגדרים בטפסים חדשים (ראה הגדרת ערכי עמודות באמצעות פרמטרים המועברים לטופס)`formContext.data.attributes` או פרמטרים מותאמים אישית אליהם יש גישה בטופס באמצעות (ראה קביעת תצורה של טופס לקבלת פרמטרים מותאמים אישית של מחרוזת שאילתות ו-formContext.data). פרמטרים לא חוקיים לגרום לשגיאה.
`formId`	מחרוזת	(אופציונלי) מזהה מופע הטופס להצגה.
`isCrossEntityNavigate`	בוליאני	(אופציונלי) ציון אם הטופס מנווט אל מטבלה אחרת באמצעות זרימת תהליך עסקי חוצת טבלאות.
`isOfflineSyncError`	בוליאני	(אופציונלי) מציין אם קיימות שגיאות סינכרון לא מקוונות.
`processId`	מחרוזת	(אופציונלי) מזהה התהליך העסקי להצגה בטופס.
`processInstanceId`	מחרוזת	(אופציונלי) המזהה של מופע התהליך העסקי שיוצגו בטופס.
`relationship`	אובייקט	(אופציונלי) הגדר אובייקט קשר גומלין כדי להציג את הרשומות הקשורות בטופס. ראה קשר גומלין.
`selectedStageId`	מחרוזת	(אופציונלי) מזהה השלב שנבחר במופע תהליך עסקי.
`tabName`	מחרוזת	(אופציונלי) הגדרת המוקד בכרטיסיה של הטופס.

אובייקט קשר גומלין

אובייקט קשר הגומלין, המשמש ברשומת הישות, מכיל את הערכים הבאים.

שם	סוג	תיאור
`attributeName`	מחרוזת	שם העמודה המשמשת עבור קשר גומלין.
`name`	מחרוזת	שם קשר הגומלין.
`navigationPropertyName`	מחרוזת	שם מאפיין הניווט עבור קשר גומלין זה.
`relationshipType`	מספר	סוג קשר. ציין אחד מהערכים הבאים: 0:OneToMany, 1:ManyToMany.
`roleType`	מספר	סוג תפקיד בקשר גומלין. ציין אחד מהערכים הבאים: 1:הפניה, 2:AssociationEntity.

לוח מדדים

השתמש באובייקט זה כפרמטר pageInput כאשר ברצונך לפתוח לוח מחוונים.

אובייקט לוח המחוונים מכיל את הערכים הבאים.

שם	סוג	תיאור
`pageType`	מחרוזת	ציין `dashboard`.
`dashboardId`	מחרוזת	המזהה של לוח המחוונים לטעינה. אם לא תציין את המזהה, האפליקציה תנווט אל לוח המחוונים המהווה ברירת מחדל.

משאב אינטרנט של HTML

השתמש באובייקט זה pageInput כפרמטר כאשר ברצונך לפתוח משאב אינטרנט של HTML.

אובייקט משאבי האינטרנט של HTML מכיל את הערכים הבאים.

שם	סוג	תיאור
`pageType`	מחרוזת	ציין `webresource`.
`webresourceName`	מחרוזת	שם משאב האינטרנט לטעינה.
`data`	מחרוזת	(אופציונלי) הנתונים שברצונך להעביר למשאב האינטרנט.

דף מותאם אישית

השתמש באובייקט זה כפרמטר pageInput כאשר ברצונך לפתוח עמוד מותאם אישית.

אובייקט העמוד המותאם אישית מכיל את הערכים הבאים.

שם	סוג	תיאור
`pageType`	מחרוזת	ציין `custom`.
`name`	מחרוזת	השם הלוגי של הדף המותאם אישית לפתיחה.
`entityName`	מחרוזת	(אופציונלי) השם הלוגי של הטבלה שברצונך שזמינה בדף המותאם אישית דרך `Param("entityName")`.
`recordId`	מחרוזת	(אופציונלי) המזהה של רשומת הטבלה שברצונך שזמינה בדף המותאם אישית דרך `Param("recordId")`.

דף Generative

השתמש באובייקט זה pageInput כפרמטר כאשר ברצונך לפתוח עמוד generative.

כדי להשתמש recordIdבדף entityName, , dataאו , יש להגדיר את הדף הגניטיבי המשמש כיעד לקבלת פרמטרי קלט.

אובייקט העמוד הג'נטיבי מכיל את הערכים הבאים.

שם	סוג	תיאור
`pageType`	מחרוזת	ציין `generative`.
`pageId`	מחרוזת	המזהה של העמוד הג'נטיבי לפתיחה.
`recordId`	מחרוזת	(אופציונלי) ה- GUID של רשומה שת לעבור לדף.
`entityName`	מחרוזת	(אופציונלי) השם הלוגי של הטבלה Dataverse התואמת ל- `recordId`.
`data`	אובייקט	(אופציונלי) אובייקט JSON המכיל פרמטרים מותאמים אישית נוספים לעבור לדף.

ראה דוגמאות שמציגות כיצד לנווט אל דף Generative ומהו באמצעות API של לקוח

`navigationOptions` פרמטר

האובייקט navigationOptions מכיל את הערכים הבאים.

שם	סוג	תיאור
`target`	מספר	`1` ציין כדי לפתוח את העמוד בתוך השורה. ציין `2` כדי לפתוח את העמוד בתיבת דו-שיח. כמו כן, שאר הערכים (רוחב, גובה ומיקום) `2` חוקיים רק אם תציין בערך זה (עמוד פתוח בתיבת דו-שיח). הערה: ניתן לפתוח רשימות ישויות רק בתוך השורה. באפשרותך לפתוח רשומות ישות, משאבי אינטרנט ודפים generative בתוך השורה או בתיבת דו-שיח.
`width`	מספר או אובייקט	(אופציונלי) רוחב תיבת הדו-שיח. כדי לציין את הרוחב בפיקסלים, הקלד ערך מספרי. כדי לציין את הרוחב באחוזים, ציין אובייקט מסוג SizeValue עם המאפיינים הבאים: - `value`: הערך המספרי מסוג 'מספר'. - `unit`: יחידת המידה מסוג מחרוזת. ציין `%` או `px`. ערך ברירת המחדל הוא `px`.
`height`	מספר או אובייקט	(אופציונלי) גובה תיבת הדו-שיח. כדי לציין את הגובה בפיקסלים, הקלד ערך מספרי. כדי לציין את הרוחב באחוזים, ציין אובייקט מסוג SizeValue עם המאפיינים הבאים: - ערך: הערך המספרי מסוג מספר. - `unit`: יחידת המידה מסוג מחרוזת. ציין `%` או `px`. ערך ברירת המחדל הוא `px`.
`position`	מספר	(אופציונלי) `1` ציין כדי לפתוח את תיבת הדו-שיח במרכז; `2` כדי לפתוח את תיבת הדו-שיח בצד הרחוק. ברירת המחדל `1` היא (מרכז).
`title`	מחרוזת	(אופציונלי) כותרת תיבת הדו-שיח בחלק העליון של תיבת הדו-שיח המרכזית או הצדדית.

ערך החזרה

החזרת הבטחה. הערך המועבר כאשר ההבטחה נפתרת תלוי ביעד:

מוטבע: ההבטחה נפתרת באופן מיידי, והיא אינה מחזירה ערך כלשהו.
תיבת דו-שיח: ההבטחה נפתרת כאשר תיבת הדו-שיח נסגרת. אובייקט מועבר רק אם אתה pageType = entityRecord ופתחת את הטופס במצב יצירה. האובייקט כולל מערך savedEntityReference עם המאפיינים הבאים לזיהוי רשומת הטבלה שנוצרה:
- entityType: השם הלוגי של הטבלה.
- id: ייצוג מחרוזת של ערך GUID עבור הרשומה.
- name: ערך העמודה הראשית של הרשומה המוצגת או שנוצרה.

דוגמה

הדוגמאות הבאות מדגימות ניווט לסוגי עמודים שונים בתוך השורה ובתיבת דו-שיח.

דוגמה 1: פתיחת רשימת חשבונות

פתיחת רשימת החשבון הראשי בתוך השורה.

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

דוגמה 2: פתיחת רשומת חשבון קיימת בתוך תיבת דו-שיח

פתיחת טופס חשבון קיים בתוך תיבת דו-שיח.

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

דוגמה 3: פתיחת טופס חשבון במצב יצירה בתיבת דו-שיח

פתיחת טופס חשבון במצב יצירה בתוך תיבת דו-שיח והחזרת ההפניה של הרשומה שנוצרה בעת שמירה.

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

דוגמה 4: פתיחת משאב אינטרנט של HTML בתיבת דו-שיח

פתיחת משאב אינטרנט של HTML בתיבת דו-שיח.

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

דוגמה 5: פתיחת דף generative עם פרמטרי קלט בתיבת דו-שיח

פתיחת דף Generative כתיבת דו-שיח ממורכזת, תוך העברת מזהה רשומה, שם ישות פרמטרים מותאמים אישית של נתונים. יש להגדיר את הדף הג'נטיבי כדי לקבל פרמטרים אלה.

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() {
            // Run code on success
    },
    function error() {
            // Handle errors
    }
);

Xrm.Navigation
ניווט אל דף Generative ומהו
ניווט אל דף מותאם אישית ומהו (תצוגה מקדימה)

משוב

האם עמוד זה היה מועיל?

Last updated on 2026-05-01