Pencarian

Pencarian teks asli dalam komposisi Viewer

The Doconut Viewer menyediakan Pencarian normal menggunakan teks yang diekstrak oleh penampil format atau pengalihan PDF berbasis teks. Ini memerlukan kemampuan lisensi Search.

Aktifkan UI pencarian

Pencarian adalah modul Viewer, bukan toolbar mandiri. Halaman lengkap harus menyertakan sumber daya Viewer, toolbar Viewer, mount Viewer, dan objViewer yang diinisialisasi; Ribbon Pencarian kemudian dipasang dan dilampirkan ke instance yang sama.

Pencarian dan anotasi adalah fitur berlisensi bawaan, bukan paket AddPlugin<T>(). Minta sumber daya pencarian dari Viewer yang disuntikkan; tag mereka hanya dikeluarkan ketika lisensi memberikan Pencarian.

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 yang disematkan memanggil metode JavaScript yang sama tersedia untuk UI kustom.

Pertahankan komposisi Viewer lengkap terlihat dalam markup, inisialisasi docViewer terlebih dahulu, lalu lampirkan Ribbon berlisensi:

html
<nav id="toolbar" aria-label="Document viewer controls">
    <!-- Kontrol penampil, termasuk tombol yang membuka pencarian -->
</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 sisi server penting: tanpa kemampuan Pencarian, ReferenceScripts menghilangkan skrip Ribbon, sehingga panggilan doconutSearchBar(...) yang tidak dilindungi akan melempar error dan menghentikan halaman viewer dari memulai.

Komponen menyuntikkan grup Find, Options, dan Results serta menangani pencarian, pembersihan, hitungan kecocokan, dan navigasi kecocokan sebelumnya/berikutnya. Toolbar Viewer yang dimiliki host hanya perlu mengaktifkannya:

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

API publiknya sengaja kecil:

MetodeTujuan
attach(objViewer)Hubungkan Ribbon ke viewer yang diinisialisasi; diperlukan sekali
open() / close()Tampilkan atau sembunyikan Ribbon; menutup juga menghapus sorotan
reset()Bersihkan istilah saat ini, hitungan hasil, dan sorotan
isOpen()Laporkan apakah Ribbon terlihat
setStatus(message)Teruskan pesan status melalui callback yang dikonfigurasi

Callback opsional onToggle(isOpen) memungkinkan host menyinkronkan tombol Pencarian-nya, dan onLayout memungkinkan ia mengubah ukuran/mengatur ulang viewer ketika tinggi Ribbon berubah. Untuk urutan startup gabungan Viewer, Pencarian, dan Anotasi, lihat Panduan Cepat.

Pencarian dari JavaScript

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

Argumen kedua adalah pencocokan kata lengkap/tepat. Hitungan kecocokan tiba di callback: Search sendiri pergi ke server dan tidak mengembalikan apa pun yang berguna, sehingga var n = objViewer.Search(keyword, false) selalu membaca undefined — dan halaman yang dibangun dengan cara itu melaporkan "tidak ada yang ditemukan" sementara viewer menyorot kecocokan. Setelah callback:

MetodeHasil
SearchMatchCount()Total kecocokan individu dalam dokumen.
SearchSummary(false)[pageNumber, matchCount] entri tanpa repainting.
SearchSummary(true)Ringkasan yang sama dan melukis sorotan halaman/thumbnail.
GotoSearchMatch(index)Menavigasi ke indeks kecocokan berbasis nol.

Rute middleware menggunakan search=<term> dan exact=true|false serta mengembalikan XML. Gunakan API widget alih-alih mem-parsing respons internal itu sendiri.

Periksa kemampuan pencarian

Respons inisialisasi melaporkan:

text
X-Doconut-Can-Search: 1

Setelah inisialisasi, objViewer.CanSearch() mengekspos keputusan format/sesi yang sama. Ia mengembalikan false ketika server mengirim 0; sebelum respons, atau dengan server lama yang menghilangkan header, secara default menjadi true.

