Görüntüleyici

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 olarak işaretlenmiştir, AddDoconut() tarafından transient hizmet olarak kaydedilir ve yapıcı enjeksiyonu yoluyla çözülür — asla doğrudan oluşturmayın.

Önceki .NET Standard kütüphanesi, bellek önbelleğini, HTTP bağlam erişicisini ve bir veya daha fazla lisans yolunu alan bir genel yapıcı sunuyordu. Bu yapıcı artık yok; hizmet grafiği bu bağımlılıkları sağlar.

Viewer hiçbir istek başına durum tutmaz ve kasıtlı olarak IDisposable değil implement eder: belge oturumları oturum önbelleğinde bağımsız olarak yaşar, bu yüzden hizmeti dispose etmek açık bir belgeyi asla kapatamaz (bkz. Temel Kavramlar → Görüntüleyicinin Nasıl Çalıştığı).

OpenDocumentAsync

Bir belge açar ve istemci widget'ının sonraki tüm isteklerde kullandığı oturum belirtecini döndürür. Her açma işlemi eşzamansızdır — senkron bir OpenDocument yoktur.

// Simple open
string token = await viewer.OpenDocumentAsync(path);

// With per-format config and options
token = await viewer.OpenDocumentAsync(
    path,
    new PdfConfig { AllowSearch = true, AllowCopy = true },
    new DocOptions { TimeOut = 30 });

// From an upload
await using var ms = new MemoryStream();
await file.CopyToAsync(ms);
ms.Position = 0;
token = await viewer.OpenDocumentAsync(ms, new FileInfo(file.FileName));

Ele alınacak İstisnalar:

• LicenseException — bulunan bir lisans reddedilir (mesaj reddetme nedenini taşır), veya format artık sağlanmayan bir eklenti yeteneğine ihtiyaç duyar. Reddetme mesajı olmadan takvim süresi dolması, hata fırlatmak yerine su işareti ekli render'a 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 dispose eder), güvenlik işaretçisini siler ve erişim iznini iptal eder. İsteğe bağlı — kayar 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ı. Belirteç bilinmiyorsa veya süresi dolmuşsa hata fırlatır.

Yetenek bayrakları

Bunları bir Razor görünümünde, sunucunun gerçekten sunacağı zaman lisanslı bir Ribbon render etmek için kullanın — bkz. Hızlı Başlangıç.

DocOptions

Açma başına, format bağımsız seçenekler (namespace Doconut):

Sınıf ayrıca, normal tek sunucu görüntüleme akışının dışına kasıtlı olarak yerleştirilmiş özel özellikler sunar:

Özel filigran

DocOptions.Watermark altı tilde ile ayrılmış alan kullanır. İsteğe bağlı bir baştaki ^ işareti, tüm köşelere yayılmış yerleşimi talep eder:

^Text~Color~FontSize~FontName~Opacity~Angle

string token = await viewer.OpenDocumentAsync(
    path,
    new PdfConfig(),
    new DocOptions
    {
        Watermark = "^Confidential~Red~24~Verdana~80~-45",
        TimeOut = 30
    });

Ayrıştırıcı, isteğe bağlı ^ işaretinden sonra tam olarak 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ı

Aynı karar, sunulan sayfa görüntülerine ve ek açıklama dışa aktarımlarına da uygulanır. Hareketli GIF çıktısı kare kare damgalanır. Bu nedenle özel bir filigran, bir lisanslı uygulama özelliğidir; değerlendirme filigranını değiştirmek veya bastırmak için bir yol değildir.

Ek açıklamalar API

Sunucu tarafı ek açıklama yükleme ve dışa aktarma. Tam kılavuz Guides → Annotations içinde bulunur; özet şu şekildedir:

Bu yöntemlerin her biri oturum token'ını alır. Önceki kütüphanenin oturum‑sız GetAnnotationManager(pageWidth, pageHeight) şekli, oturum dışı ek açıklama oluşturmak için hâlâ kullanılabilir, ancak bunları yüklemek yine bir token gerektirir.

DICOM meta verileri

Task<DicomMetadata?> GetDicomMetadataAsync(string token, CancellationToken ct = default)

Bu yöntem API uyumluluğu için bulunur, ancak bu paket teknik DICOM etiketlerini sağlayamaz: meta veri okuyucu yalnızca bir .NET 8 derlemesiyle gelir. DICOM ve DICOM olmayan oturumlar için null döner; bir DICOM oturumunda ayrıca platform sınırlamasını açıklayan tek seferlik bir uyarı yazar. Sayfa, çerçeve ve animasyon renderlaması hâlâ desteklenir.

Kaynak yardımcıları — ReferenceCss / ReferenceScripts

Gömülü kaynakları UseDoconutResources() tarafından sunulan <link>/<script> etiketlerini doğru bağımlılık sırasıyla oluşturur. Arama ve açıklama gibi lisans kısıtlamalı özellikler için paketler yalnızca lisans bunları etkinleştirdiğinde oluşturulur, böylece istemci UI'si sunucu davranışıyla tutarlı kalır.

string ReferenceCss(CssConfig? config = null)      // null → Bootstrap + viewer + search + annotation
string ReferenceScripts(ScriptConfig? config = null)

CssConfig bayrakları: IncludeBootstrapCss, IncludeViewerCss, IncludeSearchCss (search-gated), IncludeAnnotationCss (annotation-gated).

ScriptConfig bayrakları: IncludeJQuery (required by all others), IncludeBootstrap, IncludeViewerScripts (core: docViewer.js + splitter + links), IncludeSearchScripts ve IncludeSearchBar (search-gated), IncludeAnnotationScripts ve IncludeAnnotationBar (annotation-gated).

@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 yardımcılar, tarayıcı kaynaklarını sunmanın desteklenen yoludur. docViewer.js, documentLinks.js ve docViewer.UI.js dosyalarını wwwroot içine kopyalayan uygulamalar, sayfa oluşturulan etiketlerden render edildikten sonra bu kopyaları kaldırmalıdır.