Viewer

Viewer (namespace Doconut) ist der öffentliche Einstiegspunkt zum Öffnen von Dokumenten aus Razor‑Seiten, MVC‑Controllern, Blazor‑Komponenten oder Minimal‑APIs. Es ist sealed, registriert als transient Service von AddDoconut() und wird über Konstruktorinjektion aufgelöst – niemals direkt konstruieren.

Viewer hält keinen per‑Anfrage‑Zustand und implementiert absichtlich nicht IDisposable: Dokumentensitzungen leben unabhängig im Sitzungs‑Cache, sodass das Entsorgen des Dienstes niemals ein geöffnetes Dokument schließen kann (siehe Kernkonzepte → Wie der Viewer funktioniert).

OpenDocumentAsync

Öffnet ein Dokument und gibt das Sitzungs‑Token zurück, das das Client‑Widget für alle nachfolgenden Anfragen verwendet.

// Einfach öffnen
string token = await viewer.OpenDocumentAsync(path);

// Mit pro-Format-Konfiguration und Optionen
token = await viewer.OpenDocumentAsync(
    path,
    new PdfConfig { AllowSearch = true, AllowCopy = true },
    new DocOptions { TimeOut = 30 });

// Aus einem Upload
await using var ms = new MemoryStream();
await file.CopyToAsync(ms);
ms.Position = 0;
token = await viewer.OpenDocumentAsync(ms, new FileInfo(file.FileName));

Ausnahmen zu behandeln:

• LicenseException — eine gefundene Lizenz wird abgelehnt (die Meldung enthält den Ablehnungsgrund), oder das Format benötigt eine Plugin‑Fähigkeit, die nicht mehr gewährt wird. Das Ablaufdatum des Kalenders ohne Ablehnungsnachricht führt zu einer wassergezeichneten Darstellung anstelle einer Ausnahme.
• FormatNotSupportedException — Document format '<extension>' is not supported.
• InvalidDataException — der Dateiinhalt ist beschädigt oder stimmt nicht mit seiner Erweiterung überein.

CloseDocument

void CloseDocument(string token)

Entfernt die Sitzung aus dem Cache (entsorgt die Dokument‑Engine sofort), löscht den Sicherheitsmarker und widerruft die Zugriffsberechtigung. Optional — die gleitende Ablaufzeit führt dieselbe Bereinigung durch — wird jedoch für große Dokumente empfohlen.

GetPageCount

int GetPageCount(string token)

Gesamtseitenzahl der offenen Sitzung. Wirft eine Ausnahme, wenn das Token unbekannt oder abgelaufen ist.

DocOptions

Pro‑Öffnung, formatunabhängige Optionen (Namespace Doconut):

Die Klasse stellt außerdem spezialisierte Eigenschaften bereit, die bewusst außerhalb des normalen Single‑Host‑Anzeigestroms liegen:

Benutzerdefiniertes Wasserzeichen

DocOptions.Watermark verwendet sechs durch Tilde getrennte Felder. Ein optional führendes ^ fordert das All‑Ecken‑Layout an:

^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
    });

Der Parser erwartet genau sechs Felder nach dem optionalen ^. Eine ungültige Definition wird durch den sichtbaren Invalid Watermark‑Fallback des SDK ersetzt, anstatt stillschweigend zu verschwinden.

Lizenzentscheidung

Die gleiche Entscheidung wird auf bereitgestellte Seitenbilder und Anmerkungs‑Exporte angewendet. Animierte GIF‑Ausgabe wird Bild für Bild gestempelt. Ein benutzerdefiniertes Wasserzeichen ist daher ein lizenziertes Anwendungsfeature und kein Mittel, das Evaluationswasserzeichen zu ersetzen oder zu unterdrücken.

Anmerkungs‑API

Serverseitiges Laden und Exportieren von Anmerkungen. Die vollständige Anleitung befindet sich in Leitfäden → Anmerkungen; die Oberfläche ist:

DICOM‑Metadaten

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

Die Methode dient der API‑Ausrichtung, aber der .NET 6 DICOM‑Viewer kann keine technischen Tags bereitstellen. Sie gibt null für DICOM‑ und Nicht‑DICOM‑Sitzungen zurück; bei einer DICOM‑Sitzung schreibt sie außerdem eine einmalige Warnung, die die Plattform‑Beschränkung erklärt. Seiten-, Frame‑ und Animations‑Rendering bleiben unterstützt.

Ressourcen‑Hilfsprogramme — ReferenceCss / ReferenceScripts

Geben Sie die <link>/<script>‑Tags für die eingebetteten Ressourcen aus, die von UseDoconutResources() bereitgestellt werden, in korrekter Abhängigkeitsreihenfolge. Bündel für lizenzgesteuerte Funktionen wie Suche und Anmerkung werden nur dann ausgegeben, wenn die Lizenz sie aktiviert, sodass die Client‑UI mit dem Serververhalten konsistent bleibt.

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

CssConfig‑Flags: IncludeBootstrapCss, IncludeViewerCss, IncludeSearchCss (Such‑gesteuert), IncludeAnnotationCss (Anmerkungs‑gesteuert).

ScriptConfig‑Flags: IncludeJQuery (von allen anderen benötigt), IncludeBootstrap, IncludeViewerScripts (Kern: docViewer.js + Splitter + Links), IncludeSearchScripts und IncludeSearchBar (Such‑gesteuert), IncludeAnnotationScripts und IncludeAnnotationBar (Anmerkungs‑gesteuert).

@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)

Gibt die Arbeitsblattnamen einer geöffneten Tabelle in Arbeitsmappenreihenfolge zurück oder eine leere Liste, wenn das geöffnete Dokument keine Tabelle ist.

Hinzugefügt in 26.9.0.