Pencarian

Pencarian teks asli dalam komposisi Viewer

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 Penampil, bukan toolbar mandiri. Halaman lengkap harus menyertakan sumber daya Penampil, toolbar Penampil, mount Penampil, dan objViewer yang telah 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; tag mereka hanya dihasilkan ketika lisensi memberikan Pencarian. Tampilan MVC 5 tidak memiliki @inject, jadi bangun tag di controller dan kirimkan melalui ViewBag, bersama dengan flag lisensi yang dibutuhkan halaman:

csharp
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();
    }
}

Tuliskan mereka di view dengan @Html.Raw(ViewBag.ViewerCss) dan @Html.Raw(ViewBag.ViewerScripts). Di Web Forms, ekspos nilai yang sama dari code-behind dan tuliskan dengan <%= %>.

Ribbon yang disematkan memanggil metode JavaScript yang sama tersedia untuk UI khusus.

Pertahankan komposisi Penampil 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: '/',
        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 sisi server penting: tanpa kemampuan Pencarian, ReferenceScripts menghilangkan skrip Ribbon, sehingga panggilan doconutSearchBar(...) yang tidak dilindungi akan melempar error dan menghentikan halaman Penampil dari memulai. Di Web Forms, tuliskan penjagaan yang sama sebagai <% if (IsSearchEnabled) { %> … <% } %>.

Komponen menyuntikkan grup Temukan, Opsi, dan Hasil serta menangani pencarian, pembersihan, hitungan kecocokan, dan navigasi kecocokan sebelumnya/berikutnya. Toolbar Penampil yang dimiliki host hanya perlu mengaktifkannya:

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

API publiknya sengaja kecil:

MetodeTujuan
attach(objViewer)Hubungkan Ribbon ke Penampil yang telah diinisialisasi; diperlukan satu kali
open() / close()Tampilkan atau sembunyikan Ribbon; menutup juga menghapus sorotan
reset()Bersihkan istilah saat ini, jumlah 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 Pencariannya, dan onLayout memungkinkan host mengubah ukuran/menyesuaikan Penampil ketika tinggi Ribbon berubah. Untuk urutan startup gabungan Penampil, 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. Jumlah kecocokan tiba dalam callback: Search sendiri pergi ke server dan mengembalikan tidak ada yang berguna, jadi var n = objViewer.Search(keyword, false) selalu membaca undefined — dan halaman yang dibangun dengan cara itu melaporkan "nothing found" sementara penampil menyorot kecocokan. Setelah callback:

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

DocImage.axd menjawab search=<term> dan exact=true|false dengan XML. Gunakan widget API daripada mengurai 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, ia default ke true.

Tiga gerbang independen tidak boleh bingung:

GerbangPertanyaan
CanSearch() / response headerApakah penampil yang diselesaikan 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 wilayah 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; 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 ini:

  1. Hasil dari penampil native format.
  2. Indeks pencarian .srh yang sudah dibangun.
  3. Hasil error/kosong ketika tidak ada sumber pencarian.

CanSearch() dapat menjadi true untuk penampil yang dapat dicari bahkan ketika dokumen 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 legacy TRIAL tidak memberikan kemampuan Search. Tanpa Search:

  • ReferenceCss dan ReferenceScripts menghilangkan bundel pencarian.
  • DocImage.axd menolak permintaan pencarian alih‑alih mengembalikan hasil.

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

Pemecahan Masalah

GejalaPeriksa
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?