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

Viewer hiçbir istek başına durum tutmaz ve kasıtlı olarak IDisposable'i uygulamaz: 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 belirtecini döndürür.

// Basit aç
string token = await viewer.OpenDocumentAsync(path);

// Her format için yapılandırma ve seçeneklerle
token = await viewer.OpenDocumentAsync(
    path,
    new PdfConfig { AllowSearch = true, AllowCopy = true },
    new DocOptions { TimeOut = 30 });

// Bir 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 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 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ı. Belirteç 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 ek açıklama dışa aktarmalarına uygulanır. Hareketli GIF çıktısı çerçeve çerçeve 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çıklamalar API

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)

Bu yöntem API uyumluluğu için mevcuttur, ancak .NET 6 DICOM görüntüleyici teknik etiketleri sağlayamaz. DICOM ve non-DICOM oturumları için null döndürür; bir DICOM oturumunda ayrıca platform sınırlamasını açıklayan tek seferlik bir uyarı yazar. Sayfa, çerçeve ve animasyon renderlaması desteklenmeye devam eder.

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ştur. Arama ve açıklama gibi lisans-kısıtlı ö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ıtlı), IncludeAnnotationCss (açıklama-kısıtlı).

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ıtlı), IncludeAnnotationScripts ve IncludeAnnotationBar (açıklama-kısıtlı).

@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 değilse boş bir liste döndürür.

26.9.0'da eklendi.