חיפוש
חיפוש טקסט מקורי בהרכבת הצופה
ה‑Doconut Viewer מספק חיפוש רגיל באמצעות טקסט שהוצא מצופה הפורמט או הפנייה מבוססת PDF. זה דורש את יכולת הרישיון Search.
הפעלת ממשק החיפוש
חיפוש הוא מודול של הצופה, ולא סרגל כלים עצמאי. על הדף המלא לכלול את משאבי הצופה, סרגל הכלים של הצופה, הרכבה של הצופה, ואת objViewer שהותחל; לאחר מכן ה‑Ribbon של החיפוש מותקן ומצורף לאותו מופע.
חיפוש והערה הם תכונות מורשות מובנות, ולא חבילות AddPlugin<T>(). יש לבקש את משאבי החיפוש מ‑Viewer; התגים שלהם נשלחים רק כאשר הרישיון מאפשר חיפוש. בתצוגות MVC 5 אין @inject, ולכן יש לבנות את התגים בבקר ולשלוח אותם ב‑ViewBag, יחד עם דגל הרישיון שהדף צריך:
public class ViewerController : Controller
{
public ActionResult Index()
{
var viewer = Doconut.DoconutHost.Services.GetRequiredService<Viewer>();
ViewBag.ViewerCss = viewer.ReferenceCss(new CssConfig
{
IncludeViewerCss = true,
IncludeSearchCss = true
});
ViewBag.ViewerScripts = viewer.ReferenceScripts(new ScriptConfig
{
IncludeJQuery = true,
IncludeViewerScripts = true,
IncludeSearchScripts = true,
IncludeSearchBar = true
});
ViewBag.IsSearchEnabled = viewer.IsSearchEnabled;
return View();
}
}כתוב אותם בתצוגה עם @Html.Raw(ViewBag.ViewerCss) ו‑@Html.Raw(ViewBag.ViewerScripts). ב‑Web Forms, חשוף את אותם ערכים מה‑code‑behind וכתוב אותם עם <%= %>.
ה‑Ribbon המוטמע קורא לאותן שיטות JavaScript הזמינות לממשק משתמש מותאם.
שמור על הרכבת הצופה המלאה גלויה במרקאפ, אתחול את docViewer תחילה,
ולאחר מכן צרף את ה‑Ribbon המורשה:
<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 ((bool)ViewBag.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(...) תגרום לשגיאה ותעצור את טעינת דף הצופה. ב‑Web Forms, כתוב את אותה הגנה כ‑<% if (IsSearchEnabled) { %> … <% } %>.
הרכיב מוסיף קבוצות Find, Options, ו‑Results ומטפל בחיפוש, ניקוי, ספירת התאמות, וניווט התאמה קודמת/באה. סרגל כלים של הצופה בבעלות המארח צריך רק להפעיל אותו:
searchBar.isOpen() ? searchBar.close() : searchBar.open();ה‑API הציבורי שלו מכוון להיות קטן בכוונה:
| מתודה | מטרה |
|---|---|
attach(objViewer) | חיבור ה‑Ribbon לצופה שהותחל; נדרש פעם אחת |
open() / close() | הצגה או הסתרת ה‑Ribbon; סגירה גם מנקה הדגשות |
reset() | ניקוי המונח הנוכחי, ספירת התוצאות וההדגשות |
isOpen() | דיווח האם ה‑Ribbon גלוי |
setStatus(message) | העברת הודעת מצב דרך הקריאה חזרה המוגדרת |
ה‑callback האופציונלי onToggle(isOpen) מאפשר למארח לסנכרן את כפתור החיפוש שלו,
ו‑onLayout מאפשר לו לשנות את גודל/התאמת הצופה כאשר ה‑Ribbon משנה גובה. עבור רצף האתחול המשולב של הצופה, החיפוש וההערה, ראה
התחלה מהירה.
חיפוש מ-JavaScript
objViewer.Search(keyword, false, function (resultCount) {
console.log('Matches:', resultCount);
});הפרמטר השני הוא התאמה של מילה שלמה/מדויקת. ספירת ההתאמות מגיעה בקריאה חזרה: Search עצמו נשלח לשרת ומחזיר דבר שאינו שימושי, ולכן var n = objViewer.Search(keyword, false) תמיד קורא undefined — ודף שנבנה כך מדווח "לא נמצא דבר" בעוד שהצופה מדגיש את ההתאמות. לאחר הקריאה חזרה:
| שיטה | תוצאה |
|---|---|
SearchMatchCount() | סך כל ההתאמות האישיות במסמך. |
SearchSummary(false) | [pageNumber, matchCount] רשומות ללא צביעה מחדש. |
SearchSummary(true) | אותו סיכום ומצייר הדגשות של דף/תמונה ממוזערת. |
GotoSearchMatch(index) | נווט לאינדקס התאמה שמתחיל מאפס. |
DocImage.axd משיב ל-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שנבנה מראש. - תוצאה שגיאה/ריקה כאשר אין מקור חיפוש.
CanSearch() יכול להיות אמת עבור צופה שניתן לחיפוש גם כאשר מסמך מסוים אינו כולל שכבת טקסט ולכן אינו מחזיר התאמות.
רישוי והתנהגות ממשק משתמש
רישיון זמני/דמו פעיל מעניק חיפוש במהלך תקופתו הפעילה. רישיון חסר וקובץ TRIAL מיושן אינם מעניקים יכולת חיפוש. ללא חיפוש:
ReferenceCssו-ReferenceScriptsמשמיטים את חבילות החיפוש.DocImage.axdמסרב לבקשות חיפוש במקום להחזיר תוצאות.
הפעלת נראות UI מותאם אישית מ-IDoconutLicenseService.IsCapabilityGranted(LicenseCapability.Search) והשתמש ב-CanSearch() עבור החלטת פורמט/סשן נפרדת.
פתרון בעיות
| תסמין | בדיקה |
|---|---|
| סרגל החיפוש חסר | יכולת חיפוש ו-IncludeSearchCss/IncludeSearchScripts/IncludeSearchBar |
CanSearch() הוא שקר | צופה הפורמט, נתיב DefaultRender שנבחר, וכותרת תגובת האתחול |
| החיפוש מחזיר אפס עבור PDF סרוק | למסמך אין שכבת טקסט; השתמש במקור עם טקסט או בהצגת PDF ששומרת על הטקסט |
| החיפוש עובד אך ההדגשות מוזזות | נתיב הרינדור, רזולוציה, שינויי המסמך, ותיבות המילים המוחצות |
האם דף זה היה מועיל?