פקדים (חומר עזר עבור API של לקוח)

ביישומים מונחי מודלים, פקד מייצג רכיב HTML בטופס. פקדים מסוימים מאוגדים לעמודה ספציפית, בעוד שאחרים מייצגים פקדים לא מאוגדים כגון IFRAME, משאב אינטרנט או רשת משנה שנוספו לטופס.

אובייקט הפקד מספק שיטות לשינוי המצגת או אופן הפעולה של פקד ולזיהוי העמודה המתאימה. גש לפקדים באמצעות אחד מהאוספים הבאים:

  • formContext.ui.controls
  • formContext.ui Section.controls
  • formContext.data.entityAttribute.controls

formContext. פעולת השירות getControl היא שיטת קיצור דרך לגישה אל formContext.ui.controls.get.

הערה

בעת ביצוע פעולות בפקדים הקשורים לעמודה, שקול שהפקד עשוי להופיע בדף יותר מפעם אחת. בדרך כלל, עליך לבצע את אותן פעולות עבור כל פקד עבור העמודה. באפשרותך לעבור בלולאה בין אוסף פקדי העמודות ולבצע את הפעולות בכל פקד.

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

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

סוג פקד רגיל

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

שיטה תיאור
הוסף ביאורים הצגת הודעת שגיאה או המלצה עם פעולות אופציונליות.
נקה ביאור הסרת הודעה מהפקד.
קבלהפצה הפונקציה מחזירה את העמודה שהפקד מאוגד לה.
getControlType החזרת סוג הפקד.
getDisabled מחזירה אם הפקד אינו זמין.
תבלי תות החזרת תווית הפקד.
שם הגהה מחזירה את שם הפקד.
getOutputs החזרת מילון של מאפייני הפלט של הפקד.
קבלהסבתא מחזירה את המקטע המכיל את הפקד.
קבל אתVisible מחזירה אם הפקד גלוי.
setDisabled הפיכת הפקד לזמין או ללא זמין.
setFocus העברת המוקד לפקד.
הבלם נטוי שינוי תווית הפקד.
setNotification הצגת הודעת שגיאה כדי לציין שהנתונים אינם חוקיים.
setVisible הצגה או הסתרה של הפקד.

השיטות הבאות עבור הפקד Standard הוצאה משימוש :addOnKeyPress, fireOnKeyPress ו- removeOnKeyPress.

סוג פקד IFRAME

שיטות אלה זמינות עבור פקד IFRAME.

שיטה תיאור
getContentWindow מחזירה את חלון התוכן של IFRAME או של משאב האינטרנט.
getControlType החזרת סוג הפקד.
getDisabled מחזירה אם הפקד אינו זמין.
getInitialUrl החזרת כתובת ה- URL המוגדרת כברירת מחדל עבור IFRAME.
תבלי תות החזרת תווית הפקד.
שם הגהה מחזירה את שם הפקד.
getObject החזרת אובייקט הטופס המייצג את IFRAME או משאב האינטרנט.
קבלהסבתא מחזירה את המקטע המכיל את הפקד.
קבל הודעת טקסט החזרת כתובת ה- URL המוצגת כעת ב- IFRAME או במשאב האינטרנט.
קבל אתVisible מחזירה אם הפקד גלוי.
setDisabled הפיכת הפקד לזמין או ללא זמין.
setFocus העברת המוקד לפקד.
הבלם נטוי שינוי תווית הפקד.
setSrc הגדרת כתובת ה- URL להצגה ב- IFRAME או במשאב האינטרנט.
setVisible הצגה או הסתרה של הפקד.

סוג פקד Kbsearch (חיפוש במאגר הידע)

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

שיטה תיאור
addOnPostSearch הוספת מטפל באירועים המופעל לאחר השלמת חיפוש.
addOnResultOpened הוספת מטפל באירועים המופעל כאשר תוצאת חיפוש נפתחת.
addOnSelection הוספת מטפל באירועים המופעל כאשר תוצאת חיפוש נבחרת.
getControlType החזרת סוג הפקד.
getDisabled מחזירה אם הפקד אינו זמין.
תבלי תות החזרת תווית הפקד.
שם הגהה מחזירה את שם הפקד.
קבלהסבתא מחזירה את המקטע המכיל את הפקד.
קבל את 'שאילתת חיפוש' מחזירה את הטקסט המשמש כקריטריוני החיפוש.
getSelectedResults החזרת תוצאת החיפוש שנבחרה כעת.
getTotalResultCount הפונקציה מחזירה את מספר תוצאות החיפוש.
קבל אתVisible מחזירה אם הפקד גלוי.
openSearchResult פתיחת תוצאת חיפוש שצוינה.
removeOnPostSearch הסרת מטפל באירועים להשלמת החיפוש.
removeOnResultOpened הסרת מטפל באירועים לפתיחת תוצאת חיפוש.
הסרOnSelection הסרת מטפל באירועים לבחירת תוצאת חיפוש.
setFocus העברת המוקד לפקד.
הבלם נטוי שינוי תווית הפקד.
setSearchQuery הגדרת הטקסט המשמש כקריטריוני החיפוש.
setVisible הצגה או הסתרה של הפקד.

הערה

בעת הוספת פקד החיפוש של מאגר הידע לחלונית החברתית, שם הפקד הוא searchwidgetcontrol_notescontrol. לא ניתן לשנות שם זה.

