Visionneuse

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.

La bibliothèque .NET Standard précédente exposait un constructeur public prenant le cache mémoire, l'accès au contexte HTTP, et un ou plusieurs chemins de licence. Ce constructeur a disparu ; le graphe de services fournit ces dépendances.

Viewer ne conserve aucun état par requête et ne implémente intentionnellement pas 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 Visionneur).

OpenDocumentAsync

Ouvre un document et renvoie le jeton de session que le widget client utilise pour toutes les requêtes ultérieures. Chaque ouverture est asynchrone — il n'existe pas de OpenDocument synchrone.

// Simple open
string token = await viewer.OpenDocumentAsync(path);

// With per-format config and options
token = await viewer.OpenDocumentAsync(
    path,
    new PdfConfig { AllowSearch = true, AllowCopy = true },
    new DocOptions { TimeOut = 30 });

// From an upload
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. (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é.

Indicateurs de capacité

Utilisez-les dans une vue Razor pour afficher un Ruban sous licence uniquement lorsque le serveur le fournira réellement — voir Démarrage rapide.

DocOptions

Options indépendantes du format, par ouverture (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 disposition sur tous les 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 substitut 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 :

Chaque méthode prend le jeton de session. La forme sans session GetAnnotationManager(pageWidth, pageHeight) de la bibliothèque précédente subsiste pour créer des annotations hors session, mais leur chargement nécessite toujours un jeton.

Métadonnées DICOM

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

La méthode est présente pour l’alignement de l’API, mais ce paquet ne peut pas fournir les balises techniques DICOM : le lecteur de métadonnées n’est disponible qu’en version .NET 8. Il renvoie null pour les sessions DICOM et non‑DICOM ; sur une session DICOM il écrit également un avertissement unique expliquant la limitation de la plateforme. Le rendu des pages, des images et des animations reste pris en charge.

Assistants de ressources — ReferenceCss / ReferenceScripts

Émettez 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, telles que la recherche et l'annotation, sont émis uniquement lorsque la licence les active, assurant que l'interface client reste cohérente avec le comportement du serveur.

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

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

ScriptConfig drapeaux : IncludeJQuery (requis par tous les autres), IncludeBootstrap, IncludeViewerScripts (cœur : docViewer.js + splitter + 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 }))

Ces assistants sont la méthode prise en charge pour fournir les ressources du navigateur. Les applications qui ont copié docViewer.js, documentLinks.js et docViewer.UI.js dans wwwroot devraient supprimer ces copies une fois que la page est rendue à partir des balises émises.