جستجو

جستجوی متنی بومی در ترکیب Viewer

Viewer Doconut جستجوی معمولی را با استفاده از متنی که توسط نمایشگر فرمت استخراج می‌شود یا یک تغییر مسیر 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 در دسترس برای یک UI سفارشی را فراخوانی می‌کند.

ترکیب کامل Viewer را در نشانه‌گذاری قابل مشاهده نگه دارید، ابتدا docViewer را مقداردهی اولیه کنید، و سپس Ribbon دارای مجوز را متصل کنید:

html
<nav id="toolbar" aria-label="Document viewer controls">
    <!-- کنترل‌های Viewer، شامل دکمه‌ای که Search را باز می‌کند -->
</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(...) خطا می‌اندازد و صفحه Viewer را از شروع متوقف می‌کند.

کامپوننت گروه‌های Find، Options و Results را تزریق می‌کند و جستجو، پاک‌سازی، شمارش تطابق‌ها و ناوبری تطابق قبلی/بعدی را مدیریت می‌نماید. نوار ابزار Viewer متعلق به میزبان فقط نیاز به تعویض وضعیت دارد:

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

API عمومی آن به‌طور عمدی کوچک است:

متدهدف
attach(objViewer)اتصال Ribbon به Viewer اولیه‌شده؛ یک بار مورد نیاز
open() / close()نمایش یا مخفی کردن Ribbon؛ بستن همچنین هایلایت‌ها را پاک می‌کند
reset()پاک کردن عبارت جاری، تعداد نتایج، و هایلایت‌ها
isOpen()گزارش اینکه آیا Ribbon قابل مشاهده است
setStatus(message)ارسال پیام وضعیت از طریق callback پیکربندی‌شده

callback اختیاری onToggle(isOpen) به میزبان اجازه می‌دهد دکمه جستجوی خود را همگام‌سازی کند، و onLayout به او امکان تغییر اندازه/بازتنظیم Viewer را وقتی 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)به شاخص تطابق صفر‑پایه می‌رود.

مسیر میانی‌افزار از search=<term> و exact=true|false استفاده می‌کند و XML برمی‌گرداند. به جای تجزیهٔ پاسخ داخلی خودتان، از API ویجت استفاده کنید.

بررسی قابلیت جستجو

پاسخ مقداردهی اولیه گزارش می‌دهد:

text
X-Doconut-Can-Search: 1

پس از مقداردهی اولیه، objViewer.CanSearch() همان حکم فرمت/نشست را نشان می‌دهد. وقتی سرور 0 را می‌فرستد، false برگردانده می‌شود؛ قبل از پاسخ، یا با سرور قدیمی که سرآیند را حذف می‌کند، به طور پیش‌فرض به true تنظیم می‌شود.

سه دروازه مستقل نباید با هم اشتباه گرفته شوند:

دروازهسؤال
CanSearch() / سرآیند پاسخآیا نمایشگر حل‌شده مسیر بومی ایندکس/جستجو دارد؟
AllowSearchآیا این پیکربندی فرمت درخواست استخراج متن را در جایی که سوئیچ وجود دارد، کرده است؟
LicenseCapability.Searchآیا برنامه مجاز به اجرای جستجو و دریافت بسته‌های UI است؟

یک فرمت می‌تواند از نظر فنی قابل جستجو باشد در حالی که مجوز فعلی عملیات را رد می‌کند.

فعال‌سازی استخراج برای هر فرمت

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() می‌تواند برای یک نمایشگر قابل جستجو صحیح باشد حتی وقتی سند خاصی لایه متن ندارد و بنابراین هیچ تطابقی بر نمی‌گرداند.

مجوزها و رفتار UI

یک مجوز موقت/دموی فعال، جستجو را در دوره فعال خود اعطا می‌کند. یک مجوز مفقود و فایل قدیمی TRIAL هیچ قابلیت جستجویی را اعطا نمی‌کند. بدون جستجو:

  • ReferenceCss و ReferenceScripts بسته‌های جستجو را حذف می‌کنند.
  • میانی‌نرم‌افزار جستجو را رد می‌کند به جای برگرداندن نتایج دارای مجوز.

قابلیت نمایش UI سفارشی را از IDoconutLicenseService.IsCapabilityGranted(LicenseCapability.Search) هدایت کنید و برای حکم جداگانه فرمت/نشست از CanSearch() استفاده کنید.

عیب‌یابی

علائمبررسی
نوار جستجو موجود نیستقابلیت جستجو و IncludeSearchCss/IncludeSearchScripts/IncludeSearchBar
CanSearch() نادرست استنمایشگر فرمت، مسیر انتخاب‌شده DefaultRender، و سرآیند پاسخ مقداردهی اولیه
جستجو برای یک PDF اسکن‌شده صفر برمی‌گرداندسند لایه متنی ندارد؛ از منبع حاوی متن یا یک پروژکشن PDF که متن را حفظ می‌کند استفاده کنید.
جستجو کار می‌کند اما هایلایت‌ها جابجا هستندمسیر رندر، وضوح، تبدیل‌های سند، و جعبه‌های کلمه استخراج‌شده

آیا این صفحه مفید بود؟