שתף דרך


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

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

תחביר

Xrm.Utility.getEntityMainFormDescriptor(entityName, formId);

פרמטרים

שם Type נדרש תיאור‬‏‫‬
entityName String כן השם הלוגי של הטבלה.
formId String כן מזהה הטופס של הטבלה.

Returns

סוג: הבטחת

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

שם פרמטר Type תיאור‬‏‫‬
Attributes מערך של מחרוזות רשימה של כל העמודות בטופס הראשי.
EntityLogicalName String השם הלוגי של הטבלה שצוינה.
Id מחרוזת מזהה הטופס של הטבלה שצוינה.
Label String התווית של הטבלה שצוינה.
Name String שם התצוגה של הטבלה שצוינה.
Sections String שם המקטעים של הטבלה שצוינה.
ShowLabel בוליאני ציון אם להציג את התווית של הטבלה שצוינה או לא.
Visible בוליאני מציין אם הטופס גלוי או לא.

דוגמה

הקוד לדוגמה הבא מראה כיצד לקבל את מתאר הטופס הראשי עבור טבלה שצוינה.

  // Define the table and form ID
  var entityName = "account";
  var formId = "8448b78f-8f42-454e-8e2a-f8196b0419af";

  // Get the main form descriptor 
  Xrm.Utility.getEntityMainFormDescriptor(entityName, formId);

Xrm.Utility