بحث

بحث نصي أصلي في تركيبة العارض

يوفر Doconut Viewer بحثًا عاديًا باستخدام النص المستخرج من عارض التنسيق أو إعادة توجيه PDF المعتمد على النص. يتطلب قدرة الترخيص Search.

تمكين واجهة البحث

البحث هو وحدة في العارض، وليس شريط أدوات مستقل. يجب أن تشمل الصفحة الكاملة موارد العارض، شريط أدوات العارض، تثبيت العارض، وobjViewer المُهيأ؛ ثم يتم تثبيت شريط البحث وإرفاقه بنفس المثيل.

البحث والتعليق هما ميزتان مرخصتان مدمجتان، وليسا حزم 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
}))

الشريط المدمج يستدعي نفس طرق JavaScript المتاحة لواجهة مستخدم مخصصة.

احافظ على رؤية تركيبة العارض الكاملة في العلامات، قم بتهيئة docViewer أولاً، ثم أرفق الشريط المرخص:

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 سكريبت الشريط، لذا فإن استدعاء doconutSearchBar(...) غير محمي سيتسبب في رمي استثناء وإيقاف تشغيل صفحة العارض.

يحقن المكوّن مجموعات Find و Options و Results ويتعامل مع البحث، والمسح، وعدد التطابقات، والتنقل بين التطابق السابق/التالي. يحتاج شريط أدوات العارض المملوك للمضيف فقط إلى تبديله:

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

واجهة برمجة التطبيقات العامة لها صغيرة عن قصد:

الطريقةالغرض
attach(objViewer)ربط الشريط بالعارض المُهيأ؛ مطلوب مرة واحدة
open() / close()إظهار أو إخفاء الشريط؛ الإغلاق أيضًا يمسح التظليل
reset()مسح المصطلح الحالي، عدد النتائج، والتظليلات
isOpen()الإبلاغ عما إذا كان الشريط مرئيًا
setStatus(message)تمرير رسالة حالة عبر الاستدعاء الراجع المُكوَّن

يسمح الاستدعاء الراجع الاختياري onToggle(isOpen) للمضيف بمزامنة زر البحث الخاص به، ويسمح onLayout له بإعادة تحجيم/إعادة ملاءمة العارض عندما يتغير ارتفاع الشريط. لتسلسل بدء تشغيل العارض المشترك مع البحث والتعليق، راجع البدء السريع.

البحث من JavaScript

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)ينتقل إلى فهرس تطابق يبدأ من الصفر.

يستخدم مسار الوسيط search=<term> وexact=true|false ويعيد XML. استخدم واجهة برمجة تطبيقات الودجت بدلاً من تحليل تلك الاستجابة الداخلية بنفسك.

التحقق من قدرة البحث

تقرير استجابة التهيئة:

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 يحافظ على النص
البحث يعمل لكن التظليل غير متطابقمسار العرض، الدقة، تحويلات المستند، وصناديق الكلمات المستخرجة

هل كانت هذه الصفحة مفيدة؟