Tìm kiếm

Doconut Viewer cung cấp tính năng Tìm kiếm thông thường bằng cách sử dụng văn bản được trích xuất bởi trình xem định dạng hoặc một chuyển hướng PDF dựa trên văn bản. Nó yêu cầu khả năng cấp phép Search.

Bật giao diện người dùng tìm kiếm

Tìm kiếm là một mô-đun Viewer, không phải một thanh công cụ độc lập. Trang hoàn chỉnh phải bao gồm các tài nguyên Viewer, thanh công cụ Viewer, phần gắn Viewer và objViewer đã được khởi tạo; sau đó Ribbon Tìm kiếm sẽ được gắn và đính kèm vào cùng một thể hiện.

Tìm kiếm và chú thích là các tính năng có giấy phép tích hợp, không phải các gói AddPlugin<T>(). Yêu cầu các tài nguyên tìm kiếm từ Viewer được tiêm vào; các thẻ của chúng chỉ được phát ra khi giấy phép cho phép Tìm kiếm.

@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 được nhúng gọi các phương thức JavaScript giống như UI tùy chỉnh.

Giữ thành phần Viewer đầy đủ hiển thị trong markup, khởi tạo docViewer trước, và sau đó gắn Ribbon có giấy phép:

<nav id="toolbar" aria-label="Document viewer controls">
    <!-- Viewer controls, including the button that opens 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>

Thành phần này tiêm các nhóm Find, Options và Results và xử lý việc tìm kiếm, xóa, đếm khớp, và điều hướng khớp trước/sau. Một thanh công cụ Viewer thuộc sở hữu máy chủ chỉ cần bật tắt nó:

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

API công cộng của nó được giữ cố ý ngắn gọn:

Callback tùy chọn onToggle(isOpen) cho phép máy chủ đồng bộ nút Tìm kiếm, và onLayout cho phép nó thay đổi kích thước/điều chỉnh lại viewer khi Ribbon thay đổi chiều cao. Đối với chuỗi khởi động kết hợp Viewer, Tìm kiếm và Chú thích, xem phần Bắt đầu nhanh.

Tìm kiếm từ JavaScript

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

Tham số thứ hai là khớp toàn từ/chính xác. Sau khi gọi callback:

Đường trung gian sử dụng search=<term> và exact=true|false và trả về XML. Hãy dùng API widget thay vì tự phân tích phản hồi nội bộ đó.

Kiểm tra khả năng tìm kiếm

Phản hồi khởi tạo báo cáo:

X-Doconut-Can-Search: 1

Sau khi khởi tạo, objViewer.CanSearch() cung cấp cùng một phán đoán định dạng/phiên. Nó trả về false khi máy chủ gửi 0; trước khi nhận phản hồi, hoặc với máy chủ cũ bỏ qua header, nó mặc định là true.

Ba cổng độc lập không nên bị nhầm lẫn:

Một định dạng có thể về mặt kỹ thuật là có thể tìm kiếm trong khi giấy phép hiện tại lại từ chối thao tác.

Bật trích xuất theo định dạng

var token = await viewer.OpenDocumentAsync(path, new PdfConfig
{
    AllowSearch = true,
    AllowCopy   = true   // optional: lets the user drag a region and copy its text
});

AllowSearch và AllowCopy tồn tại trên PdfConfig, WordConfig, ExcelConfig và PptConfig. Các thuộc tính Office ủy quyền tới PdfConfig lồng bên trong. Cả hai mặc định là false.

Các bộ chuyển đổi tìm kiếm gốc bình thường có sẵn cho PDF, Word, Excel, PowerPoint, TXT, Visio, email, EPUB và MHT. XPS sử dụng đường dẫn PDF của nó theo mặc định. HTML và Microsoft Project hưởng lợi từ chuyển hướng PDF dựa trên văn bản:

// DefaultRender = false → converted to a text-based PDF → searchable
var token = await viewer.OpenDocumentAsync(path, new HtmlConfig { DefaultRender = false });

Đối với các bộ render gốc, CanSearch() mô tả khả năng của viewer; nó không đảm bảo rằng một tài liệu cụ thể chứa văn bản có thể sử dụng. Một PDF chỉ có các hình ảnh quét vẫn có thể trả về không có kết quả gốc.

Hành vi Tìm kiếm bình thường

Máy chủ thử các nguồn tìm kiếm theo thứ tự sau:

1. Kết quả ISearchableViewer gốc.
2. Chỉ mục .srh đã được xây dựng sẵn.
3. Lỗi/kết quả trống khi không có nguồn tìm kiếm nào.

CanSearch() có thể trả về true cho một viewer có khả năng tìm kiếm ngay cả khi một tài liệu quét cụ thể không có lớp văn bản và do đó không trả về khớp nào.

Giấy phép và hành vi UI

Giấy phép Temporary/Demo đang hoạt động cấp quyền Tìm kiếm trong thời gian hiệu lực. Một giấy phép thiếu hoặc tệp TRIAL kế thừa không cấp bất kỳ khả năng Tìm kiếm nào. Khi không có Tìm kiếm:

• ReferenceCss và ReferenceScripts sẽ bỏ qua các gói tìm kiếm.
• Middleware sẽ từ chối tìm kiếm thay vì trả về kết quả có giấy phép.

Điều khiển hiển thị UI tùy chỉnh từ IDoconutLicenseService.IsCapabilityGranted(LicenseCapability.Search) và sử dụng CanSearch() để xác định phán đoán định dạng/phiên riêng biệt.

Khắc phục sự cố