חיפוש

חיפוש טקסט מקורי בהרכבת ה-Viewer

ה-Doconut Viewer מספק חיפוש רגיל באמצעות טקסט שמופק מצופה הפורמט או הפנייה מחדש של PDF מבוסס טקסט. הוא דורש את יכולת הרישיון Search.

הפעלת ממשק החיפוש

חיפוש הוא מודול של Viewer, ולא סרגל כלים עצמאי. על הדף המלא לכלול את משאבי ה-Viewer, סרגל הכלים של Viewer, הרכבה של Viewer, ואת objViewer שהאותחל; לאחר מכן ה-Ribbon של החיפוש מותקן ומחובר לאותו מופע.

חיפוש והערה הם תכונות מורשות מובנות, ולא חבילות AddPlugin<T>(). בקש את משאבי החיפוש מה-Viewer המוזרק; התגים שלהם נשלחים רק כאשר הרישיון מאפשר חיפוש.

html
@Html.Raw(Viewer.ReferenceCss(new CssConfig
{
    IncludeViewerCss = true,
    IncludeSearchCss = true
}))

@Html.Raw(Viewer.ReferenceScripts(new ScriptConfig
{
    IncludeJQuery = true,
    IncludeViewerScripts = true,
    IncludeSearchScripts = true,
    IncludeSearchBar = true
}))

ה-Ribbon המוטמע קורא לאותן שיטות JavaScript הזמינות לממשק משתמש מותאם.

שמור על הרכבת ה-Viewer המלאה גלויה בסימון, אתחל תחילה את docViewer, ולאחר מכן חבר את ה-Ribbon המורשה:

html
<nav id="toolbar" aria-label="Document viewer controls">
    <!-- בקרות הצופה, כולל הכפתור הפותח את Search -->
</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: 'doconut',
        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 משמיט את סקריפט ה-Ribbon, ולכן קריאה בלתי מוגנת ל-doconutSearchBar(...) תגרום לשגיאה ותעצור את טעינת דף ה-Viewer.

המרכיב מוזרק קבוצות Find, Options ו-Results ומטפל בחיפוש, ניקוי, ספירת התאמות, וניווט התאמה קודמת/הבאה. סרגל הכלים של Viewer שבבעלות המארח צריך רק להפעיל/לכבות אותו:

javascript
searchBar.isOpen() ? searchBar.close() : searchBar.open();

ה-API הציבורי שלו קטן במכוון:

מתודהמטרה
attach(objViewer)מחבר את ה-Ribbon ל-Viewer שהאותחל; נדרש פעם אחת
open() / close()הצגה או הסתרת ה-Ribbon; סגירה גם מנקה הדגשות
reset()מנקה את המונח הנוכחי, ספירת התוצאות וההדגשות
isOpen()מדווח האם ה-Ribbon גלוי
setStatus(message)מעביר הודעת סטטוס דרך ה-callback המוגדר

ה-callback האופציונלי onToggle(isOpen) מאפשר למארח לסנכרן את כפתור החיפוש שלו, ו-onLayout מאפשר לו לשנות גודל/להתאים את ה-Viewer כאשר ה-Ribbon משנה גובה. עבור רצף האתחול המשולב של Viewer, Search ו-Annotation, ראה Quick Start.

חיפוש מ-JavaScript

javascript
objViewer.Search(keyword, false, function (resultCount) {
    console.log('Matches:', resultCount);
});

הארגומנט השני הוא התאמה של מילה שלמה/מדויקת. ספירת ההתאמות מגיעה ב-callback: Search עצמו נשלח לשרת ומחזיר שום דבר שימושי, ולכן var n = objViewer.Search(keyword, false) תמיד קורא undefined — ודף שנבנה כך מדווח "לא נמצא דבר" בעוד שה-Viewer מדגיש את ההתאמות. לאחר ה-callback:

