Arama

Viewer bileşeninde yerel metin araması

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

Arama ve açıklama, yerleşik lisanslı özelliklerdir, AddPlugin<T>() paketleri değildir. Arama kaynaklarını Viewer'dan isteyin; etiketleri yalnızca lisans Arama izni verdiğinde üretilir. MVC 5 görünümlerinde @inject yoktur, bu yüzden etiketleri denetleyicide oluşturup ViewBag üzerinden, sayfanın ihtiyaç duyduğu lisans bayrağıyla birlikte geçirin:

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

Bu değerleri görünümde @Html.Raw(ViewBag.ViewerCss) ve @Html.Raw(ViewBag.ViewerScripts) ile yazın. Web Forms'ta aynı değerleri kod-arkasından (code-behind) ortaya çıkarın ve <%= %> ile yazın.

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

Tüm Viewer bileşenini işaretlemede (markup) görünür tutun, önce docViewer'i başlatın ve ardından lisanslı Ribbon'u ekleyin:

html
<nav id="toolbar" aria-label="Document viewer controls">
    <!-- Aramayı açan düğmeyi içeren görüntüleyici kontrolleri -->
</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>

Sunucu tarafı if önemlidir: Arama yeteneği olmadan, ReferenceScripts Ribbon'in 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ı engeller. Web Forms'ta aynı korumayı <% if (IsSearchEnabled) { %> … <% } %> olarak yazın.

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 tarafından sahip olunan bir Viewer araç çubuğu yalnızca bunu açıp kapatmalıdır:

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

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

YöntemAmaç
attach(objViewer)Şeridi başlatılmış viewer'a bağlar; bir kez gereklidir
open() / close()Şeridi gösterir veya gizler; kapatmak aynı zamanda vurgulamaları temizler
reset()Mevcut terimi, sonuç sayısını ve vurgulamaları temizler
isOpen()Şeridin görünür olup olmadığını rapor eder
setStatus(message)Yapılandırılmış geri çağırma aracılığıyla bir durum mesajını iletir

İsteğe bağlı onToggle(isOpen) geri çağırma, host'un Arama düğmesini senkronize etmesini sağlar ve onLayout, Ribbon yüksekliği değiştiğinde viewer'ı yeniden boyutlandırıp uyarlamasına izin verir. Birleşik 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 yapar. Eşleşme sayısı geri çağırmada gelir: Search kendisi sunucuya gider ve işe yarar 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 "hiçbir şey bulunamadı" rapor ederken izleyici eşleşmeleri vurgular. Geri çağırmadan sonra:

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 dizinine gider.

DocImage.axd XML ile search=<term> ve exact=true|false yanıt verir. İç yanıtı kendiniz ayrıştırmak yerine widget API'sini 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ı format/oturum kararını ortaya çıkar. 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.

Karıştırılmaması gereken üç bağımsız kapı vardır:

KapıSoru
CanSearch() / yanıt başlığıÇözülmüş izleyicinin yerel bir indeks/arama yolu var mı?
AllowSearchBu format 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 format teknik olarak aranabilir olabilir, ancak mevcut lisans işlemi reddeder.

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

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

AllowSearch ve AllowCopy, PdfConfig, WordConfig, ExcelConfig ve PptConfig üzerinde bulunur. Office özellikleri iç içe PdfConfig'ye devredilir. İkisi de varsayılan olarak false'ye ayarlıdır.

PDF, Word, Excel, PowerPoint, TXT, Visio, e-posta, EPUB ve MHT için normal yerel arama adaptörleri bulunur. 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 renderlayıcılar için, CanSearch() izleyici 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. Formatın yerel izleyicisinden gelen sonuçlar.
  2. Önceden oluşturulmuş .srh arama indeksi.
  3. Arama kaynağı bulunmadığında hata/boş sonuç.

CanSearch(), belirli bir belgenin metin katmanı yoksa ve bu yüzden eşleşme döndürmüyorsa bile aranabilir bir izleyici için doğru olabilir.

Lisanslama ve UI davranışı

Aktif bir Geçici/Demo lisansı, etkin 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.
  • DocImage.axd sonuç döndürmek yerine arama isteklerini reddeder.

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

Sorun Giderme

BelirtiKontrol
Arama çubuğu eksikArama yeteneği ve IncludeSearchCss/IncludeSearchScripts/IncludeSearchBar
CanSearch() yanlışFormat izleyicisi, seçilen DefaultRender yolu ve başlatma yanıt başlığı
Arama taranmış bir PDF için sıfır dönerBelgenin metin katmanı yok; metin içeren bir kaynak ya da metni koruyan bir PDF projeksiyonu kullanın
Arama çalışıyor ama vurgular kaymışRender yolu, çözünürlük, belge dönüşümleri ve çıkarılan kelime kutuları

Bu sayfa yardımcı oldu mu?