Arama

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'ı içermelidir; ardından Search Ribbon aynı örneğe monte edilir ve eklenir.

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

@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'da mevcut olan aynı JavaScript yöntemlerini çağırır.

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

<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: '/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>

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

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

Genel API kasıtlı olarak küçüktür:

İsteğe bağlı onToggle(isOpen) geri araması, host'un Search düğmesini senkronize etmesine izin verir ve onLayout ribbon yüksekliği değiştiğinde görüntüleyiciyi yeniden boyutlandırıp yeniden oturtur. Birleşik Viewer, Search ve Annotation başlangıç sırası için, Hızlı Başlangıç bölümüne bakın.

JavaScript'ten Arama

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

İkinci argüman tam kelime/eşleşme kontrolüdür. Geri aramadan sonra:

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

Arama yeteneğini kontrol et

Başlatma yanıtı şunu rapor eder:

X-Doconut-Can-Search: 1

Başlatmadan sonra, objViewer.CanSearch() aynı format/oturum kararını ortaya koyar. Sunucu 0 gönderdiğinde false döner; yanıt gelmeden ya da başlığı atlayan eski bir sunucuyla varsayılan değer true olur.

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

Bir format teknik olarak aranabilir olabilir, ancak mevcut lisans işlemi reddedebilir.

Format başına çıkarımı etkinleştir

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

AllowSearch ve AllowCopy, PdfConfig, WordConfig, ExcelConfig ve PptConfig üzerinde bulunur. Office özellikleri, iç içe PdfConfig'lerine yönlendirilir. Her ikisi de varsayılan olarak falsedır.

PDF, Word, Excel, PowerPoint, TXT, Visio, e‑posta, EPUB ve MHT için normal yerel‑arama bağdaştırıcıları vardır. XPS varsayılan olarak PDF yolunu kullanır. HTML ve Microsoft Project, metin tabanlı PDF yönlendirmesinden faydalanır:

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

Yerel renderlayıcılar için CanSearch() görüntüleyici yeteneğini tanımlar; belirli bir belgenin kullanılabilir metin içerdiğini garanti etmez. Sayfaları yalnızca taranmış görüntüler olan bir PDF hâlâ sıfır yerel sonuç üretebilir.

Normal Arama Davranışı

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

1. Yerel ISearchableViewer sonuçları.
2. Önceden oluşturulmuş .srh arama indeksi.
3. Arama kaynağı bulunmadığında hata/boş sonuç.

CanSearch() bir arama yapılabilir görüntüleyici için doğru olabilir, ancak belirli bir belgenin metin katmanı yoksa eşleşme döndürmez.

Lisanslama ve UI davranışı

Aktif bir Temporary/Demo lisansı, aktif olduğu sürece Search'i verir. Eksik bir lisans ve eski TRIAL dosyası Search yeteneği sağlamaz. Search olmadan:

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

Özel UI görünürlüğünü IDoconutLicenseService.IsCapabilityGranted(LicenseCapability.Search) ile yönetin ve ayrı format/oturum kararı için CanSearch() kullanın.

Sorun Giderme