การค้นหา

การค้นหาข้อความแบบดั้งเดิมในส่วนประกอบ Viewer

Doconut Viewer ให้การค้นหาปกติโดยใช้ข้อความที่สกัดจากตัวดูรูปแบบหรือการเปลี่ยนเส้นทาง PDF แบบข้อความ. มันต้องการความสามารถของใบอนุญาต Search.

เปิดใช้งาน UI การค้นหา

Search เป็นโมดูลของ Viewer, ไม่ใช่แถบเครื่องมือแยกอิสระ. หน้าเต็มต้องรวมทรัพยากร Viewer, แถบเครื่องมือ Viewer, การเมานท์ Viewer, และ objViewer ที่ได้เริ่มต้นแล้ว; จากนั้น Ribbon การค้นหาจะถูกเมานท์และแนบไปยังอินสแตนซ์เดียวกันนั้น.

Search และ annotation เป็นฟีเจอร์ที่มีใบอนุญาตในตัว, ไม่ใช่แพคเกจ AddPlugin<T>(). ขอทรัพยากรการค้นหาจาก Viewer ที่ถูกฉีดเข้า; แท็กของพวกเขาจะถูกปล่อยออกมาเฉพาะเมื่อใบอนุญาตให้ 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 ที่ฝังอยู่เรียกใช้เมธอด JavaScript เดียวกันที่พร้อมใช้งานสำหรับ UI ที่กำหนดเอง.

ให้ส่วนประกอบ Viewer ทั้งหมดมองเห็นได้ใน markup, เริ่มต้น docViewer ก่อน, แล้วจึงแนบ Ribbon ที่มีใบอนุญาต:

html
<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: '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 ฝั่งเซิร์ฟเวอร์มีความสำคัญ: หากไม่มีความสามารถ Search, ReferenceScripts จะละเว้นสคริปต์ของ Ribbon, ดังนั้นการเรียก doconutSearchBar(...) ที่ไม่มีการป้องกันจะทำให้เกิดข้อผิดพลาดและหยุดหน้า viewer จากการเริ่มต้น.

คอมโพเนนต์จะฉีดกลุ่ม 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) ทางเลือกทำให้โฮสต์สามารถซิงโครไนซ์ปุ่ม Search ของมัน, และ onLayout ทำให้มันปรับขนาด/ฟิต viewer เมื่อ Ribbon เปลี่ยนความสูง. สำหรับลำดับการเริ่มต้นของ Viewer, Search, และ Annotation ที่รวมกัน, ดู เริ่มต้นอย่างเร็ว.

การค้นหาจาก JavaScript

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)นำทางไปยังดัชนีการจับคู่ที่เริ่มจากศูนย์.

เส้นทาง middleware ใช้ search=<term> และ exact=true|false และคืนค่าเป็น XML. ใช้ widget API แทนการพาร์เซสตอบกลับภายในนั้นด้วยตนเอง.

ตรวจสอบความสามารถในการค้นหา

การตอบสนองการเริ่มต้นรายงานว่า:

text
X-Doconut-Can-Search: 1

หลังจากการเริ่มต้น, objViewer.CanSearch() เปิดเผยผลการตัดสินรูปแบบ/เซสชันเดียวกัน. มันจะคืนค่า false เมื่อเซิร์ฟเวอร์ส่ง 0; ก่อนการตอบสนอง, หรือกับเซิร์ฟเวอร์เก่าที่ละเว้นส่วนหัว, มันจะใช้ค่าเริ่มต้นเป็น 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. ผลลัพธ์ข้อผิดพลาด/ว่างเปล่าเมื่อไม่มีแหล่งค้นหา.

ดัชนี .srh คือศิลปวัตถุการค้นหาที่เผยแพร่พร้อมกับภาพหน้าเมื่อเอกสารถูกให้บริการจากที่เก็บข้อมูลร่วม, ดังนั้นโหนดที่ไม่เคยเปิดเอกสารก็ยังสามารถตอบการค้นหาได้ — ดู การปรับใช้แบบกระจาย.

CanSearch() สามารถเป็นจริงสำหรับตัวดูที่สามารถค้นหาได้แม้ว่าเอกสารสแกนเฉพาะจะไม่มีชั้นข้อความและจึงไม่คืนผลลัพธ์ใด.

การให้ใบอนุญาตและพฤติกรรม UI

ใบอนุญาต Temporary/Demo ที่ใช้งานอยู่จะให้สิทธิ์การค้นหาในช่วงเวลาที่ใช้งาน. ใบอนุญาตที่หายไปและไฟล์ TRIAL แบบเก่าไม่ให้ความสามารถในการค้นหา. หากไม่มีการค้นหา:

  • ReferenceCss และ ReferenceScripts ละเว้นชุดค้นหา.
  • มิดเดิลแวร์จะปฏิเสธการค้นหาแทนที่จะคืนผลลัพธ์ที่ได้รับใบอนุญาต.

ควบคุมการมองเห็น UI แบบกำหนดเองจาก IDoconutLicenseService.IsCapabilityGranted(LicenseCapability.Search) และใช้ CanSearch() สำหรับผลการตัดสินรูปแบบ/เซสชันแยกต่างหาก.

การแก้ไขปัญหา

อาการตรวจสอบ
แถบค้นหาหายไปความสามารถในการค้นหาและ IncludeSearchCss/IncludeSearchScripts/IncludeSearchBar
CanSearch() เป็นเท็จตัวดูรูปแบบ, เส้นทาง DefaultRender ที่เลือก, และส่วนหัวการตอบสนองการเริ่มต้น
การค้นหาให้ผลลัพธ์ศูนย์สำหรับ PDF ที่สแกนเอกสารไม่มีชั้นข้อความ; ใช้แหล่งที่มีข้อความหรือการฉาย PDF ที่รักษาข้อความไว้
การค้นหาทำงานแต่ไฮไลท์ตำแหน่งผิดเส้นทางการเรนเดอร์, ความละเอียด, การแปลงเอกสาร, และกล่องคำที่สกัดออกมา

หน้านี้เป็นประโยชน์หรือไม่?