Betrachter

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

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

OpenDocumentAsync

Öffnet ein Dokument und gibt das Sitzungstoken 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 wasserzeichenbasierten 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 (der Dokument‑Engine wird sofort entsorgt), löscht das Sicherheitskennzeichen und widerruft die Zugriffsgewährung. 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-Corners-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 das sichtbare 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.

Anmerkungen-API

Serverseitiges Laden und Exportieren von Anmerkungen. Der vollständige Leitfaden befindet sich in Anleitungen → Anmerkungen; die Oberfläche ist:

DICOM-Metadaten

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

Gibt DICOM-Tag-Metadaten für über das DICOM-Plugin geöffnete Sitzungen zurück; null für Nicht-DICOM-Dokumente.

Ressourcenhilfen — ReferenceCss / ReferenceScripts

Gibt die <link>/<script>-Tags für die eingebetteten Ressourcen aus, die von UseDoconutResources() bereitgestellt werden, in korrekter Abhängigkeitsreihenfolge. Bündel für lizenzabhängige Funktionen wie Suche und Anmerkungen werden nur dann ausgegeben, wenn die Lizenz sie aktiviert, wodurch die Client‑UI konsistent zum Serververhalten bleibt.

string ReferenceCss(CssConfig? config = null)      // null → Bootstrap + Betrachter + Suche + Anmerkung
string ReferenceScripts(ScriptConfig? config = null)

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

ScriptConfig Flags: IncludeJQuery (required by all others), IncludeBootstrap, IncludeViewerScripts (core: docViewer.js + splitter + links), IncludeSearchScripts und IncludeSearchBar (search-gated), IncludeAnnotationScripts und 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 }))

GetWorksheetNames

IReadOnlyList<string> GetWorksheetNames(string token)

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

Hinzugefügt in 26.9.0.