Arama

Viewer bileşeninde yerel metin araması

Doconut Viewer, format görüntüleyicisi tarafından çıkarılan metin veya metin tabanlı PDF yönlendirmesi kullanarak normal Arama sağlar. Search lisans yeteneğini gerektirir.

Arama UI'sını Etkinleştir

Arama, bağımsız bir araç çubuğu değil, bir Viewer modülüdür. Tam sayfa Viewer kaynaklarını, Viewer araç çubuğunu, Viewer montajını ve başlatılmış objViewer'yi içermelidir; ardından Arama Ribbon'u monte edilir ve aynı örneğe eklenir.

Arama ve açıklama, yerleşik lisanslı özelliklerdir, AddPlugin<T>() paketleri değildir. Arama kaynaklarını enjekte edilen Viewer'den isteyin; etiketleri yalnızca lisans Arama izni verdiğinde yayınlanır.

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
}))

Gömülü ribbon, özel bir UI'ye sunulan aynı JavaScript yöntemlerini çağırır.

Tam Viewer bileşenini işaretlemede görünür tutun, önce docViewer'yi başlatın ve ardından lisanslı Ribbon'u ekleyin:

html
<nav id="toolbar" aria-label="Document viewer controls">
    <!-- Görüntüleyici kontrolleri, aramayı açan düğme dahil -->
</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>

Sunucu tarafı if önemlidir: Arama yeteneği olmadan, ReferenceScripts Ribbon'un betiğini dışarı bırakır, bu yüzden korunmasız bir doconutSearchBar(...) çağrısı hata verir ve viewer sayfasının başlamasını durdurur.

Bileşen Find, Options ve Results gruplarını enjekte eder ve aramayı, temizlemeyi, eşleşme sayılarını ve önceki/sonraki eşleşme gezinmesini yönetir. Host'a ait bir Viewer araç çubuğu yalnızca bunu açıp kapatmalıdır:

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

Kamu API'si kasıtlı olarak küçüktür:

YöntemAmaç
attach(objViewer)Ribbon'u başlatılmış viewere bağlayın; bir kez gereklidir
open() / close()Ribbon'u göster veya gizle; kapatmak aynı zamanda vurgulamaları temizler
reset()Mevcut terimi, sonuç sayısını ve vurgulamaları temizle
isOpen()Ribbon'un görünür olup olmadığını raporla
setStatus(message)Yapılandırılmış geri çağrı aracılığıyla bir durum mesajı ilet

İsteğe bağlı onToggle(isOpen) geri çağrısı, host'un Arama düğmesini senkronize etmesini sağlar ve onLayout, Ribbon yüksekliği değiştiğinde viewer'ı yeniden boyutlandırıp/uygun hale getirmesini sağlar. Birleştirilmiş Viewer, Arama ve Açıklama başlangıç sırası için, Hızlı Başlangıç bölümüne bakın.

JavaScript'ten Arama

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

İkinci argüman tam kelime/eşleşme kontrolüdür. Eşleşme sayısı geri çağrıda gelir: Search kendisi sunucuya gider ve faydalı bir şey döndürmez, bu yüzden var n = objViewer.Search(keyword, false) her zaman undefined okur — ve bu şekilde oluşturulan bir sayfa, eşleşmeler viewer tarafından vurgulanırken "hiçbir şey bulunamadı" rapor eder. Geri çağrının ardından:

YöntemSonuç
SearchMatchCount()Belgedeki toplam bireysel eşleşmeler.
SearchSummary(false)[pageNumber, matchCount] girişleri yeniden boyamadan.
SearchSummary(true)Aynı özet ve sayfa/küçük resim vurgularını çizer.
GotoSearchMatch(index)Sıfır tabanlı bir eşleşme indeksine gider.

Ara katman rotası search=<term> ve exact=true|false kullanır ve XML döndürür. Bu iç yanıtı kendiniz ayrıştırmak yerine widget API'sını kullanın.

Arama yeteneğini kontrol et

Başlatma yanıtı rapor eder:

text
X-Doconut-Can-Search: 1

Başlatmadan sonra, objViewer.CanSearch() aynı biçim/oturum kararını ortaya koyar. Sunucu 0 gönderdiğinde false döndürür; yanıt öncesinde veya başlığı atlayan eski bir sunucu ile, varsayılan olarak true olur.

