חיפוש

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

ה-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">
    <!-- בקרות הצופה, כולל את הכפתור הפותח את החיפוש -->
</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(...) תגרום לשגיאה ותעצור את טעינת דף הצופה.

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

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

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

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

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

חיפוש מ-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() / response headerהאם לצופה המיועד יש נתיב אינדקס/חיפוש מקורי?
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 ששומרת על הטקסט
החיפוש עובד אך ההדגשות מוזזותנתיב רינדור, רזולוציה, שינויי מסמך, ותיבות מילים מחולצות

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