Tìm kiếm

Tìm kiếm văn bản gốc trong thành phần Viewer

The 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 chuyển hướng PDF dựa trên văn bản. Nó yêu cầu khả năng giấy phép Search.

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

Search là một mô-đun của Viewer, không phải là 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; Ribbon Search sau đó được gắn và đính kèm vào cùng một thể hiện.

Search và annotation là các tính năng có giấy phép được tích hợp sẵn, 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; các thẻ của chúng chỉ được phát ra khi giấy phép cho phép 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 nhúng gọi các phương thức JavaScript giống như trong giao diện người dùng 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 đó đính kèm Ribbon có giấy phép:

html
<nav id="toolbar" aria-label="Document viewer controls">
    <!-- Các điều khiển trình xem, bao gồm nút mở Tìm kiếm -->
</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 phía máy chủ quan trọng: nếu không có khả năng Search, ReferenceScripts sẽ bỏ qua script của Ribbon, vì vậy một lời gọi doconutSearchBar(...) không được bảo vệ sẽ gây lỗi và ngăn trang viewer khởi động.

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 kết quả khớp, và điều hướng khớp trước/sau. Thanh công cụ Viewer thuộc sở hữu máy chủ chỉ cần bật tắt nó:

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

API công cộng của nó được thiết kế cố ý nhỏ gọn:

Phương thứcMục đích
attach(objViewer)Kết nối Ribbon với viewer đã được khởi tạo; yêu cầu một lần
open() / close()Hiển thị hoặc ẩn Ribbon; đóng cũng sẽ xóa các điểm nổi bật
reset()Xóa thuật ngữ hiện tại, số lượng kết quả và các điểm nổi bật
isOpen()Báo cáo xem Ribbon có đang hiển thị hay không
setStatus(message)Chuyển tiếp một tin nhắn trạng thái qua callback đã cấu hình

Callback tùy chọn onToggle(isOpen) cho phép máy chủ đồng bộ nút Search của mình, 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, Search và Annotation, xem Bắt đầu nhanh.

Tìm kiếm từ JavaScript

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

Đối số thứ hai là khớp toàn từ/chính xác. Số lượng khớp được truyền trong callback: Search tự nó gửi tới máy chủ và không trả về gì hữu ích, vì vậy var n = objViewer.Search(keyword, false) luôn đọc undefined — và một trang được xây dựng theo cách đó sẽ báo "không tìm thấy" trong khi viewer làm nổi bật các kết quả khớp. Sau callback:

Phương thứcKết quả
SearchMatchCount()Tổng số kết quả khớp riêng lẻ trong tài liệu.
SearchSummary(false)[pageNumber, matchCount] mục mà không cần vẽ lại.
SearchSummary(true)Cùng bản tóm tắt và vẽ các điểm nổi bật trên trang/ảnh thu nhỏ.
GotoSearchMatch(index)Điều hướng tới chỉ mục khớp bắt đầu từ 0.

Đường trung gian sử dụng search=<term> và exact=true|false và trả về XML. Hãy sử 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:

text
X-Doconut-Can-Search: 1

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

Ba cổng độc lập không được nhầm lẫn:

CổngCâu hỏi
CanSearch() / response headerTrình xem đã giải quyết có đường dẫn chỉ mục/tìm kiếm gốc không?
AllowSearchCấu hình định dạng này có yêu cầu trích xuất văn bản ở nơi công tắc tồn tại không?
LicenseCapability.SearchỨng dụng có được ủy quyền thực hiện tìm kiếm và nhận các gói UI không?

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

Kích hoạt trích xuất cho mỗi định dạng

csharp
var token = await viewer.OpenDocumentAsync(path, new PdfConfig
{
    AllowSearch = true,
    AllowCopy   = true   // tùy chọn: cho phép người dùng kéo một vùng và sao chép văn bản của nó
});

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

Các bộ điều hợp tìm kiếm gốc thông thường tồn tại 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ừ việc chuyển hướng PDF dựa trên văn bản:

csharp
// DefaultRender = false → chuyển đổi thành PDF dựa trên văn bản → có thể tìm kiếm
var token = await viewer.OpenDocumentAsync(path, new HtmlConfig { DefaultRender = false });

Đối với các trình dựng gốc, CanSearch() mô tả khả năng của trình xem; 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 được. Một PDF mà các trang chỉ là hình ảnh quét vẫn có thể cho ra 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ả từ trình xem gốc của định dạng.
  2. Một chỉ mục tìm kiếm .srh đã được xây dựng sẵn.
  3. Kết quả lỗi/trống khi không có nguồn tìm kiếm nào.

Chỉ mục .srh là artefact tìm kiếm được xuất bản cùng với các hình ảnh trang khi tài liệu được phục vụ từ lưu trữ chung, vì vậy một nút chưa bao giờ mở tài liệu vẫn có thể trả lời các tìm kiếm — xem Triển khai phân tán.

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

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

Giấy phép Tạm thời/Demo đang hoạt động cho phép Tìm kiếm trong thời gian hiệu lực của nó. Khi thiếu giấy phép và tệp legacy TRIAL không cung cấp khả năng Tìm kiếm. Không có Tìm kiếm:

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

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

Khắc phục sự cố

Triệu chứngKiểm tra
Thanh tìm kiếm bị thiếuKhả năng tìm kiếm và IncludeSearchCss/IncludeSearchScripts/IncludeSearchBar
CanSearch() là saiTrình xem định dạng, đường dẫn DefaultRender đã chọn, và tiêu đề phản hồi khởi tạo
Tìm kiếm trả về không có kết quả cho PDF đã quétTài liệu không có lớp văn bản; sử dụng nguồn có văn bản hoặc một phép chiếu PDF giữ nguyên văn bản
Tìm kiếm hoạt động nhưng các phần nổi bật bị lệchĐường dẫn render, độ phân giải, biến đổi tài liệu, và các hộp từ đã trích xuất

Trang này có hữu ích không?