جستجو

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

Viewer Doconut جستجوی معمولی را با استفاده از متنی که توسط نمایشگر فرمت استخراج می‌شود یا یک تغییر مسیر PDF مبتنی بر متن فراهم می‌کند. این نیاز به قابلیت مجوز Search دارد.

فعال‌سازی رابط کاربری جستجو

Search یک ماژول Viewer است، نه نوار ابزار مستقل. صفحه کامل باید شامل منابع Viewer، نوار ابزار Viewer، نصب Viewer، و objViewer مقداردهی اولیه شده باشد؛ سپس Ribbon جستجو نصب و به همان نمونه متصل می‌شود.

Search و annotation ویژگی‌های دارای مجوز داخلی هستند، نه بسته‌های AddPlugin<T>(). منابع جستجو را از Viewer تزریق‌شده درخواست کنید؛ برچسب‌های آن‌ها فقط زمانی صادر می‌شوند که مجوز Search را اعطا کند.

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: '/',
        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 سمت سرور مهم است: بدون قابلیت Search، 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، به Quick Start مراجعه کنید.

جستجو از JavaScript

javascript
objViewer.Search(keyword, false, function (resultCount) {
    console.log('Matches:', resultCount);
});

آرگومان دوم برای مطابقت کامل/کلمه‌به‌کلمه است. شمارش تطابق‌ها در callback می‌رسد: Search خود به سرور می‌رود و هیچ چیز مفیدی برنمی‌گرداند، بنابراین var n = objViewer.Search(keyword, false) همیشه undefined را می‌خواند — و صفحه‌ای که به این شکل ساخته شده «nothing found» گزارش می‌دهد در حالی که 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() می‌تواند برای یک نمایشگر قابل جستجو صحیح باشد حتی زمانی که یک سند اسکن‌شده خاص لایه متنی ندارد و بنابراین هیچ تطابقی برنمی‌گرداند.

رفتار مجوز و UI

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

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

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

عیب‌یابی

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

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