Viewer

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

Viewer ne conserve aucun état par requête et ne pas implémente IDisposable : les sessions de documents vivent indépendamment dans le cache de session, de sorte que la libération du service ne pourrait 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 configuration et options par format
token = await viewer.OpenDocumentAsync(
    path,
    new PdfConfig { AllowSearch = true, AllowCopy = true },
    new DocOptions { TimeOut = 30 });

// Depuis 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.
  Exemple de message : « Le format de document '' n'est pas pris en charge. »
• 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 à hôte unique normal :

Filigrane personnalisé

DocOptions.Watermark utilise six champs séparés par des tildes. Un ^ optionnel en tête demande la mise en page 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
    });

Le parseur attend exactement six champs après le ^ optionnel. Une définition invalide est remplacée par le fallback 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 des 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)

La méthode existe pour l’alignement de l’API, mais le visualiseur DICOM .NET 6 ne peut pas fournir les balises techniques. Elle renvoie null pour les sessions DICOM et non‑DICOM ; sur une session DICOM, elle écrit également un avertissement unique expliquant la limitation de la plateforme. Le rendu de page, de cadre et d’animation reste pris en charge.

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 drapeaux : IncludeBootstrapCss, IncludeViewerCss, IncludeSearchCss (déclenchés par la recherche), IncludeAnnotationCss (déclenchés par l’annotation).

ScriptConfig drapeaux : IncludeJQuery (requis par tous les autres), IncludeBootstrap, IncludeViewerScripts (noyau : docViewer.js + séparateur + liens), IncludeSearchScripts et IncludeSearchBar (déclenchés par la recherche), IncludeAnnotationScripts et IncludeAnnotationBar (déclenchés par 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 la version 26.9.0.