Visionneuse

Viewer (namespace Doconut) est le point d’entrée public pour ouvrir des documents depuis les contrôleurs MVC, les pages Web Forms et les gestionnaires. C’est un service transient composé par DoconutHost.Initialize ; résolvez‑le là où vous l’utilisez :

var viewer = Doconut.DoconutHost.Services.GetRequiredService<Viewer>();

new Viewer() fonctionne également une fois que DoconutHost.Initialize a été exécuté — il résout les mêmes services — ce qui permet de conserver le code migré depuis le package classique. Avant Initialize, il lève une InvalidOperationException.

Viewer ne conserve aucun état de document par requête et ne met pas en œuvre IDisposable : les sessions de document vivent indépendamment, de sorte que la libération d’un Viewer ne pourrait jamais fermer un document ouvert (voir Comment le Visionneur Fonctionne).

OpenDocumentAsync

Ouvre un document et renvoie le jeton de session utilisé par le widget pour chaque requête ultérieure. Lorsque UnsafeMode est false (valeur par défaut), le jeton est accordé à la session ASP.NET de la requête en cours — appelez‑le depuis une requête disposant d’un état de session (voir Sessions et Sécurité).

// 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 (HttpPostedFileBase in MVC; HttpPostedFile in Web Forms)
using (var ms = new MemoryStream())
{
    await file.InputStream.CopyToAsync(ms);
    ms.Position = 0;
    token = await viewer.OpenDocumentAsync(ms, new FileInfo(Path.GetFileName(file.FileName)));
}

Exceptions à gérer :

• LicenseException — une licence a été trouvée mais rejetée (le message indique la raison), ou le format nécessite une capacité de plugin que la licence ne fournit pas.
• FormatNotSupportedException — aucun visionneur ne prend en charge l’extension du fichier.
• InvalidDataException — le contenu est corrompu ou ne correspond pas à son extension.

OpenDocument (synchronous)

Pour le code‑behind Web Forms et tout autre code qui n’utilise pas de pages asynchrones :

string OpenDocument(string filePath, BaseConfig? config = null, DocOptions? options = null)
string OpenDocument(Stream stream, string fileName, BaseConfig? config = null, DocOptions? options = null)
string OpenDocument(byte[] bytes, string fileName, BaseConfig? config = null, DocOptions? options = null)

Chaque méthode renvoie le jeton et le stocke également dans viewer.Token. fileName doit contenir la bonne extension. Ces enveloppes sont sûres à appeler depuis une page Web Forms : le chemin d’ouverture ne reprend jamais le contexte de requête ASP.NET, de sorte qu’attendre son résultat ne peut pas provoquer de blocage. Ce n’est pas le cas de chaque API asynchrone Doconut — voir la section Web Forms du Plugin de Convertisseur.

FermerDocument

void CloseDocument(string token)

Supprime la session (libérant immédiatement le moteur de document), supprime l'octroi du jeton de la session ASP.NET de la requête en cours, et révoque le jeton. Optionnel — l’expiration glissante effectue le même nettoyage — mais recommandé pour les gros documents.

Requêtes de session

Chaque appel lève une exception si le jeton est inconnu ou expiré.

OptionsDoc

Options par ouverture, indépendantes du format (espace de noms Doconut) :

Filigrane personnalisé

DocOptions.Watermark accepte 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 texte visible Invalid Watermark au lieu de disparaître silencieusement.

Décision de licence

La même décision s’applique aux pages servies et aux exportations d'annotations. Un filigrane personnalisé est une fonctionnalité d’une application sous licence, pas un moyen de remplacer le filigrane d’évaluation.

API d'annotations

Chargement et export d’annotations côté serveur. Le guide complet se trouve dans Annotations.

Métadonnées DICOM

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

Dans ce package, il renvoie toujours null, et la requête de métadonnées du widget répond 501 Not Implemented : la lecture des balises DICOM n’est pas disponible sur .NET Framework. Le rendu DICOM — pages, cadres et animation — fonctionne. Voir Plugin DICOM.

Assistants de ressources — ReferenceCss / ReferenceScripts

Émettez les balises <link> et <script> pour les ressources que le module de ressources fournit sous DoconutOptions.ResourcesPath, dans l’ordre de dépendance. Les fichiers des fonctionnalités soumises à licence (Recherche, Annotation) sont émis uniquement lorsque la licence les autorise.

string ReferenceCss(CssConfig? config = null)       // null → Bootstrap + viewer + search + annotation
string ReferenceScripts(ScriptConfig? config = null)
bool IsSearchEnabled { get; }                       // license state, for guarding ribbon init code
bool IsAnnotationEnabled { get; }

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

ScriptConfig flags: IncludeJQuery (required by all others), IncludeBootstrap, IncludeViewerScripts (the core viewer scripts), IncludeSearchScripts and IncludeSearchBar (search-gated), IncludeAnnotationScripts and IncludeAnnotationBar (annotation-gated).

Les deux renvoient du HTML : écrivez‑les avec @Html.Raw(...) dans MVC 5 (produisez‑les dans le contrôleur — les vues n’ont pas de @inject) ou <%= %> dans Web Forms. Démarrage rapide montre les deux.

RenderViewer

string RenderViewer(string elementId, string token, ViewerConfig? config = null)

Renvoie un bloc <script> qui initialise le widget sur l’élément dont l’identifiant est elementId et affiche le document : docViewer({...}) construit à partir du ViewerConfig (par défaut : BasePath: '/', ResPath: 'doconut-res/images'), puis .View(token). Placez‑le après les scripts du visualiseur. Le script généré ne conserve aucune référence à l’objet du visualiseur, ainsi une page disposant de sa propre barre d’outils doit initialiser le widget manuellement. Voir Configuration du visualiseur.

Ferme Web

string? AccessToken contient le ticket signé émis lors de la dernière ouverture lorsque le mode distribué est actif et que UnsafeMode est false ; il vaut null sur un serveur unique. Transmettez‑le au widget avec le jeton : objViewer.View(token, access).