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 chức năng Search 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.
Kích hoạt giao diện tìm kiếm
Search là một mô-đun Viewer, không phải là một thanh công cụ độc lập. Trang đầy đủ 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 Search sẽ đượ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 cấp phép 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ác thẻ của chúng chỉ được phát ra khi giấy phép cho phép Search. Các view MVC 5 không có @inject, vì vậy hãy xây dựng các thẻ trong controller và truyền chúng qua ViewBag, cùng với cờ giấy phép mà trang cần:
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();
}
}Viết chúng trong view bằng @Html.Raw(ViewBag.ViewerCss) và @Html.Raw(ViewBag.ViewerScripts). Trong Web Forms, mở rộng các giá trị tương tự từ code-behind và viết chúng bằng <%= %>.
Ribbon nhúng gọi các phương thức JavaScript giống như trong giao diện 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 cấp phép:
<nav id="toolbar" aria-label="Document viewer controls">
<!-- Các điều khiển của Viewer, bao gồm nút mở 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 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. Trong Web Forms, viết cùng một biện pháp bảo vệ như <% if (IsSearchEnabled) { %> … <% } %>.
Thành phần này chèn 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ó:
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ức | Mục đích |
|---|---|
attach(objViewer) | Kết nối Ribbon với viewer đã được khởi tạo; cần một lần duy nhất |
open() / close() | Hiển thị hoặc ẩn Ribbon; việc đóng cũng sẽ xóa các điểm nhấn |
reset() | Xóa thuật ngữ hiện tại, số lượng kết quả và các điểm nhấn |
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, 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
objViewer.Search(keyword, false, function (resultCount) {
console.log('Matches:', resultCount);
});Tham số thứ hai là khớp toàn từ/chính xác. Số lượng khớp được trả về trong callback: Search tự nó gửi đến 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 đó báo "không tìm thấy" trong khi trình xem làm nổi bật các kết quả khớp. Sau callback:
| Phương thức | Kết quả |
|---|---|
SearchMatchCount() | Tổng số khớp riêng lẻ trong tài liệu. |
SearchSummary(false) | mục mà không cần vẽ lại [pageNumber, matchCount] |
SearchSummary(true) | cùng tóm tắt và vẽ nổi bật trang/ảnh thu nhỏ. |
GotoSearchMatch(index) | Điều hướng tới chỉ mục khớp bắt đầu từ 0. |
DocImage.axd trả lời search=<term> và exact=true|false bằng 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:
X-Doconut-Can-Search: 1Sau khi khởi tạo, objViewer.CanSearch() công khai quyết định định dạng/phiên giống nhau. 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ũ bỏ qua tiêu đề, nó mặc định là true.
Ba cổng độc lập không được nhầm lẫn:
| Cổng | Câu hỏi |
|---|---|
CanSearch() / response header | Trình xem đã giải quyết có đường dẫn chỉ mục/tìm kiếm gốc không? |
AllowSearch | Cấ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 phép 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ể kỹ thuật tìm kiếm được trong khi giấy phép hiện tại từ chối thao tác.
Bật trích xuất cho từng định dạng
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 bình 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:
// 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. 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:
- Kết quả từ trình xem gốc của định dạng.
- Chỉ mục tìm kiếm
.srhđã được xây dựng trước. - Lỗi/kết quả trống khi không có nguồn tìm kiếm nào tồn tại.
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ề khớp nào.
Giấy phép và hành vi UI
Giấy phép Temporary/Demo đang hoạt động cho phép Tìm kiếm trong thời gian hiệu lực. Một giấy phép thiếu và tệp legacy TRIAL không cung cấp khả năng Tìm kiếm. Không có Tìm kiếm:
ReferenceCssvàReferenceScriptsbỏ qua các gói tìm kiếm.DocImage.axdtừ chối yêu cầu tìm kiếm thay vì trả về kết quả.
Đ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 quyết định định dạng/phiên riêng biệt.
Khắc phục sự cố
| Triệu chứng | Kiểm tra |
|---|---|
| Thanh tìm kiếm bị thiếu | Khả năng tìm kiếm và IncludeSearchCss/IncludeSearchScripts/IncludeSearchBar |
CanSearch() là sai | Trì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ề 0 cho PDF đã quét | Tà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 đánh dấu 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?