Pencarian

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

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

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

@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:

<nav id="toolbar" aria-label="Document viewer controls">
    <!-- Viewer controls, including the button that opens 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 (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>

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

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

API publiknya sengaja kecil:

Callback opsional onToggle(isOpen) memungkinkan host menyinkronkan tombol Search-nya, dan onLayout memungkinkan menyesuaikan ukuran/menyesuaikan kembali viewer ketika tinggi Ribbon berubah. Untuk urutan startup gabungan Viewer, Search, dan Annotation, lihat Panduan Cepat.

Pencarian dari JavaScript

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

Argumen kedua adalah pencocokan kata lengkap/tepat. Setelah callback:

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

Periksa kemampuan pencarian

Respons inisialisasi melaporkan:

X-Doconut-Can-Search: 1

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

Tiga gerbang independen tidak boleh bingung:

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

Aktifkan ekstraksi per format

var token = await viewer.OpenDocumentAsync(path, new PdfConfig
{
    AllowSearch = true,
    AllowCopy   = true   // optional: lets the user drag a region and copy its text
});

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:

// DefaultRender = false → converted to a text-based PDF → searchable
var token = await viewer.OpenDocumentAsync(path, new HtmlConfig { DefaultRender = false });

Untuk renderer native, CanSearch() menggambarkan kemampuan viewer; itu 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 ISearchableViewer native.
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 disajikan dari penyimpanan bersama, sehingga node yang tidak pernah membuka dokumen masih dapat menjawab pencarian — lihat Penyebaran Terdistribusi.

CanSearch() dapat bernilai true untuk viewer yang dapat dicari bahkan ketika dokumen hasil pemindaian tertentu tidak memiliki lapisan teks dan oleh karena itu tidak mengembalikan kecocokan.

Lisensi dan perilaku UI

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

• ReferenceCss dan ReferenceScripts tidak menyertakan bundel search.
• Middleware menolak pencarian alih-alih mengembalikan hasil berlisensi.

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

Pemecahan Masalah