Arama
Viewer bileşeninde yerel metin araması
The Doconut Viewer normal Arama sağlar, format görüntüleyicisi tarafından çıkarılan metin veya metin tabanlı PDF yönlendirmesi kullanarak. 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 aynı örneğe monte edilir ve 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 üretilir.
@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ü şerit, özel bir UI'ye sunulan aynı JavaScript yöntemlerini çağırır.
Tam Viewer bileşimini işaretlemede görünür tutun, önce docViewer'yi başlatın ve ardından lisanslı Ribbon'u ekleyin:
<nav id="toolbar" aria-label="Document viewer controls">
<!-- Görüntüleyici kontrolleri, Search'ı açan düğmeyi içeren -->
</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 (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 gezinmesini yönetir. Host'a ait bir Viewer araç çubuğu yalnızca bunu açıp kapatmalıdır:
searchBar.isOpen() ? searchBar.close() : searchBar.open();Kamu API'si kasıtlı olarak küçüktür:
| Yöntem | Amaç |
|---|---|
attach(objViewer) | Ribbon'ı başlatılmış viewer'a bağlar; bir kez gereklidir |
open() / close() | Ribbon'ı gösterir veya gizler; kapatmak aynı zamanda vurgulamaları temizler |
reset() | Mevcut terimi, sonuç sayısını ve vurgulamaları temizler |
isOpen() | Ribbon'ın 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 yeniden uydurmasına izin verir. 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
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ğı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'sını 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 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ı? |
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.
Biçime göre çı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ı sağlar
});AllowSearch ve AllowCopy, PdfConfig, WordConfig, ExcelConfig ve PptConfig üzerinde bulunur. Office özellikleri iç içe PdfConfig'ye yönlendirilir. İkisi 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ı PDF yönlendirmesinden faydalanır:
// DefaultRender = false → metin tabanlı bir PDF'ye dönüştürülür → arama yapılabilir
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ülerden oluşan bir PDF yine de sıfır yerel sonuç üretebilir.
Normal Arama davranışı
Sunucu arama kaynaklarını şu sırayla dener:
- Biçimin 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, 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 döndürmese bile, aranabilir bir görüntüleyici için doğru olabilir.
Lisanslama ve UI davranışı
Aktif 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:
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
| Belirti | Kontrol |
|---|---|
| Arama çubuğu eksik | Arama yeteneği ve IncludeSearchCss/IncludeSearchScripts/IncludeSearchBar |
CanSearch() yanlıştır | 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ür | Belgenin metin katmanı yok; metin içeren bir kaynak veya metni koruyan bir PDF projeksiyonu kullanın |
| Arama çalışıyor ancak vurgular kaymış | Render yolu, çözünürlük, belge dönüşümleri ve çıkarılan kelime kutuları |
Bu sayfa yardımcı oldu mu?