Visionneuse

Viewer (namespace Doconut) est le point d'entrée public pour ouvrir des documents depuis des pages Razor, des contrôleurs MVC, des composants Blazor ou des API minimalistes. Il est scellé, enregistré comme service transient par AddDoconut(), et résolu via l'injection de constructeur — ne le construisez jamais directement.

Viewer ne conserve aucun état par requête et ne implémente pas intentionnellement IDisposable : les sessions de documents vivent indépendamment dans le cache de session, de sorte que la libération du service ne peut jamais fermer un document ouvert (voir Concepts de base → Comment fonctionne le Viewer).

OpenDocumentAsync

Ouvre un document et renvoie le jeton de session que le widget client utilise pour toutes les requêtes ultérieures.

// Ouverture simple
string token = await viewer.OpenDocumentAsync(path);

// Avec une configuration et des options par format
token = await viewer.OpenDocumentAsync(
    path,
    new PdfConfig { AllowSearch = true, AllowCopy = true },
    new DocOptions { TimeOut = 30 });

// À partir d'un téléchargement
await using var ms = new MemoryStream();
await file.CopyToAsync(ms);
ms.Position = 0;
token = await viewer.OpenDocumentAsync(ms, new FileInfo(file.FileName));

Exceptions à gérer :

• LicenseException — une licence trouvée est rejetée (le message indique la raison du rejet), ou le format nécessite une capacité de plugin qui n'est plus accordée. L'expiration du calendrier sans message de rejet se traduit par un rendu filigrané au lieu de lever une exception.
• FormatNotSupportedException — Document format '<extension>' is not supported.
• InvalidDataException — le contenu du fichier est corrompu ou ne correspond pas à son extension.

CloseDocument

void CloseDocument(string token)

Supprime la session du cache (en libérant immédiatement le moteur de document), supprime le marqueur de sécurité et révoque l'autorisation d'accès. Optionnel — l'expiration glissante effectue le même nettoyage — mais recommandé pour les gros documents.

GetPageCount

int GetPageCount(string token)

Nombre total de pages de la session ouverte. Lève une exception si le jeton est inconnu ou expiré.

DocOptions

Options par ouverture, indépendantes du format (namespace Doconut) :

La classe expose également des propriétés spécialisées qui sont intentionnellement en dehors du flux de visualisation normal à hôte unique :

Filigrane personnalisé

DocOptions.Watermark utilise six champs séparés par des tildes. Un ^ optionnel en tête demande la disposition tous‑coins :

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

L’analyseur attend exactement six champs après le ^ optionnel. Une définition invalide est remplacée par le repli visible Invalid Watermark du SDK au lieu de disparaître silencieusement.

Décision de licence

La même décision s’applique aux images de pages servies et aux exportations d’annotations. La sortie GIF animée est estampillée image par image. Un filigrane personnalisé est donc une fonctionnalité d’application sous licence, et non un moyen de remplacer ou de supprimer le filigrane d’évaluation.

API d'annotations

Chargement et export d’annotations côté serveur. Le guide complet se trouve dans Guides → Annotations ; l’interface est :

Métadonnées DICOM

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

Renvoie les métadonnées des balises DICOM pour les sessions ouvertes via le plugin DICOM ; null pour les documents non‑DICOM.

Assistants de ressources — ReferenceCss / ReferenceScripts

Émettre les balises <link>/<script> pour les ressources intégrées servies par UseDoconutResources(), dans le bon ordre de dépendance. Les paquets pour les fonctionnalités soumises à licence, comme la recherche et l’annotation, sont émis uniquement lorsque la licence les active, maintenant ainsi la cohérence de l’interface client avec le comportement du serveur.

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

CssConfig flags: IncludeBootstrapCss, IncludeViewerCss, IncludeSearchCss (restreint à la recherche), IncludeAnnotationCss (restreint à l’annotation).

ScriptConfig flags: IncludeJQuery (requis par tous les autres), IncludeBootstrap, IncludeViewerScripts (noyau : docViewer.js + séparateur + liens), IncludeSearchScripts et IncludeSearchBar (restreint à la recherche), IncludeAnnotationScripts et IncludeAnnotationBar (restreint à l’annotation).

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

Renvoie les noms des feuilles de calcul d'une feuille de calcul ouverte, dans l'ordre du classeur, ou une liste vide lorsque le document ouvert n'est pas une feuille de calcul.

Ajouté dans 26.9.0.