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ını sağlar. 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.

Viewer per-istek durumu tutmaz ve kasıtlı olarak uygulamaz IDisposable: belge oturumları oturum önbelleğinde bağımsız olarak yaşar, bu yüzden hizmeti yok 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 jetonunu döndürür.

// 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ı — kayar süresi dolma 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 hata fırlatır.

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 ön ^ tüm köşeler düzenini 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ı ^ sonrasında 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 açıklama dışa aktarmalarına uygulanır. Hareketli GIF çıktısı kare kare damgalanır. Bu nedenle özel filigran, bir lisanslı uygulama özelliğidir, değerlendirme filigranını değiştirmek veya bastırmak için bir yol değildir.

Açıklama API'si

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

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 oluştur. Arama ve açıklama gibi lisans kısıtlamalı özellikler için paketler yalnızca lisans bunları etkinleştirdiğinde oluşturulur, istemci UI'sını sunucu davranışıyla tutarlı tutar.

string ReferenceCss(CssConfig? config = null)      // null → Bootstrap + viewer + search + annotation
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 + ayırıcı + bağlantılar), IncludeSearchScripts ve IncludeSearchBar (arama kısıtlamalı), IncludeAnnotationScripts ve IncludeAnnotationBar (açıklama kısıtlamalı).

@inject Doconut.Viewer Viewer

@Html.Raw(Viewer.ReferenceCss(new CssConfig { IncludeBootstrapCss = true, IncludeViewerCss = true }))
@Html.Raw(Viewer.ReferenceScripts(new ScriptConfig { IncludeJQuery = true, IncludeViewerScripts = true }))

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 olmadığında ise boş bir liste döndürür.

26.9.0 sürümünde eklendi.