סוג פקד בדיקת מידע

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

שיטה תיאור
הוסף התאמה אישית של סינון הוספת מסנן לתוצאות בדיקת המידע, בשילוב עם מסננים קיימים באמצעות הפונקציה AND.
הוסף התאמה אישיתמבט הוספת תצוגה לתיבת הדו-שיח של בדיקת המידע.
הוסף ביאורים הצגת הודעת שגיאה או המלצה עם פעולות אופציונליות.
addOnLookupTagלחץ הוספת מטפל באירועים המופעל בעת לחיצה על תג בדיקת מידע.
הוסף חיפוש לפני הוספת מטפל באירועים המופעל לפני חיפוש בדיקת מידע.
נקה ביאור הסרת הודעה מהפקד.
קבלהפצה הפונקציה מחזירה את העמודה שהפקד מאוגד לה.
getControlType החזרת סוג הפקד.
getDefaultView הפונקציה מחזירה את המזהה של תצוגת בדיקת המידע המהווה ברירת מחדל.
getDisabled מחזירה אם הפקד אינו זמין.
קבל סוגים של ישות הפונקציה מחזירה את סוגי הטבלאות המותרים בבדיקת המידע.
תבלי תות החזרת תווית הפקד.
שם הגהה מחזירה את שם הפקד.
קבלהסבתא מחזירה את המקטע המכיל את הפקד.
קבל אתVisible מחזירה אם הפקד גלוי.
removeOnLookupTagלחץ הסרת מטפל באירועים עבור לחיצות על תגית בדיקת מידע.
הסרPreSearch הסרת מטפל באירועים המופעל לפני חיפוש בדיקת מידע.
setDefaultView הגדרת תצוגת ברירת המחדל בתיבת הדו-שיח של בדיקת המידע.
setDisabled הפיכת הפקד לזמין או ללא זמין.
setEntityTypes הגדרת סוגי הטבלאות המותרים בבדיקת המידע.
setFocus העברת המוקד לפקד.
הבלם נטוי שינוי תווית הפקד.
setNotification הצגת הודעת שגיאה כדי לציין שהנתונים אינם חוקיים.
setVisible הצגה או הסתרה של הפקד.

אפשרויות וסוגי פקדים של בחירה

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

שיטה תיאור
הוסף ביאורים הצגת הודעת שגיאה או המלצה עם פעולות אופציונליות.
הוסף אפשרויות הוספת אפשרות לפקד.
נקה ביאור הסרת הודעה מהפקד.
נקה אפשרויות הסרת כל האפשרויות מהפקד.
קבלהפצה הפונקציה מחזירה את העמודה שהפקד מאוגד לה.
getControlType החזרת סוג הפקד.
getDisabled מחזירה אם הפקד אינו זמין.
תבלי תות החזרת תווית הפקד.
שם הגהה מחזירה את שם הפקד.
קבל אפשרויות החזרת האפשרויות הזמינות, כולל האפשרות הריקה ולא כולל אפשרויות שהוסרו.
קבלהסבתא מחזירה את המקטע המכיל את הפקד.
קבל אתVisible מחזירה אם הפקד גלוי.
הסר אפשרויות הסרת אפשרות מהפקד.
setDisabled הפיכת הפקד לזמין או ללא זמין.
setFocus העברת המוקד לפקד.
הבלם נטוי שינוי תווית הפקד.
setNotification הצגת הודעת שגיאה כדי לציין שהנתונים אינם חוקיים.
setVisible הצגה או הסתרה של הפקד.

סוג פקד טופס מהיר

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

סוג פקד רשת משנה

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

סוג פקד קיר של ציר זמן

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

שיטה תיאור
getControlType החזרת סוג הפקד.
getDisabled מחזירה אם הפקד אינו זמין.
תבלי תות החזרת תווית הפקד.
שם הגהה מחזירה את שם הפקד.
קבלהסבתא מחזירה את המקטע המכיל את הפקד.
קבל אתVisible מחזירה אם הפקד גלוי.
לרענן רענון הנתונים המוצגים בציר הזמן.
setDisabled הפיכת הפקד לזמין או ללא זמין.
setFocus העברת המוקד לפקד.
הבלם נטוי שינוי תווית הפקד.
setVisible הצגה או הסתרה של הפקד.

סוג פקד שעון עצר

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

שיטה תיאור
getControlType החזרת סוג הפקד.
getDisabled מחזירה אם הפקד אינו זמין.
תבלי תות החזרת תווית הפקד.
שם הגהה מחזירה את שם הפקד.
קבלהסבתא מחזירה את המקטע המכיל את הפקד.
קבלState החזרת המצב הנוכחי של שעון העצר.
קבל אתVisible מחזירה אם הפקד גלוי.
לרענן רענון הנתונים המוצגים בטיימר.
setDisabled הפיכת הפקד לזמין או ללא זמין.
setFocus העברת המוקד לפקד.
הבלם נטוי שינוי תווית הפקד.
setVisible הצגה או הסתרה של הפקד.

סוג פקד משאב אינטרנט

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

סוג פקד של רכיב טופס

סוג פקד של רכיב טופס כולל אותה ערכת שיטות הזמינה ל- formContext בטופס ראשי. ראה API של לקוח אופן פעולה > של רכיב טופס.

עמודות