بحث

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

يوفر عارض Doconut بحثًا عاديًا باستخدام النص المستخرج من عارض الصيغة أو إعادة توجيه 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: '/',
        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() / 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 يحافظ على النص
البحث يعمل لكن التظليل غير متطابقمسار العرض، الدقة، تحويلات المستند، ومربعات الكلمات المستخرجة

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