Tiga gerbang independen tidak boleh dikacaukan:

GerbangPertanyaan
CanSearch() / response headerApakah penampil yang terresolusi memiliki jalur indeks/pencarian native?
AllowSearchApakah konfigurasi format ini meminta ekstraksi teks di mana saklar ada?
LicenseCapability.SearchApakah aplikasi diotorisasi untuk menjalankan pencarian dan menerima bundel UI?

Sebuah format dapat secara teknis dapat dicari sementara lisensi saat ini menolak operasi tersebut.

Aktifkan ekstraksi per format

csharp
var token = await viewer.OpenDocumentAsync(path, new PdfConfig
{
    AllowSearch = true,
    AllowCopy   = true   // opsional: memungkinkan pengguna menyeret sebuah area dan menyalin teksnya
});

AllowSearch dan AllowCopy ada pada PdfConfig, WordConfig, ExcelConfig, dan PptConfig. Properti Office mendelegasikan ke PdfConfig yang bersarang. Keduanya default ke false.

Adaptor pencarian native normal ada untuk PDF, Word, Excel, PowerPoint, TXT, Visio, email, EPUB, dan MHT. XPS menggunakan jalur PDF-nya secara default. HTML dan Microsoft Project mendapat manfaat dari pengalihan PDF berbasis teks:

csharp
// DefaultRender = false → diubah menjadi PDF berbasis teks → dapat dicari
var token = await viewer.OpenDocumentAsync(path, new HtmlConfig { DefaultRender = false });

Untuk perender native, CanSearch() menjelaskan kemampuan penampil; ini tidak menjamin bahwa dokumen tertentu berisi teks yang dapat digunakan. PDF yang halamannya hanya gambar hasil pemindaian masih dapat menghasilkan nol hasil native.

Perilaku Pencarian Normal

Server mencoba sumber pencarian dalam urutan berikut:

  1. Hasil dari penampil native format.
  2. Indeks pencarian .srh yang telah dibangun sebelumnya.
  3. Kesalahan/hasil kosong ketika tidak ada sumber pencarian.

Indeks .srh adalah artefak pencarian yang dipublikasikan bersamaan dengan gambar halaman ketika dokumen dilayani dari penyimpanan bersama, sehingga node yang belum pernah membuka dokumen masih dapat menjawab pencarian — lihat Penyebaran Terdistribusi.

CanSearch() dapat menjadi true untuk penampil yang dapat dicari bahkan ketika dokumen tertentu tidak memiliki lapisan teks dan oleh karena itu tidak menghasilkan kecocokan.

Lisensi dan Perilaku UI

Lisensi Temporary/Demo yang aktif memberikan Pencarian selama periode aktifnya. Lisensi yang hilang dan file legacy TRIAL tidak memberikan kemampuan Pencarian. Tanpa Pencarian:

  • ReferenceCss dan ReferenceScripts menghilangkan bundel pencarian.
  • Middleware menolak pencarian alih-alih mengembalikan hasil berlisensi.

Kendalikan visibilitas UI khusus dari IDoconutLicenseService.IsCapabilityGranted(LicenseCapability.Search) dan gunakan CanSearch() untuk keputusan format/sesi terpisah.

Pemecahan Masalah

GejalaPemeriksaan
Bar pencarian tidak adaKemampuan pencarian dan IncludeSearchCss/IncludeSearchScripts/IncludeSearchBar
CanSearch() adalah falsePenampil format, jalur DefaultRender yang dipilih, dan header respons inisialisasi
Pencarian mengembalikan nol untuk PDF yang dipindaiDokumen tidak memiliki lapisan teks; gunakan sumber yang berisi teks atau proyeksi PDF yang mempertahankan teks
Pencarian berfungsi tetapi sorotan bergeserJalur rendering, resolusi, transformasi dokumen, dan kotak kata yang diekstrak

Apakah halaman ini membantu?