Hızlı Başlangıç
İlk belgenizi dakikalar içinde render edin
Bu adım‑adım kılavuz, bir ASP.NET Core uygulamasını boş bir Program.cs'den tarayıcıda render edilen bir belgeye götürür: sunucu kaydı, tam Viewer paketi (Viewer araç çubuğu, Viewer bağlaması ve isteğe bağlı Arama/Not ekleme şeritleri), varlık referansları, istemci başlatma, belge açma ve yürütme.
Sunucu kurulumu
AddDoconut() hizmetleri kaydeder; UseDoconutResources() ve UseDoconut() ara katmanı bağlar. Kaynak çağrısı önce gelmelidir. UseDoconut() ona ulaşan her isteği yanıtlar, bu yüzden onu kendi dalında app.Map ile monte edin. Oturum çağrıları da gereklidir — Doconut'un varsayılan belge güvenliği, her sayfa isteğini ASP.NET oturum durumuna karşı doğrular. Oturum durumu bir önbellek gerektirir: AddDistributedMemoryCache() bir tane sağlar. Bir MVC veya Razor Pages uygulaması zaten bunu kaydeder, ancak minimal‑API uygulaması kaydetmez ve onsuz uygulama, başlangıçta Unable to resolve service for type 'IDistributedCache' ile durur. Zaten Kurulum sırasında Doconut kaydettiniz mi? Bir sonraki bölüme atlayın.
builder.Services.AddDoconut(options =>
{
options.LicensePath = "Doconut.Viewer.lic";
});
builder.Services.AddDistributedMemoryCache(); // oturum durumu bir önbellek gerektirir (MVC/Razor Pages zaten bir tane ekler)
builder.Services.AddSession(); // Doconut belge güvenliği ASP.NET oturum durumuna dayanır
app.UseSession(); // UseSession()'i UseDoconut()'dan önce çağırın
app.UseDoconutResources(); // UseDoconut()'dan önce kaydedilmelidir
app.Map("/doconut", branch => branch.UseDoconut());Üretim tarzı bir yol düzeni için, belge ara katmanını açık bir dala eşleyin ve dört yol ayarını hizalı tutun:
builder.Services.AddDoconut(options =>
{
options.LicensePath = Path.Combine(AppContext.BaseDirectory, "wwwroot", "Doconut.Viewer.lic");
options.MiddlewarePath = "/doconut";
options.ResourcesPath = "/doconut-res";
options.UnsafeMode = false;
});
builder.Services.AddDistributedMemoryCache();
builder.Services.AddSession();
app.UseRouting();
app.UseSession();
app.UseDoconutResources();
app.Map("/doconut", branch => branch.UseDoconut());MiddlewarePath bir koordinasyon değeridir; tek başına bir ASP.NET Core dalını eşlemez. Bu örnekte host, /doconut'ı eşler, böylece istemci BasePath: 'doconut''ı kullanır. ResourcesPath gömülü paketi /doconut-res'de sunar ve widget'ın resim kaynağı yolu dolayısıyla ResPath: 'doconut-res/images''dır. İkisini de başında eğik çizgi olmadan yazın: viewer kendisi bir tane ekler, bu yüzden '/doconut', //doconut/DocImage.axd olur, tarayıcı bunu doconut adlı bir hosta istek olarak okur ve viewer "The viewer handler could not be reached" hatasıyla başarısız olur.
Görüntüleyiciyi bir sayfaya ekleyin
Viewer, sayfanın gerekli çekirdeğidir. Render yüzeyi iki iç içe div kullanır:
<div id="divDocViewer">
<div id="div_ctlDoc"></div>
</div>Araç çubuğunu, modül bağlamalarını ve Viewer yüzeyini tek bir sayfa kompozisyonu gibi ele alın. Arama ve Not ekleme, gömülü şeritlerini isteğe bağlı bağlamalara enjekte eder, ancak bu modüller asla bağımsız değildir: her zaman aynı sayfadaki Viewer'a bağlanırlar. Bu sırayı kullanın:
<nav id="toolbar" aria-label="Document viewer controls">
<!-- Viewer gezinme, yakınlaştırma, Arama ve Açıklama düğmeleri -->
</nav>
<div id="searchBarMount"></div>
<div id="annBarMount"></div>
<div id="divDocViewer">
<div id="div_ctlDoc"></div>
</div>Viewer varlıklarına referans
Bir Razor görünümünde, enjekte edilen Viewer servisi viewer'ın <link> ve <script> etiketlerini bağımlılık sırasıyla üretir — widget bir jQuery eklentisidir, bu yüzden jQuery viewer betiklerinden önce yüklenmelidir:
@inject Doconut.Viewer Viewer
@Html.Raw(Viewer.ReferenceCss(new CssConfig
{
IncludeBootstrapCss = true,
IncludeViewerCss = true
}))
@Html.Raw(Viewer.ReferenceScripts(new ScriptConfig
{
IncludeJQuery = true,
IncludeBootstrap = true,
IncludeViewerScripts = true
}))Tam Viewer paketi için, Viewer ve modül kaynaklarını birlikte isteyin:
@Html.Raw(Viewer.ReferenceCss(new CssConfig
{
IncludeBootstrapCss = true,
IncludeViewerCss = true,
IncludeSearchCss = true,
IncludeAnnotationCss = true
}))
@Html.Raw(Viewer.ReferenceScripts(new ScriptConfig
{
IncludeJQuery = true,
IncludeBootstrap = true,
IncludeViewerScripts = true,
IncludeSearchScripts = true,
IncludeSearchBar = true,
IncludeAnnotationScripts = true,
IncludeAnnotationBar = true
}))IncludeViewerCss ve IncludeViewerScripts zorunlu çekirdek bayraklarıdır. Bunlar, Viewer bağlaması ve bir docViewer
örneği olmadan bir Search veya Annotation Ribbon örneği asla yayınlamayın. ReferenceCss ve ReferenceScripts,
geçerli lisans bu yeteneği vermiyorsa isteğe bağlı bir modülün kaynaklarını atlar; çekirdek Viewer yine de başlar.
Görüntüleyiciyi Başlat
İstemci tarafı widget'ı bir jQuery eklentisidir. Bu, gerçek başlatma seçeneklerinin minimal bir setidir (sözde kod değil):
let searchBar = null;
let annBar = null;
const objViewer = $('#div_ctlDoc').docViewer({
showThumbs: true,
autoLoad: false,
pageZoom: 100,
FitType: 'width',
BasePath: 'doconut', // başında '/' yok
ResPath: 'doconut-res/images', // başında '/' yok
onViewerReady: function () {
// sayfalar görünür; burada bir yükleme göstergesini gizlemek güvenlidir
},
// Gömülü şerit mevcut olduğunda, ek açıklama yaşam döngüsü olaylarını ona yönlendir.
onAnnLoaded: () => annBar?.handleAnnLoaded(),
onAnnSaved: () => annBar?.handleAnnSaved(),
onAnnSaveError: () => annBar?.handleAnnSaveError(),
onAnnClosed: () => annBar?.handleAnnClosed(),
onError: function (message) {
console.error('Doconut viewer error:', message);
}
});Seçenek adlandırması gerçekten karışıktır — showThumbs, autoLoad ve pageZoom camelCase iken, FitType, BasePath ve ResPath PascalCase'dir. Tutarlı bir kural yoktur; büyük/küçük harfleri yanlış yaparsanız seçenek sessizce yok sayılır (widget varsayılanına geri döner ve hata atmaz).
Dört ek detay hata mesajı vermeden başarısız olur:
BasePathbaşında eğik çizgi yok.'doconut',/doconut/DocImage.axdisteğinde bulunur;'/doconut',//doconut/DocImage.axdüretir, bu da tarayıcının başka bir ana bilgisayara istek olarak okumasına neden olur.ResPath: 'doconut-res/images'— simgeler kaynak kökünün bir klasör altında bulunur.'doconut-res'ile, her simge 404 döner: araç çubuğu glifleri ve yükleme çarkı yok, ancak belge hâlâ renderlanır. Başlangıçtaki eğik çizgi,BasePathgibi aynı şekilde bozar.- Geri aramalar (callbacks) seçeneklerdir.
onViewerReady,onErrorve diğerleri,docViewer(...)'a geçirilen nesneye konur. Görüntüleyicinin adını taşıyan global bir fonksiyon, örneğinctlDoc_ViewerReady, asla çağrılmaz. - Görüntüleyiciyi tutun, ardından
View'ı ayrı ayrı çağırın.docViewer(...),Zoom,NextveFitTypeiçeren nesneyi döndürür;View(...)başka bir şey döndürür.var objViewer = $('#div_ctlDoc').docViewer({...}).View(token)belgeyi renderlar, ardından ilk araç çubuğu tıklamasındaobjViewer.Zoom is not a functionile başarısız olur.
Tam Viewer Paketi Oluşturun
Tam bir görüntüleyici sayfası aşağıdaki parçaları birlikte kurar:
| Paketin Parçası | Gereksinim | Nasıl Bağlanır |
|---|---|---|
Viewer kaynakları, bağlama ve objViewer | Gerekli | Çekirdek belge renderleyicisi |
| Viewer araç çubuğu | Tam bir sayfa için gerekli | Host işaretlemesi; düğmeler aynı objViewer'ı çağırır |
| Arama şeridi | Opsiyonel, lisanslı modül | doconutSearchBar(...).attach(objViewer) |
| Açıklama şeridi | Opsiyonel, lisanslı modül | doconutAnnotationBar(...).attach(objViewer) |
Ana Viewer araç çubuğu host işaretlemesi olsa da, Viewer ile birlikte kurulur ve asla izole bir kontrol olarak belgelenmemelidir. Bu, düzenini, etiketlerini, simgelerini ve yetkilendirme kurallarını uygulamanızın kontrolü altında tutar ve her düğme aynı Viewer örneğini çalıştırır:
<nav id="toolbar" aria-label="Document viewer controls">
<button type="button" onclick="objViewer.GotoPage(1)">First</button>
<button type="button" onclick="objViewer.Next(false)">Previous</button>
<button type="button" onclick="objViewer.Next(true)">Next</button>
<button type="button" onclick="objViewer.GotoPage(objViewer.TotalPages())">Last</button>
<button type="button" onclick="objViewer.Zoom(false)">Zoom out</button>
<button type="button" onclick="objViewer.Zoom(true)">Zoom in</button>
<button type="button" onclick="objViewer.FitType('width')">Fit width</button>
<button type="button" onclick="objViewer.FitType('height')">Fit height</button>
<button type="button" id="openSearch">Search</button>
<button type="button" id="openAnnotations">Annotations</button>
</nav>Döndürme, küçük resim, yazdırma, tam ekran, düzen ve düğme durumu yardımcıları kendi araç çubuğu betiğinizde bulunmalıdır; bu betik aynı objViewer'ı çağırır. Viewer.ReferenceScripts(...)'dan sonra yükleyin ve <nav id="toolbar"> işaretlemesiyle birlikte tutun.
Bu başlatma sırasını tutun:
- Viewer ve lisanslı modüller için CSS yayını yapın.
- Viewer araç çubuğunu, Arama/Açıklama bağlamalarını ve Viewer bağlamasını birlikte renderlayın.
- Viewer ve lisanslı modüller için betikleri yayını yapın.
- Host uygulamasının kendi araç çubuğu yardımcı betiğini yükleyin.
docViewer'ı başlatın ve ortaya çıkanobjViewer'ı tutun.- Her lisanslı Arama veya Açıklama Şeridini başlatın.
- Her Şeritte
attach(objViewer)'ı çağırın. - Belgeyi açın ve Viewer ile modül istekleri için tokenını saklayın.
Dağıtılmış bir dağıtımda, ek access istek değeri ve eşzamansız-render yeniden deneme ayarları taşıma katmanına aittir; Viewer, araç çubuğu veya Şeritlerin nasıl birleştirildiğini değiştirmez.
Sunucu tarafı korumaları önemlidir: opsiyonel bir yetenek mevcut olmadığında, onun betiği yayını yapılmaz, bu yüzden jQuery eklenti fonksiyonu bulunmaz.
<script>
let token = '';
const refitViewer = () =>
requestAnimationFrame(() => objViewer.Refit());
@if (Viewer.IsSearchEnabled)
{
<text>
searchBar = $('#searchBarMount').doconutSearchBar({
docId: 'ctlDoc',
getRequestParams: () => ({ token }),
onLayout: refitViewer
});
searchBar.attach(objViewer);
</text>
}
@if (Viewer.IsAnnotationEnabled)
{
<text>
annBar = $('#annBarMount').doconutAnnotationBar({
docId: 'ctlDoc',
getRequestParams: () => ({ token }),
onLayout: refitViewer
});
annBar.attach(objViewer);
</text>
}
document.getElementById('openSearch').addEventListener('click', () => {
if (!searchBar) return;
searchBar.isOpen() ? searchBar.close() : searchBar.open();
});
document.getElementById('openAnnotations').addEventListener('click', () => {
if (!annBar) return;
annBar.isOpen() ? annBar.close() : annBar.open();
});
</script>Gömülü her iki bileşen de kendi Şerit DOM'unu üretir. Arama, Bul, Seçenekler ve Sonuçlar gruplarını içerir. Açıklama, yazar araçlarını, stil kontrollerini, kaydetme eylemlerini ve opsiyonel dışa aktarım/görüntü eylemlerini içerir. Çubuklar open(), close(), reset() ve isOpen()'i ortaya çıkar; oluşturduktan sonra her zaman bir kez attach(objViewer)'ı çağırın.
Yukarıdaki örnek, başlangıcı minimal tutmak için opsiyonel host geri aramalarını ve Açıklama dışa aktarım/görüntü uç noktalarını atlar. Tam özellik‑spesifik kurulum için Arama ve Açıklamalar bölümlerine bakın, ya da host‑sahibi Viewer araç çubuğunu stilize etmek veya değiştirmek için Özel Temalar bölümüne göz atın.
Bir belge açın
Sunucu tarafı tek bir uç noktadır: enjekte edilen Viewer hizmeti belgeyi açar ve bir oturum belirteci döndürür.
app.MapPost("/api/open", async (Viewer viewer) =>
{
// Token opaktır — widget'a verin, asla log ya da persist etmeyin.
string token = await viewer.OpenDocumentAsync("wwwroot/files/Sample.pdf");
return Results.Ok(new { token });
});İstemci bu belirteci alır ve objViewer.View(token) ile widget'a verir:
fetch('/api/open', { method: 'POST' })
.then(resp => resp.json())
.then(data => {
token = data.token;
objViewer.View(token);
});Belgeyi kapat
Kullanıcı görüntüleyiciden ayrıldığında veya yerine yeni bir belge açtığında objViewer.Close(true)'ı çağırın: widget'ı temizler ve sunucuya bir kapatma isteği gönderir. Argümansız objViewer.Close() yalnızca widget'ı temizler. Sunucu‑tabanlı iş akışlarında, viewer.CloseDocument(token) önbellekteki oturumu hemen kaldırır, render motorunu serbest bırakır, güvenlik işaretçisini siler ve belirteci iptal eder. Kaydırmalı süresi dolma sonunda aynı temizlik işlemini yapar, ancak büyük belgeler için açıkça kapatma önerilir.
Tamamlanmış istek akışı:
AddDoconut + middleware
-> render CSS/scripts and mount div
-> initialize docViewer
-> OpenDocumentAsync
-> return opaque token
-> objViewer.View(token)
-> page/search/annotation requests
-> Close / CloseDocumentBelirteci bir taşıyıcı kimlik bilgisi gibi ele alın: asla kaydetmeyin, asla kalıcı hale getirmeyin, sadece widget'a verin. Sunucudaki aktif bir belge oturumunu tanımlar ve oturum süresi dolduğunda çalışmayı durdurur — yeni bir belirteç almak için belgeyi yeniden açın.
Çalıştır
wwwroot/files/Sample.pdf konumuna bir PDF koyun, dotnet run çalıştırın ve widget'ı barındıran sayfayı açın. İlk sayfa görüntüleyicide, solda bir küçük resim paneli ile renderlanır. Eğer renderlanmazsa, Sorun Giderme.
Lisans olmadan neler elde edersiniz
Eksik bir lisans hata vermez. Görüntüleyici normal şekilde renderlanır, ancak her sayfa bir değerlendirme filigranı taşır. Doconut'un bir lisans nasıl bulduğunu ve bulduktan sonra ne değiştiğini görmek için Lisans Kurulumu bölümüne bakın.
Bu sayfa yardımcı oldu mu?