Görüntüleyici
Ana belge görüntüleyici sınıfı
Viewer (namespace Doconut) belgeleri Razor sayfalarından, MVC denetleyicilerinden, Blazor bileşenlerinden veya minimal API'lerden açmak için genel giriş noktasıdır. sealed, AddDoconut() tarafından transient hizmet olarak kaydedilir ve yapılandırıcı enjeksiyonu yoluyla çözülür — asla doğrudan oluşturmayın.
Viewer hiçbir istek başına durum tutmaz ve kasıtlı olarak not IDisposable: belge oturumları oturum önbelleğinde bağımsız olarak yaşar, bu yüzden hizmeti yok etmek asla açık bir belgeyi kapatamaz (bkz. Core Concepts → How the Viewer Works).
OpenDocumentAsync
Bir belge açar ve istemci widget'ının sonraki tüm isteklerde kullandığı oturum jetonunu döndürür.
| Aşırı Yükleme | Kullanım Durumu |
|---|---|
Task<string> OpenDocumentAsync(string filePath, DocOptions? options = null, CancellationToken ct = default) | Diskten otomatik format algılaması ve formatın varsayılan yapılandırmasıyla açma |
Task<string> OpenDocumentAsync(string filePath, BaseConfig? config, DocOptions? options = null, CancellationToken ct = default) | Her format için render seçeneklerine ihtiyacınız var (PdfConfig, WordConfig, …) |
Task<string> OpenDocumentAsync(Stream stream, FileInfo fileInfo, BaseConfig? config = null, DocOptions? options = null, CancellationToken ct = default) | Belge disk üzerinde bir dosya değildir (yükleme, veritabanı, blob). fileInfo doğru uzantıyı taşımalıdır — bu, format algılamasını yönlendirir |
// Basit aç
string token = await viewer.OpenDocumentAsync(path);
// Biçim başına yapılandırma ve seçeneklerle
token = await viewer.OpenDocumentAsync(
path,
new PdfConfig { AllowSearch = true, AllowCopy = true },
new DocOptions { TimeOut = 30 });
// Yüklemeden
await using var ms = new MemoryStream();
await file.CopyToAsync(ms);
ms.Position = 0;
token = await viewer.OpenDocumentAsync(ms, new FileInfo(file.FileName));Ele alınması gereken istisnalar:
LicenseException— bulunan bir lisans reddedilir (mesaj reddetme nedenini taşır), veya format artık verilmemiş bir eklenti yeteneğine ihtiyaç duyar. Reddetme mesajı olmadan takvim süresi dolduğunda, hata fırlatmak yerine su işareti ekli rendera düşer.FormatNotSupportedException—Document format '<extension>' is not supported.InvalidDataException— dosya içeriği bozuk veya uzantısıyla eşleşmiyor.
CloseDocument
void CloseDocument(string token)Oturumu önbellekten kaldırır (belge motorunu hemen yok eder), güvenlik işaretçisini siler ve erişim iznini iptal eder. İsteğe bağlı — kayan süresi aynı temizlik işlemini yapar — ancak büyük belgeler için önerilir.
GetPageCount
int GetPageCount(string token)Açık oturumun toplam sayfa sayısı. Jeton bilinmiyorsa veya süresi dolmuşsa InvalidOperationException (Document session not found. Please re-open document.) fırlatır ve boş bir jeton için ArgumentException fırlatır.
GetPageDimensions
(int Width, int Height) GetPageDimensions(string token, int page = 1)Belgenin %100 yakınlaştırmadaki varsayılan render edilmiş sayfa boyutu — kod içinde oluşturulan açıklamalar için koordinat alanı. Uyumluluk için page kabul edilir; sonuç belge varsayılanıdır. Jeton bilinmiyorsa veya süresi dolmuşsa InvalidOperationException (Document session not found. Please re-open document.) fırlatır ve boş bir jeton için ArgumentException fırlatır.
GetWorksheetNames
IReadOnlyList<string> GetWorksheetNames(string token)Açık bir elektronik tablonun çalışma sayfası adlarını, çalışma kitabı sırasına göre döndürür; açık belge bir elektronik tablo değilse boş bir liste döner.
Yalnızca render edilen çalışma sayfaları listelenir: gizli ve boş çalışma sayfaları dışlanır ve ExcelConfig.SheetNames renderı kısıtladığında yalnızca o çalışma sayfaları görünür. Bir çalışma sayfası her zaman tek bir sayfa değildir — çok büyük bir sayfa birkaç sayfaya yayılır. Jeton bilinmiyorsa veya süresi dolmuşsa InvalidOperationException (Document session not found. Please re-open document.) fırlatır ve boş bir jeton için ArgumentException fırlatır.
26.9.0'da eklendi.
Kapasite bayrakları
| Üye | Anlam |
|---|---|
bool IsSearchEnabled | Mevcut lisans Search verir |
bool IsAnnotationEnabled | Mevcut lisans Annotation verir |
Bunları bir Razor görünümünde, yalnızca sunucu gerçekten hizmet verecekse lisanslı bir Şerit render etmek için kullanın — bakınız Hızlı Başlangıç.
Belge Seçenekleri
Açma başına, format bağımsız seçenekler (namespace Doconut):
| Tür | Özellik | Varsayılan | Açıklama |
|---|---|---|---|
string | Password | "" | Korunan belgeler için şifre (format yapılandırmasına otomatik olarak kopyalanır). |
int | ImageResolution | 0 | Eski. Yalnızca uyumluluk için tutulur — bunun yerine format yapılandırmasında ImageResolution ayarlayın. |
string | Watermark | "" | Render edilen sayfalara çizilen özel filigran metni. Biçim dizesi: "^Text~Color~FontSize~FontName~Opacity~Angle", örn. "^Sample Copy~Red~24~Verdana~80~-45". |
int | TimeOut | 60 | Dakika cinsinden oturum kaydırmalı süresi. |
bool | IsSecured | true | Şu anda uygulanmıyor — ayrılmış. Token bağlama, DoconutOptions.UnsafeMode tarafından küresel olarak kontrol edilir (bkz. Temel Kavramlar → Oturumlar ve Güvenlik). |
Sınıf ayrıca normal tek‑host görüntüleme akışının dışına kasıtlı olarak yerleştirilmiş özel özellikler sunar:
| Tür | Özellik | Varsayılan | Açıklama |
|---|---|---|---|
bool | IsWebFarm | false | Eski — etkisi yok. Belgeyi DistributedDocumentPublisher.PublishAsync (veya IDistributedPublishQueue.EnqueueAsync) ile yayınlayın ve bunun yerine FileShareConfig.RootPath ayarlayın. |
string | WebFarmPath | "" | Eski — etkisi yok. Bunun yerine FileShareConfig.RootPath kullanın. |
bool | EditMode | false | Ayrı dağıtılan Editor iş akışı için ayrılmış; standart görüntüleyici için false bırakın. |
Özel filigran
DocOptions.Watermark altı tilde ile ayrılmış alan kullanır. İsteğe bağlı bir ön ^ tüm köşe düzenini talep eder:
^Text~Color~FontSize~FontName~Opacity~Anglestring token = await viewer.OpenDocumentAsync(
path,
new PdfConfig(),
new DocOptions
{
Watermark = "^Confidential~Red~24~Verdana~80~-45",
TimeOut = 30
});| Alan | Örnek | Anlam |
|---|---|---|
Ön ^ | ^ | İsteğe bağlı tüm köşe düzeni. Olmazsa, normal filigran konumu kullanılır. |
| Metin | Confidential | Her sayfada render edilen metin. Boş olmamalıdır. |
| Renk | Red | Çizim katmanı tarafından anlaşılan adlandırılmış renk. |
| YazıBoyutu | 24 | Yazı tipi boyutu; geçersiz sayısal giriş render varsayılanına geri döner. |
| YazıAdı | Verdana | İstenen yazı tipi ailesi. Dağıtım ortamında kurulu olduğundan emin olun. |
| Opaklık | 80 | 0 ile 255 arasında bir byte değeri. Başarıyla ayrıştırılmalıdır. |
| Açı | -45 | Derece cinsinden dönüş açısı; geçersiz sayısal giriş varsayıla geri döner. |
Ayrıştırıcı, isteğe bağlı ^ sonrası tam altı alan bekler. Geçersiz bir tanım, sessizce kaybolmak yerine SDK'nın görünür Invalid Watermark geri dönüşüyle değiştirilir.
Lisans kararı
| Lisans durumu | Sağlanan özel değer | Render edilen sonuç |
|---|---|---|
| Geçerli ücretli görüntüleyici lisansı | Hayır | Temiz sayfa |
| Geçerli ücretli görüntüleyici lisansı | Evet | Özel filigran |
| Aktif Geçici/Demo temel görüntüleyici | Hayır | Temiz temel-görüntüleyici sayfası |
| Aktif Geçici/Demo temel görüntüleyici | Evet | Temiz temel-görüntüleyici yolu uygulandığında özel filigran |
| Eksik, reddedilmiş, süresi dolmuş, yanlış sürüm veya geçersiz alan lisansı | Herhangi biri | Uygulama/değerlendirme filigranı; özel değer bunu geçersiz kılmaz |
| Değerlendirme kuralları altında eklenti render'ı | Herhangi biri | Değerlendirme filigranı |
Aynı karar, sunulan sayfa görüntülerine ve açıklama dışa aktarımlarına uygulanır. Hareketli GIF çıktısı kare kare damgalanır. Bu nedenle özel bir filigran, lisanslı bir uygulama özelliğidir, değerlendirme filigranını değiştirmek veya bastırmak için bir yol değildir.
Açıklama API'si
Sunucu taraflı açıklama yükleme ve dışa aktarma. Tam kılavuz Guides → Annotations içinde bulunur; arayüz şu şekildedir:
| Üye | Amaç |
|---|---|
AnnotationManager GetAnnotationManager(string token) | Açık oturumun sayfa boyutlarına bağlı yönetici |
AnnotationManager GetAnnotationManager(string token, int pageWidth, int pageHeight) | Açıkça belirtilen sayfa boyutlarına sahip yönetici |
AnnotationManager GetAnnotationManager(int pageWidth, int pageHeight) | Oturumdan bağımsız yönetici |
void LoadAnnotationData(string token, AnnotationManager manager) | C#'ta oluşturulan açıklamaları oturuma yükle |
void LoadAnnotationData(string token, string annotationData) | Kodlanmış sayfa/Base64 zarfından açıklamaları yükle, AnnotationManager.GetAnnotationData() tarafından döndürülen |
void LoadAnnotationXML(string token, XmlDocument annotationXml) | XML'den açıklamaları yükle |
XmlDocument GetAnnotationXML(string token) | Oturumun açıklamalarını XML olarak dışa aktar |
Task<byte[]> ExportAnnotationsToPdfAsync(string token, int zoom = 100, CancellationToken ct = default) | Açıklamaları gömülü PDF |
Task<int> ExportAnnotationsToPngAsync(string token, string directoryPath, int zoom = 100, CancellationToken ct = default) | Sayfa başına bir PNG, açıklamaları gömülü, directoryPath'a yazılır (eksikse oluşturulur); yazılan görüntü sayısını döndürür |
Task<byte[]> ExportAnnotationsToPngZipAsync(string token, int zoom = 100, CancellationToken ct = default) | Açıklamaları gömülü sayfa başı PNG'lerin ZIP'i |
DICOM meta verileri
Task<DicomMetadata?> GetDicomMetadataAsync(string token, CancellationToken ct = default)DICOM eklentisi aracılığıyla açılan oturumlar için DICOM etiket meta verilerini döndürür; DICOM olmayan belgeler için null.
Kaynak yardımcıları — ReferenceCss / ReferenceScripts
Gömülü kaynakları UseDoconutResources() tarafından sunulan doğru bağımlılık sırasıyla <link>/<script> etiketlerini üretir. Arama ve açıklama gibi lisans kısıtlamalı özellikler için paketler yalnızca lisans bunları etkinleştirdiğinde üretilir, istemci UI'sını sunucu davranışıyla tutarlı tutar.
string ReferenceCss(CssConfig? config = null) // null → Bootstrap + görüntüleyici + arama + notlandırma
string ReferenceScripts(ScriptConfig? config = null)CssConfig bayrakları: IncludeBootstrapCss, IncludeViewerCss, IncludeSearchCss (arama kısıtlamalı), IncludeAnnotationCss (açıklama kısıtlamalı).
ScriptConfig bayrakları: IncludeJQuery (tüm diğerleri tarafından gereklidir), IncludeBootstrap, IncludeViewerScripts (çekirdek: docViewer.js + splitter + links), IncludeSearchScripts ve IncludeSearchBar (arama kısıtlamalı), IncludeAnnotationScripts ve IncludeAnnotationBar (açıklama kısıtlamalı), EmitFeatureFlags (varsayılan true: ayrıca bir satır içi window.Doconut.features = { search, annotation, editor } betiği yazar; satır içi betiği engelleyen bir Content-Security-Policy altında false olarak ayarlayın).
@inject Doconut.Viewer Viewer
@Html.Raw(Viewer.ReferenceCss(new CssConfig { IncludeBootstrapCss = true, IncludeViewerCss = true }))
@Html.Raw(Viewer.ReferenceScripts(new ScriptConfig { IncludeJQuery = true, IncludeViewerScripts = true }))Bu sayfa yardımcı oldu mu?