Arama
Viewer bileşeninde yerel metin araması
Doconut Viewer, format görüntüleyicisi tarafından çıkarılan metin veya metin tabanlı bir 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 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'den isteyin; etiketleri yalnızca lisans Arama'yı sağladığında yayınlanı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'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'ı ekleyin:
<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 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 gezinimini yönetir. Host'a ait bir Viewer araç çubuğu sadece onu açıp kapatmaya ihtiyaç duyar:
searchBar.isOpen() ? searchBar.close() : searchBar.open();Kamu API'si kasıtlı olarak küçüktür:
| Yöntem | Amaç |
|---|---|
attach(objViewer) | Ribbon'ı başlatılmış viewere bağlayın; bir kez gereklidir |
open() / close() | Ribbon'ı göster veya gizle; kapatmak aynı zamanda vurgulamaları temizler |
reset() | Mevcut terimi, sonuç sayısını ve vurgulamaları temizle |
isOpen() | Ribbon'ın görünür olup olmadığını raporla |
setStatus(message) | Yapılandırılmış geri çağırma aracılığıyla bir durum mesajını ilet |
İsteğe bağlı onToggle(isOpen) geri çağırma, host'un Search düğmesini senkronize etmesini sağlar ve onLayout, Ribbon yüksekliği değiştiğinde viewer'ı yeniden boyutlandırıp/uyarlamasını sağlar. Birleştirilmiş Viewer, Search ve Annotation başlangıç sırası için, bakınız Hızlı Başlangıç.
JavaScript'ten Arama
objViewer.Search(keyword, false, function (resultCount) {
console.log('Matches:', resultCount);
});İkinci argüman tam kelime/doğru eşleşmedir. Eşleşme sayısı geri çağırmada 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 vurgulanırken "hiçbir şey bulunamadı" rapor eder. Geri çağırmadan sonra:
| Yöntem | Sonuç |
|---|---|
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 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 edin
Başlatma yanıtı rapor eder:
X-Doconut-Can-Search: 1Başlatmadan sonra, objViewer.CanSearch() aynı format/oturum kararını ortaya koyar. Sunucu 0 gönderdiğinde false döndürür; yanıt öncesinde ya da 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ı? |
AllowSearch | Bu format yapılandırması, anahtarın bulunduğu yerde metin çıkarımı talep etti mi? |
LicenseCapability.Search | Uygulama 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
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'ye devredilir. Her ikisi de varsayılan olarak false'dı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:
// 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() 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üler olan bir PDF hâlâ sıfır yerel sonuç üretebilir.
Normal Arama davranışı
Sunucu arama kaynaklarını şu sırayla dener:
- Formatın yerel görüntüleyicisinden gelen sonuçlar.
- Önceden oluşturulmuş
.srharama indeksi. - 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, bu yüzden belgeyi hiç açmamış bir düğüm bile aramalara yanıt verebilir — bkz. Dağıtılmış Dağıtımlar.
CanSearch(), belirli bir belgenin metin katmanı yoksa ve bu yüzden eşleşme döndürmüyorsa bile aranabilir bir görüntüleyici için doğru olabilir.
Lisanslama ve UI davranışı
Etkin bir Geçici/Demo lisansı, aktif süresi boyunca Arama izni verir. Eksik bir lisans ve eski TRIAL dosyası hiçbir Arama yeteneği sağlamaz. Arama olmadan:
ReferenceCssveReferenceScriptsarama 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ı format/oturum kararları için CanSearch() kullanın.
Sorun Giderme
| Semptom | Kontrol |
|---|---|
| Arama çubuğu eksik | Arama yeteneği ve IncludeSearchCss/IncludeSearchScripts/IncludeSearchBar |
CanSearch() yanlıştır | Format görüntüleyicisi, seçilen DefaultRender yolu ve başlatma yanıt başlığı |
| Tarama yapılan PDF için arama sıfır döndürür | Belgenin metin katmanı yoktur; 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?