جستجو

جستجوی متن بومی در ترکیب 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 را که برای یک رابط کاربری سفارشی در دسترس هستند، فراخوانی می‌کند.

ترکیب کامل 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 به آن امکان می‌دهد هنگام تغییر ارتفاع Ribbon، Viewer را دوباره اندازه‌گیری/تنظیم کند. برای توالی راه‌اندازی ترکیبی 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() / response headerآیا نمایشگر حل‌شده مسیر ایندکس/جستجوی بومی دارد؟
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() می‌تواند برای یک نمایشگر قابل جستجو صحیح باشد حتی زمانی که یک سند اسکن‌شده خاص لایه متنی ندارد و بنابراین هیچ تطبیقی برنمی‌گرداند.

رفتار مجوز و رابط کاربری

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

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

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

عیب‌یابی

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

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