การค้นหา
การค้นหาข้อความแบบเนทีฟในส่วนประกอบ Viewer
The Doconut Viewer ให้การค้นหาปกติโดยใช้ข้อความที่สกัดจากตัวดูรูปแบบหรือการเปลี่ยนเส้นทาง PDF แบบข้อความ. จำเป็นต้องมีความสามารถของใบอนุญาต Search.
เปิดใช้งาน UI การค้นหา
Search เป็นโมดูลของ Viewer ไม่ใช่แถบเครื่องมือแบบแยกส่วน. หน้าเต็มต้องรวมทรัพยากร Viewer, แถบเครื่องมือ Viewer, การเมานท์ Viewer, และ objViewer ที่ได้เริ่มต้นแล้ว; จากนั้น Ribbon การค้นหาจะถูกเมานท์และแนบกับอินสแตนซ์เดียวกันนั้น.
Search และ annotation เป็นฟีเจอร์ที่มีใบอนุญาตในตัว, ไม่ใช่แพคเกจ AddPlugin<T>(). ขอทรัพยากรการค้นหาจาก Viewer; แท็กของพวกเขาจะถูกสร้างขึ้นเฉพาะเมื่อใบอนุญาตให้ Search. มุมมอง MVC 5 ไม่มี @inject, ดังนั้นให้สร้างแท็กในคอนโทรลเลอร์และส่งต่อไปยัง ViewBag, พร้อมกับแฟล็กใบอนุญาตที่หน้าต้องการ:
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 เดียวกันที่มีให้กับ UI แบบกำหนดเอง.
รักษาส่วนประกอบ Viewer ทั้งหมดให้มองเห็นได้ใน markup, เริ่มต้น docViewer ก่อน, แล้วจึงแนบ Ribbon ที่มีใบอนุญาต:
<nav id="toolbar" aria-label="Document viewer controls">
<!-- ตัวควบคุม Viewer, รวมถึงปุ่มที่เปิดการค้นหา -->
</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 ด้านเซิร์ฟเวอร์มีความสำคัญ: หากไม่มีความสามารถ Search, ReferenceScripts จะละเว้นสคริปต์ของ Ribbon, ดังนั้นการเรียก doconutSearchBar(...) ที่ไม่มีการป้องกันจะทำให้เกิดข้อผิดพลาดและหยุดการเริ่มต้นหน้า viewer. ใน Web Forms, เขียนการป้องกันเดียวกันเป็น <% if (IsSearchEnabled) { %> … <% } %>.
คอมโพเนนต์จะฉีดกลุ่ม Find, Options, และ Results และจัดการการค้นหา, การล้าง, จำนวนการจับคู่, และการนำทางไปยังการจับคู่ก่อนหน้า/ถัดไป. แถบเครื่องมือ Viewer ที่เป็นของโฮสต์เพียงต้องสลับเปิด/ปิดมัน:
searchBar.isOpen() ? searchBar.close() : searchBar.open();API สาธารณะของมันถูกออกแบบให้เล็กลงโดยเจตนา:
| เมธอด | วัตถุประสงค์ |
|---|---|
attach(objViewer) | เชื่อมต่อ Ribbon กับ viewer ที่ได้เริ่มต้นแล้ว; จำเป็นต้องทำครั้งเดียว |
open() / close() | แสดงหรือซ่อน Ribbon; การปิดยังทำการล้างไฮไลท์ด้วย |
reset() | ล้างคำค้นปัจจุบัน, จำนวนผลลัพธ์, และไฮไลท์ |
isOpen() | รายงานว่า Ribbon ปรากฏหรือไม่ |
setStatus(message) | ส่งต่อข้อความสถานะผ่าน callback ที่กำหนดค่าไว้ |
callback onToggle(isOpen) ทางเลือกทำให้โฮสต์ซิงโครไนซ์ปุ่ม Search ของมัน, และ onLayout ทำให้มันปรับขนาด/ฟิต viewer เมื่อ Ribbon เปลี่ยนความสูง. สำหรับลำดับการเริ่มต้นของ Viewer, Search, และ Annotation ที่รวมกัน, ดูที่ เริ่มต้นอย่างเร็ว.
การค้นหาจาก JavaScript
objViewer.Search(keyword, false, function (resultCount) {
console.log('Matches:', resultCount);
});อาร์กิวเมนต์ที่สองเป็นการจับคู่แบบคำเต็ม/ตรงกันทั้งหมด จำนวนการจับคู่จะมาถึงใน callback: Search เองส่งไปยังเซิร์ฟเวอร์และคืนค่าไม่มีประโยชน์ ดังนั้น var n = objViewer.Search(keyword, false) จะอ่าน undefined เสมอ — และหน้าที่สร้างแบบนั้นจะแจ้งว่า "ไม่พบผลลัพธ์" ในขณะที่ viewer เน้นการจับคู่ หลังจาก callback:
| วิธีการ | ผลลัพธ์ |
|---|---|
SearchMatchCount() | จำนวนการจับคู่แต่ละรายการทั้งหมดในเอกสาร |
SearchSummary(false) | [pageNumber, matchCount] รายการโดยไม่ต้องรีเพนท์ |
SearchSummary(true) | สรุปเดียวกันและวาดไฮไลท์ของหน้า/ภาพย่อ |
GotoSearchMatch(index) | นำทางไปยังดัชนีการจับคู่ที่เริ่มจากศูนย์ |
DocImage.axd ตอบกลับ search=<term> และ exact=true|false ด้วย XML ใช้ widget API แทนการพาร์สการตอบกลับภายในด้วยตนเอง
ตรวจสอบความสามารถในการค้นหา
การตอบกลับการเริ่มต้นรายงานว่า:
X-Doconut-Can-Search: 1หลังจากการเริ่มต้น, objViewer.CanSearch() เปิดเผยผลการตัดสินรูปแบบ/เซสชันเดียวกัน มันคืนค่า false เมื่อเซิร์ฟเวอร์ส่ง 0; ก่อนการตอบกลับ, หรือกับเซิร์ฟเวอร์รุ่นเก่าที่ละเว้นหัวข้อ, มันจะใช้ค่าเริ่มต้นเป็น true
ต้องไม่สับสนกับสามประตูอิสระต่อไปนี้:
| ประตู | คำถาม |
|---|---|
CanSearch() / response header | ตัวดูที่ได้รับการแก้ไขมีดัชนี/เส้นทางการค้นหาแบบเนทีฟหรือไม่? |
AllowSearch | การตั้งค่าแบบฟอร์มนี้ได้ร้องขอการสกัดข้อความที่สวิตช์มีอยู่หรือไม่? |
LicenseCapability.Search | แอปพลิเคชันได้รับอนุญาตให้ดำเนินการค้นหาและรับชุด UI หรือไม่? |
รูปแบบอาจสามารถค้นหาได้ทางเทคนิคในขณะที่ใบอนุญาตปัจจุบันปฏิเสธการดำเนินการ
เปิดใช้งานการสกัดข้อมูลตามรูปแบบ
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, email, EPUB, และ MHT. XPS ใช้เส้นทาง PDF ของมันเป็นค่าเริ่มต้น. HTML และ Microsoft Project ได้ประโยชน์จากการเปลี่ยนเส้นทางเป็น PDF ที่อิงข้อความ:
// DefaultRender = false → แปลงเป็น PDF แบบข้อความ → ที่สามารถค้นหาได้
var token = await viewer.OpenDocumentAsync(path, new HtmlConfig { DefaultRender = false });สำหรับเรนเดอร์เนทีฟ, CanSearch() อธิบายความสามารถของ viewer; มันไม่ได้รับประกันว่าเอกสารเฉพาะจะมีข้อความที่ใช้ได้ PDF ที่หน้ามีเพียงภาพสแกนเท่านั้นอาจยังให้ผลลัพธ์เนทีฟเป็นศูนย์
พฤติกรรมการค้นหาปกติ
เซิร์ฟเวอร์จะลองแหล่งค้นหาในลำดับต่อไปนี้:
- ผลลัพธ์จาก viewer เนทีฟของรูปแบบ
- ดัชนีการค้นหา
.srhที่สร้างไว้ล่วงหน้า - ผลลัพธ์ข้อผิดพลาด/ว่างเมื่อไม่มีแหล่งค้นหา
CanSearch() สามารถเป็นจริงสำหรับ viewer ที่ค้นหาได้แม้ว่าเอกสารเฉพาะจะไม่มีชั้นข้อความและจึงไม่คืนการจับคู่ใดๆ
การให้สิทธิ์และพฤติกรรม UI
ใบอนุญาต Temporary/Demo ที่ใช้งานอยู่ให้สิทธิ์การค้นหาในช่วงเวลาที่ใช้งานอยู่. การไม่มีใบอนุญาตและไฟล์ TRIAL รุ่นเก่าไม่ได้ให้ความสามารถในการค้นหา. หากไม่มีการค้นหา:
ReferenceCssและReferenceScriptsไม่รวมชุดค้นหาDocImage.axdปฏิเสธคำขอค้นหาแทนการคืนผลลัพธ์
ควบคุมการมองเห็น UI แบบกำหนดเองจาก IDoconutLicenseService.IsCapabilityGranted(LicenseCapability.Search) และใช้ CanSearch() สำหรับผลการตัดสินรูปแบบ/เซสชันแยก
การแก้ไขปัญหา
| อาการ | ตรวจสอบ |
|---|---|
| แถบค้นหาหายไป | ความสามารถในการค้นหาและ IncludeSearchCss/IncludeSearchScripts/IncludeSearchBar |
CanSearch() เป็น false | Viewer ของรูปแบบ, เส้นทาง DefaultRender ที่เลือก, และหัวการตอบกลับการเริ่มต้น |
| การค้นหาส่งคืนศูนย์สำหรับ PDF ที่สแกน | เอกสารไม่มีชั้นข้อความ; ใช้แหล่งที่มีข้อความหรือการฉาย PDF ที่รักษาข้อความไว้ |
| การค้นหาทำงานแต่ไฮไลท์เบี่ยงเบน | เส้นทางการเรนเดอร์, ความละเอียด, การแปลงเอกสาร, และกล่องคำที่สกัดออกมา |
หน้านี้เป็นประโยชน์หรือไม่?