מתודהתוצאה
SearchMatchCount()סך כל ההתאמות האישיות במסמך.
SearchSummary(false)רשומות [pageNumber, matchCount] ללא צביעת מחודשת.
SearchSummary(true)אותו סיכום וצובע הדגשות בעמוד/תמונה ממוזערת.
GotoSearchMatch(index)מנווט לאינדקס התאמה שמתחיל מאפס.

נתיב ה-middleware משתמש ב-search=<term> וב-exact=true|false ומחזיר XML. השתמש ב-API של ה-widget במקום לנתח את התגובה הפנימית בעצמך.

בדיקת יכולת חיפוש

דוח תגובת האתחול:

text
X-Doconut-Can-Search: 1

לאחר האתחול, objViewer.CanSearch() חושף את אותו פסקת פורמט/מושב. הוא מחזיר false כאשר השרת שולח 0; לפני התגובה, או עם שרת ישן שמדלג על הכותרת, הוא משתמש בtrue כברירת מחדל.

שלושה שערים עצמאיים אינם צריכים להתבלבל:

שערשאלה
CanSearch() / כותרת תגובההאם הצופה המיועד כולל נתיב אינדקס/חיפוש מקורי?
AllowSearchהאם תצורת פורמט זו ביקשה חילוץ טקסט במיקום שבו המתג קיים?
LicenseCapability.Searchהאם היישום מורשה לבצע חיפוש ולקבל את חבילות הממשק?

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

הפעלת חילוץ לפי פורמט

csharp
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 מבוססת טקסט:

csharp
// DefaultRender = false → הומר ל‑PDF מבוסס‑טקסט → ניתן לחיפוש
var token = await viewer.OpenDocumentAsync(path, new HtmlConfig { DefaultRender = false });

למתקשרים מקוריים, CanSearch() מתאר את יכולת הצופה; הוא אינו מבטיח שמסמך מסוים מכיל טקסט ניתן לשימוש. PDF שבו הדפים הם רק תמונות סרוקות עדיין יכול להחזיר אפס תוצאות מקוריות.

התנהגות חיפוש רגילה

השרת מנסה מקורות חיפוש לפי הסדר הבא:

  1. תוצאות מצופה המקורי של הפורמט.
  2. אינדקס חיפוש מוקדם של .srh.
  3. תוצאה שגיאה/ריקה כאשר אין מקור חיפוש.

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

CanSearch() יכול להיות אמת עבור צופה ניתן לחיפוש גם כאשר מסמך מסוים אינו כולל שכבת טקסט ולכן אינו מחזיר תוצאות.

רישוי והתנהגות ממשק משתמש

רישיון זמני/דמו פעיל מעניק חיפוש במהלך תקופתו הפעילה. רישיון חסר וקובץ TRIAL מיושן אינם מעניקים יכולת חיפוש. ללא חיפוש:

  • ReferenceCss ו-ReferenceScripts משמיטים את חבילות החיפוש.
  • התוכנה הביניים דוחה חיפוש במקום להחזיר תוצאות מורשות.

הפעלת נראות ממשק משתמש מותאם מ-IDoconutLicenseService.IsCapabilityGranted(LicenseCapability.Search) והשתמש ב-CanSearch() עבור פסקת פורמט/מושב נפרדת.

פתרון בעיות

תסמיןבדיקה
סרגל החיפוש חסריכולת חיפוש ו-IncludeSearchCss/IncludeSearchScripts/IncludeSearchBar
CanSearch() הוא שקרצופה פורמט, נתיב DefaultRender נבחר, וכותרת תגובת האתחול
החיפוש מחזיר אפס עבור PDF סרוקלמסמך אין שכבת טקסט; השתמש במקור נושא טקסט או בהצגת PDF המשמרת טקסט
החיפוש עובד אך ההדגשות מוזזותנתיב רינדור, רזולוציה, שינויי מסמך, ותיבות מילים מחולצות

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