การค้นหา

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

Doconut Viewer ให้การค้นหาปกติโดยใช้ข้อความที่สกัดจาก format 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 ที่รวมกัน, ดูที่ Quick Start.

การค้นหาจาก 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 ที่ใช้งานอยู่จะให้สิทธิ์การค้นหาในช่วงเวลาที่ใช้งาน. ใบอนุญาตที่หายไปและไฟล์ legacy TRIAL จะไม่ให้ความสามารถในการค้นหา. หากไม่มีการค้นหา:

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

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

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

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

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