Üç bağımsız kapı karıştırılmamalıdır:

KapıSoru
CanSearch() / response headerÇözülmüş görüntüleyicinin yerel bir indeks/arama yolu var mı?
AllowSearchBu biçim yapılandırması, anahtarın bulunduğu yerde metin çıkarımı talep etti mi?
LicenseCapability.SearchUygulama aramayı yürütmek ve UI paketlerini almak için yetkilendirilmiş mi?

Bir biçim teknik olarak aranabilir olabilir, ancak mevcut lisans işlemi reddedebilir.

Biçime göre çıkarımı etkinleştir

csharp
var token = await viewer.OpenDocumentAsync(path, new PdfConfig
{
    AllowSearch = true,
    AllowCopy   = true   // isteğe bağlı: kullanıcıya bir bölge sürükleyip metnini kopyalama imkanı verir
});

AllowSearch ve AllowCopy, PdfConfig, WordConfig, ExcelConfig ve PptConfig üzerinde bulunur. Office özellikleri, iç içe PdfConfig'lerine yönlendirilir. İkisi de varsayılan olarak false'a ayarlanmıştır.

PDF, Word, Excel, PowerPoint, TXT, Visio, e-posta, EPUB ve MHT için normal yerel arama adaptörleri mevcuttur. XPS varsayılan olarak PDF yolunu kullanır. HTML ve Microsoft Project, metin tabanlı bir PDF yönlendirmesinden faydalanır:

csharp
// DefaultRender = false → metin tabanlı bir PDF'ye dönüştürülür → aranabilir
var token = await viewer.OpenDocumentAsync(path, new HtmlConfig { DefaultRender = false });

Yerel renderleyiciler için, CanSearch() görüntüleyici yeteneğini açıklar; belirli bir belgenin kullanılabilir metin içerdiğini garanti etmez. Sayfaları yalnızca taranmış görüntülerden oluşan bir PDF, yine de sıfır yerel sonuç üretebilir.

Normal Arama davranışı

Sunucu arama kaynaklarını şu sırayla dener:

  1. Biçimin yerel görüntüleyicisinden gelen sonuçlar.
  2. Önceden oluşturulmuş .srh arama indeksi.
  3. Arama kaynağı bulunmadığında hata/boş sonuç.

.srh indeksi, belgeler paylaşılan depolamadan sunulduğunda sayfa görüntüleriyle birlikte yayınlanan arama eseridir, böylece belgeyi hiç açmamış bir düğüm bile aramalara yanıt verebilir — bkz. Dağıtılmış Dağıtımlar.

CanSearch(), belirli bir taranmış belgenin metin katmanı olmasa ve bu nedenle eşleşme getirmese bile, aranabilir bir görüntüleyici için doğru olabilir.

Lisanslama ve UI davranışı

Etkin bir Geçici/Demo lisansı, aktif dönemi boyunca Arama izni verir. Eksik bir lisans ve eski TRIAL dosyası hiçbir Arama yeteneği sağlamaz. Arama olmadan:

  • ReferenceCss ve ReferenceScripts arama paketlerini atlar.
  • Ara katman, lisanslı sonuçları döndürmek yerine aramayı reddeder.

IDoconutLicenseService.IsCapabilityGranted(LicenseCapability.Search) üzerinden özel UI görünürlüğünü yönetin ve ayrı biçim/oturum kararları için CanSearch() kullanın.

Sorun Giderme

SemptomKontrol
Arama çubuğu eksikArama yeteneği ve IncludeSearchCss/IncludeSearchScripts/IncludeSearchBar
CanSearch() yanlışBiçim görüntüleyicisi, seçilen DefaultRender yolu ve başlatma yanıt başlığı
Arama, taranmış bir PDF için sıfır döndürürBelgenin metin katmanı yok; metin içeren bir kaynak veya metni koruyan bir PDF projeksiyonu kullanın
Arama çalışıyor ancak vurgular kaymışRenderleme yolu, çözünürlük, belge dönüşümleri ve çıkarılan kelime kutuları

Bu sayfa yardımcı oldu mu?