جستجو

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

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

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

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

جستجو و حاشیه‌نویسی ویژگی‌های مجوزدار داخلی هستند، نه بسته‌های AddPlugin<T>(). منابع جستجو را از Viewer درخواست کنید؛ برچسب‌های آنها فقط زمانی صادر می‌شوند که مجوز جستجو را اعطا کند. نماهای MVC 5 هیچ @inject ندارند، بنابراین برچسب‌ها را در کنترلر بسازید و آنها را از طریق ViewBag، همراه با پرچم مجوزی که صفحه نیاز دارد، منتقل کنید:

csharp
public class ViewerController : Controller
{
    public ActionResult Index()
    {
        var viewer = Doconut.DoconutHost.Services.GetRequiredService<Viewer>();
        ViewBag.ViewerCss = viewer.ReferenceCss(new CssConfig
        {
            IncludeViewerCss = true,
            IncludeSearchCss = true
        });
        ViewBag.ViewerScripts = viewer.ReferenceScripts(new ScriptConfig
        {
            IncludeJQuery        = true,
            IncludeViewerScripts = true,
            IncludeSearchScripts = true,
            IncludeSearchBar     = true
        });
        ViewBag.IsSearchEnabled = viewer.IsSearchEnabled;
        return View();
    }
}

آنها را در نما با استفاده از @Html.Raw(ViewBag.ViewerCss) و @Html.Raw(ViewBag.ViewerScripts) بنویسید. در Web Forms، همان مقادیر را از کد‑پشت (code-behind) در دسترس قرار دهید و با <%= %> بنویسید.

نوار Ribbon جاسازی‌شده همان متدهای JavaScript موجود برای یک رابط کاربری سفارشی را فراخوانی می‌کند.

ترکیب کامل Viewer را در نشانه‌گذاری (markup) قابل مشاهده نگه دارید، ابتدا 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 ((bool)ViewBag.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(...) باعث خطا می‌شود و صفحه نمایشگر را از شروع متوقف می‌کند. در Web Forms، همان محافظ را به صورت <% if (IsSearchEnabled) { %> … <% } %> بنویسید.

این کامپوننت گروه‌های 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
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)به شاخص تطابق صفر‑پایه می‌نویسد.

DocImage.axd به 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. یک نتیجهٔ خطا/خالی وقتی منبع جستجویی وجود ندارد.

CanSearch() می‌تواند برای یک نمایشگر قابل جستجو درست باشد حتی وقتی سند خاصی لایهٔ متنی ندارد و بنابراین هیچ تطابقی برنمی‌گرداند.

رفتار مجوز و UI

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

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

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

عیب‌یابی

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

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