חיפוש
חיפוש טקסט טבעי בהרכבת המציג
המציג של Doconut מספק חיפוש רגיל באמצעות טקסט שמופק מצופה הפורמט או הפנייה מחדש של PDF מבוסס טקסט. הוא דורש את יכולת הרישיון Search.
הפעלת ממשק החיפוש
חיפוש הוא מודול של מציג, ולא סרגל כלים עצמאי. על הדף המלא לכלול את משאבי המציג, סרגל הכלים של המציג, הצמדה של המציג, ו‑objViewer שהאתחל; לאחר מכן ריבון החיפוש מותקן ומחובר לאותו מופע.
חיפוש והערות הם תכונות מורשות מובנות, ולא חבילות AddPlugin<T>(). בקש את משאבי החיפוש מה‑Viewer שהוזרק; התגיות שלהם נשלחות רק כאשר הרישיון מאפשר חיפוש.
@Html.Raw(Viewer.ReferenceCss(new CssConfig
{
IncludeViewerCss = true,
IncludeSearchCss = true
}))
@Html.Raw(Viewer.ReferenceScripts(new ScriptConfig
{
IncludeJQuery = true,
IncludeViewerScripts = true,
IncludeSearchScripts = true,
IncludeSearchBar = true
}))הריבון המוטמע קורא לאותן שיטות JavaScript הזמינות לממשק משתמש מותאם.
שמור על הרכבת המציג המלאה גלויה בסימון, אתחל את docViewer תחילה, ולאחר מכן חבר את הריבון המורשה:
<nav id="toolbar" aria-label="Document viewer controls">
<!-- בקרות הצופה, כולל הכפתור שפותח את החיפוש -->
</nav>
<div id="searchBarMount"></div>
<div id="divDocViewer"><div id="div_ctlDoc"></div></div>
<script>
let searchBar = null;
let currentToken = '';
const objViewer = $('#div_ctlDoc').docViewer({
BasePath: '/',
ResPath: 'doconut-res/images'
});
@if (Viewer.IsSearchEnabled)
{
<text>
searchBar = $('#searchBarMount').doconutSearchBar({
docId: 'ctlDoc',
getRequestParams: () => ({ token: currentToken }),
onStatus: (message) => console.log(message),
onToast: (message, type) => console.log(type, message),
onLayout: () => requestAnimationFrame(() => objViewer.Refit())
});
searchBar.attach(objViewer);
</text>
}
</script>ה‑if בצד השרת חשוב: ללא יכולת חיפוש, ReferenceScripts משמיט את סקריפט הריבון, ולכן קריאה בלתי מוגנת ל‑doconutSearchBar(...) תגרום לשגיאה ותעצור את טעינת דף המציג.
הרכיב מוסיף קבוצות Find, Options, ו‑Results ומטפל בחיפוש, ניקוי, ספירת התאמות, וניווט התאמה קודמת/הבאה. סרגל הכלים של המציג בבעלות המארח צריך רק להפעיל/לכבות אותו:
searchBar.isOpen() ? searchBar.close() : searchBar.open();ה‑API הציבורי שלו מכוון להיות קטן בכוונה:
| מתודה | מטרה |
|---|---|
attach(objViewer) | מחבר את הריבון למציג שהאתחל; נדרש פעם אחת |
open() / close() | מציג או מסתיר את הריבון; סגירה גם מנקה הדגשות |
reset() | מנקה את המונח הנוכחי, ספירת התוצאות וההדגשות |
isOpen() | מדווח האם הריבון גלוי |
setStatus(message) | מעביר הודעת סטטוס דרך הפונקציית קריאה חזרה המוגדרת |
ה‑callback האופציונלי onToggle(isOpen) מאפשר למארח לסנכרן את כפתור החיפוש שלו, ו‑onLayout מאפשר לו לשנות את גודל/התאמת המציג כאשר הריבון משנה גובה. עבור רצף האתחול המשולב של מציג, חיפוש, והערות, ראה התחלה מהירה.
חיפוש מ‑JavaScript
objViewer.Search(keyword, false, function (resultCount) {
console.log('Matches:', resultCount);
});הפרמטר השני הוא התאמה של מילה שלמה/מדויקת. ספירת ההתאמות מגיעה ב‑callback: Search עצמו נשלח לשרת ואינו מחזיר דבר שימושי, ולכן var n = objViewer.Search(keyword, false) תמיד קורא undefined — ודף שנבנה כך מדווח "לא נמצא דבר" בעוד שהמציג מדגיש את ההתאמות. לאחר הפונקציית קריאה חזרה:
| מתודה | תוצאה |
|---|---|
SearchMatchCount() | סך כל ההתאמות הפרטיות במסמך. |
SearchSummary(false) | רשומות [pageNumber, matchCount] ללא רינדור מחדש. |
SearchSummary(true) | סיכום זהה וצובע הדגשות בעמוד/תמונת ממוזערת. |
GotoSearchMatch(index) | נווט לאינדקס התאמה שמתחיל מאפס. |
נתיב הביניים משתמש ב‑search=<term> וב‑exact=true|false ומחזיר XML. השתמש ב‑API של הווידג'ט במקום לנתח את התגובה הפנימית בעצמך.
בדיקת יכולת חיפוש
תשובת האתחול מדווחת:
X-Doconut-Can-Search: 1לאחר האתחול, objViewer.CanSearch() חושף את אותו פסק דין של פורמט/סשן. הוא מחזיר false כאשר השרת שולח 0; לפני התשובה, או עם שרת ישן שמוותר על הכותרת, הוא משתמש בtrue כברירת מחדל.
שלושה שערים עצמאיים שלא יש לבלבל ביניהם:
| שער | שאלה |
|---|---|
CanSearch() / response header | האם הצופה המיועד כולל נתיב אינדקס/חיפוש מקורי? |
AllowSearch | האם תצורת פורמט זו ביקשה חילוץ טקסט במיקום שבו המתג קיים? |
LicenseCapability.Search | האם היישום מורשה לבצע חיפוש ולקבל את חבילות הממשק? |
פורמט יכול להיות טכנית ניתן לחיפוש בעוד שהרישיון הנוכחי מונע את הפעולה.
אפשר חילוץ לפי פורמט
var token = await viewer.OpenDocumentAsync(path, new PdfConfig
{
AllowSearch = true,
AllowCopy = true // אופציונלי: מאפשר למשתמש לגרור אזור ולהעתיק את הטקסט שלו
});AllowSearch ו-AllowCopy קיימים בPdfConfig, WordConfig, ExcelConfig ו-PptConfig. תכונות Office מעבירות לPdfConfig המקוננות שלהן. שתיהן משתמשות בfalse ברירת מחדל.
מתאמי חיפוש מקורי רגילים קיימים עבור PDF, Word, Excel, PowerPoint, TXT, Visio, דוא"ל, EPUB ו-MHT. XPS משתמש בנתיב PDF שלו ברירת מחדל. HTML ו-Microsoft Project נהנים מהפנייה ל-PDF מבוסס טקסט:
// DefaultRender = false → הומר ל‑PDF מבוסס‑טקסט → ניתן לחיפוש
var token = await viewer.OpenDocumentAsync(path, new HtmlConfig { DefaultRender = false });למתקינים המקוריים, CanSearch() מתאר את יכולת הצופה; הוא אינו מבטיח שמסמך מסוים מכיל טקסט שניתן לשימוש. PDF שבו הדפים הם רק תמונות סרוקות עדיין יכול להניב אפס תוצאות מקוריות.
התנהגות חיפוש רגילה
השרת מנסה מקורות חיפוש בסדר הבא:
- תוצאות מצופה המקורי של הפורמט.
- אינדקס חיפוש
.srhשנבנה מראש. - תוצאה שגיאה/ריקה כאשר אין מקור חיפוש.
האינדקס .srh הוא תוצר החיפוש המתפרסם יחד עם תמונות העמודים כאשר מסמכים מוגשים מאחסון משותף, ולכן צומת שמעולם לא פתח את המסמך עדיין יכול לענות על חיפושים — ראה פריסות מבוזרות.
CanSearch() יכול להיות נכון עבור צופה שניתן לחיפוש גם כאשר מסמך סרוק מסוים אינו כולל שכבת טקסט ולכן אינו מחזיר התאמות.
רישוי והתנהגות ממשק משתמש
רישיון זמני/הדגמה פעיל מעניק חיפוש במהלך תקופתו הפעילה. רישיון חסר וקובץ TRIAL מיושן אינם מעניקים יכולת חיפוש. ללא חיפוש:
-
ReferenceCssו-ReferenceScriptsמשמיטים את חבילות החיפוש. - המתווך דוחה חיפוש במקום להחזיר תוצאות מורשות.
הפעלת נראות ממשק משתמש מותאם מIDoconutLicenseService.IsCapabilityGranted(LicenseCapability.Search) והשתמש בCanSearch() עבור פסק הדין הנפרד של פורמט/סשן.
פתרון בעיות
| תסמין | בדיקה |
|---|---|
| סרגל החיפוש חסר | יכולת חיפוש ו-IncludeSearchCss/IncludeSearchScripts/IncludeSearchBar |
CanSearch() הוא שגוי | צופה פורמט, נתיב DefaultRender שנבחר, וכותרת תגובת האתחול |
| החיפוש מחזיר אפס עבור PDF סרוק | למסמך אין שכבת טקסט; השתמש במקור נושא טקסט או בהצגת PDF המשמרת טקסט |
| החיפוש עובד אך ההדגשות מוזזות | נתיב הרינדור, רזולוציה, שינויי מסמך, ותיבות מילים מחולצות |
האם דף זה היה מועיל?