بحث
بحث نصي أصلي في تركيبة العارض
يوفر عارض 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
}))يتصل الشريط المدمج بنفس طرق جافاسكريبت المتاحة لواجهة مستخدم مخصصة.
احتفظ بتركيبة العارض الكاملة مرئية في العلامات، قم بتهيئة 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: '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 سكريبت الشريط، لذا فإن استدعاء doconutSearchBar(...) غير محمي سيتسبب في خطأ ويوقف بدء صفحة العارض.
يُحقن المكوّن مجموعات Find و Options و Results ويتعامل مع البحث، والمسح، وعدد التطابقات، والتنقل بين التطابق السابق/التالي. يحتاج شريط أدوات العارض المملوك للمضيف فقط إلى تبديله:
searchBar.isOpen() ? searchBar.close() : searchBar.open();واجهة برمجة التطبيقات العامة صغيرة عن قصد:
| الطريقة | الغرض |
|---|---|
attach(objViewer) | ربط الشريط بالعارض المهيأ؛ مطلوب مرة واحدة |
open() / close() | إظهار أو إخفاء الشريط؛ الإغلاق أيضًا يمسح التحديدات |
reset() | مسح المصطلح الحالي، عدد النتائج، والتحديدات |
isOpen() | الإبلاغ عما إذا كان الشريط مرئيًا |
setStatus(message) | تمرير رسالة حالة عبر رد الاتصال المكوّن |
يسمح رد الاتصال الاختياري onToggle(isOpen) للمضيف بمزامنة زر البحث الخاص به، ويسمح onLayout له بإعادة تحجيم/ملاءمة العارض عندما يتغير ارتفاع الشريط. للحصول على تسلسل بدء المشغل المشترك للعارض والبحث والتعليق، راجع البدء السريع.
البحث من جافاسكريبت
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) | ينتقل إلى فهرس تطابق يبدأ من الصفر. |
مسار الوسيط يستخدم search=<term> و exact=true|false ويعيد XML. استخدم واجهة برمجة تطبيقات الودجت بدلاً من تحليل تلك الاستجابة الداخلية بنفسك.
فحص قدرة البحث
تقرير استجابة التهيئة:
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يحذفان حزم البحث.- الوسطية (middleware) ترفض البحث بدلاً من إرجاع النتائج المرخصة.
تحكم في رؤية واجهة المستخدم المخصصة من خلال IDoconutLicenseService.IsCapabilityGranted(LicenseCapability.Search) واستخدم CanSearch() للحكم المنفصل على التنسيق/الجلسة.
استكشاف الأخطاء وإصلاحها
| العَرَض | التحقق |
|---|---|
| شريط البحث مفقود | قدرة البحث و IncludeSearchCss/IncludeSearchScripts/IncludeSearchBar |
CanSearch() غير صحيح | عارض التنسيق، المسار المختار DefaultRender، ورأس استجابة التهيئة |
| البحث يُعيد صفرًا لملف PDF ممسوح | المستند لا يحتوي على طبقة نصية؛ استخدم مصدرًا يحمل نصًا أو إسقاط PDF يحافظ على النص |
| البحث يعمل لكن التحديدات غير متطابقة | مسار العرض، الدقة، تحويلات المستند، وصناديق الكلمات المستخرجة |
هل كانت هذه الصفحة مفيدة؟