Démarrage rapide

Rendez votre premier document en quelques minutes

Ce guide transforme une application ASP.NET Core d'un Program.cs vide en un document rendu dans le navigateur : enregistrement du serveur, le package complet du Viewer (barre d'outils du Viewer, montage du Viewer et rubans optionnels de Recherche/Annotation), références d'actifs, initialisation du client, ouverture du document et exécution.

L'application hôte doit cibler un runtime qui prend en charge netstandard2.1 — .NET Core 3.0 ou supérieur.

Server setup

AddDoconut() enregistre les services ; UseDoconutResources() et UseDoconut() connectent le middleware. L'appel aux ressources doit être en premier. UseDoconut() répond à chaque requête qui l'atteint, donc montez-le sur sa propre branche avec app.Map. Les appels de session sont également requis — la sécurité de document par défaut de Doconut valide chaque requête de page contre l'état de session ASP.NET. L'état de session nécessite un cache : AddDistributedMemoryCache() en fournit un. Une application MVC ou Razor Pages l'enregistre déjà, mais une application minimal-API ne le fait pas, et sans cela l'application s'arrête au démarrage avec Unable to resolve service for type 'IDistributedCache'. Vous avez déjà enregistré Doconut lors de Installation ? Passez à la section suivante.

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath = "Doconut.Viewer.lic";
});
builder.Services.AddDistributedMemoryCache(); // l'état de session nécessite un cache (MVC/Razor Pages en ajoute déjà un)
builder.Services.AddSession(); // La sécurité des documents Doconut repose sur l'état de session ASP.NET

app.UseSession();          // appelez UseSession() avant UseDoconut()
app.UseDoconutResources(); // doit être enregistré avant UseDoconut()
app.Map("/doconut", branch => branch.UseDoconut());

Cette configuration conserve la forme historique de la requête DocImage.axd et monte le middleware de document sur une branche correspondante. C'est l'agencement à copier lorsque vous faites évoluer une application .NET Standard existante, car le client continue d'appeler la même URL qu'il a toujours utilisée :

csharp
builder.Services.AddDoconut(options =>
{
    options.UnsafeMode      = false;   // conservez la vérification de session de Doconut's activée
    options.ShowDoconutInfo = false;
});
builder.Services.AddDistributedMemoryCache(); // l'état de session nécessite un cache (MVC/Razor Pages en ajoute déjà un)
builder.Services.AddSession(options =>
{
    options.IdleTimeout        = TimeSpan.FromSeconds(3600);
    options.Cookie.HttpOnly    = true;
    options.Cookie.IsEssential = true;
});

// Requis pour les encodages multi-octets dans certains formats de document.
Encoding.RegisterProvider(CodePagesEncodingProvider.Instance);

app.UseStaticFiles();
app.UseRouting();
app.UseSession();
app.UseDoconutResources();   // AVANT la branche du document
app.MapWhen(
    context => context.Request.Path.Value?.EndsWith("DocImage.axd", StringComparison.OrdinalIgnoreCase) == true,
    branch => branch.UseDoconut());

UseDoconut() ne prend aucune option dans cette version — tout a été déplacé vers AddDoconut(). MiddlewarePath est une valeur de coordination ; elle ne mappe pas une branche ASP.NET Core par elle-même. Avec la branche DocImage.axd ci‑dessus, le client utilise BasePath: '/' ; avec app.Map("/doconut", ...) de la configuration minimale, il utilise BasePath: 'doconut'. ResourcesPath sert le bundle intégré à /doconut-res, et le chemin de la ressource image du widget est donc ResPath: 'doconut-res/images'.

Add the viewer to a page

Le Viewer est le cœur requis de la page. Sa surface de rendu utilise deux div imbriqués :

html
<div id="divDocViewer">
    <div id="div_ctlDoc"></div>
</div>

Considérez la barre d'outils, les montages de modules et la surface du Viewer comme une seule composition de page. Recherche et Annotation injectent leurs rubans intégrés dans des montages optionnels, mais ces modules ne sont jamais autonomes : ils s'attachent toujours au Viewer sur la même page.

html
<nav id="toolbar" aria-label="Document viewer controls">
    <!-- Boutons de navigation, zoom, recherche et annotation du visualiseur -->
</nav>

<div id="searchBarMount"></div>
<div id="annBarMount"></div>

<div id="divDocViewer">
    <div id="div_ctlDoc"></div>
</div>

Référencer les actifs du visualiseur

Dans une vue Razor, le service injecté Viewer émet les balises <link> et <script> du visualiseur dans l'ordre de dépendance — le widget est un plugin jQuery, donc jQuery doit être chargé avant les scripts du visualiseur :

html
@inject Doconut.Viewer Viewer

@Html.Raw(Viewer.ReferenceCss(new CssConfig
{
    IncludeBootstrapCss = true,
    IncludeViewerCss    = true
}))

@Html.Raw(Viewer.ReferenceScripts(new ScriptConfig
{
    IncludeJQuery        = true,
    IncludeBootstrap     = true,
    IncludeViewerScripts = true
}))

Pour le package complet du visualiseur, demandez les ressources du visualiseur et du module ensemble :

html
@Html.Raw(Viewer.ReferenceCss(new CssConfig
{
    IncludeBootstrapCss  = true,
    IncludeViewerCss     = true,
    IncludeSearchCss     = true,
    IncludeAnnotationCss = true
}))

@Html.Raw(Viewer.ReferenceScripts(new ScriptConfig
{
    IncludeJQuery            = true,
    IncludeBootstrap         = true,
    IncludeViewerScripts     = true,
    IncludeSearchScripts     = true,
    IncludeSearchBar         = true,
    IncludeAnnotationScripts = true,
    IncludeAnnotationBar     = true
}))

IncludeViewerCss et IncludeViewerScripts sont les indicateurs de base obligatoires. Ne publiez jamais un exemple de barre de recherche ou d'annotation sans eux, le montage du visualiseur, et une instance docViewer. ReferenceCss et ReferenceScripts omettent les ressources d'un module optionnel lorsque la licence actuelle ne confère pas cette capacité ; le visualiseur de base démarre quand même.

Ces appels remplacent les fichiers de script copiés à la main. Si l'application charge encore ses propres docViewer.js, documentLinks.js ou docViewer.UI.js, supprimez ces balises une fois que la page fonctionne avec les ressources émises — voir le guide de migration.

Initialiser le visualiseur

Le widget côté client est un plugin jQuery. Voici un ensemble minimal d'options d'initialisation réelles (et non du pseudocode) :

javascript
let searchBar = null;
let annBar = null;

const objViewer = $('#div_ctlDoc').docViewer({
    showThumbs: true,
    autoLoad:   false,
    pageZoom:   100,
    FitType:    'width',
    BasePath:   '/',                   // la branche DocImage.axd; 'doconut' avec app.Map("/doconut", ...)
    ResPath:    'doconut-res/images',
    onViewerReady: function () {
        // les pages sont visibles; il est sûr de masquer un indicateur de chargement ici
    },
    // Transférer les événements du cycle de vie des annotations au ribbon intégré lorsqu'il est présent.
    onAnnLoaded:    () => annBar?.handleAnnLoaded(),
    onAnnSaved:     () => annBar?.handleAnnSaved(),
    onAnnSaveError: () => annBar?.handleAnnSaveError(),
    onAnnClosed:    () => annBar?.handleAnnClosed(),
    onError: function (message) {
        console.error('Doconut viewer error:', message);
    }
});

Quatre détails décident si cette page fonctionne du tout :

  • Les rappels sont des options. onViewerReady, onViewerBusy, onCopy et onAutoLoadStatus sont passés dans l'objet d'options. Le visualiseur précédent dérivait les noms de fonctions globales à partir de l'ID du conteneur et les appelait ; celui-ci ne le fait pas. Un gestionnaire déclaré uniquement comme fonction globale ne s'exécute jamais, et rien n'est signalé.
  • ResPath pointe vers le préfixe des ressources, pas la racine de l'application. Avec le ResourcesPath par défaut, cette valeur est doconut-res/images. Si vous avez modifié ResourcesPath, utilisez votre propre préfixe à la place. Les icônes se trouvent un dossier en dessous de la racine des ressources : avec 'doconut-res', chaque icône renvoie 404 alors que le document lui‑même s'affiche toujours.
  • BasePath n'a pas de slash initial autre que la valeur de la racine du site '/'. 'doconut' demande /doconut/DocImage.axd ; '/doconut' produit //doconut/DocImage.axd, que le navigateur interprète comme une requête vers un autre hôte.
  • Conservez le visualiseur, puis appelez View séparément. docViewer(...) renvoie l'objet avec Zoom, Next et FitType ; View(...) renvoie autre chose. var objViewer = $('#div_ctlDoc').docViewer({...}).View(token) rend le document, puis échoue avec objViewer.Zoom is not a function lors du premier clic sur la barre d'outils.

Tous ces cas échouent silencieusement — voir la section Dépannage et le guide de migration.

La casse des options est réellement mélangée — showThumbs, autoLoad et pageZoom sont en camelCase, mais FitType, BasePath et ResPath sont en PascalCase. Il n'existe aucune règle cohérente ; une mauvaise casse entraîne l'ignorance silencieuse de l'option (le widget revient à sa valeur par défaut au lieu de lever une exception).

Assembler le package complet du Viewer

Une page Viewer complète installe les parties suivantes ensemble :

Partie du paquetExigenceComment il est connecté
Ressources du Viewer, montage, et objViewerObligatoireMoteur de rendu de document principal
Barre d'outils du ViewerObligatoire pour une page complèteBalise hôte ; les boutons appellent le même objViewer
Ruban de rechercheOptionnel, module sous licencedoconutSearchBar(...).attach(objViewer)
Ruban d'annotationOptionnel, module sous licencedoconutAnnotationBar(...).attach(objViewer)

Bien que la barre d'outils principale du Viewer soit une balise hôte, elle est installée à côté du Viewer et ne doit jamais être documentée comme un contrôle isolé. Cela maintient sa mise en page, ses libellés, ses icônes et ses règles d'autorisation sous le contrôle de votre application tandis que chaque bouton pilote la même instance du Viewer :

html
<nav id="toolbar" aria-label="Document viewer controls">
    <button type="button" onclick="objViewer.GotoPage(1)">First</button>
    <button type="button" onclick="objViewer.Next(false)">Previous</button>
    <button type="button" onclick="objViewer.Next(true)">Next</button>
    <button type="button" onclick="objViewer.GotoPage(objViewer.TotalPages())">Last</button>
    <button type="button" onclick="objViewer.Zoom(false)">Zoom out</button>
    <button type="button" onclick="objViewer.Zoom(true)">Zoom in</button>
    <button type="button" onclick="objViewer.FitType('width')">Fit width</button>
    <button type="button" onclick="objViewer.FitType('height')">Fit height</button>
    <button type="button" id="openSearch">Search</button>
    <button type="button" id="openAnnotations">Annotations</button>
</nav>

Conservez cet ordre d'initialisation :

  1. Émettre le CSS pour le Viewer et les modules sous licence.
  2. Rendre la barre d'outils du Viewer, les montages Recherche/Annotation, et le montage du Viewer ensemble.
  3. Émettre les scripts pour le Viewer et les modules sous licence.
  4. Charger le script d'aide de la barre d'outils propre à l'application hôte.
  5. Initialiser docViewer et conserver le objViewer résultant.
  6. Initialiser chaque ruban Recherche ou Annotation sous licence.
  7. Appeler attach(objViewer) sur chaque ruban.
  8. Ouvrir le document et conserver son jeton pour les requêtes du Viewer et des modules.

Les garde-fous côté serveur sont importants : lorsqu'une capacité optionnelle n'est pas disponible, son script n'est pas émis, de sorte que sa fonction plug-in jQuery n'existe pas.

html
<script>
    let token = '';

    const refitViewer = () =>
        requestAnimationFrame(() => objViewer.Refit());

    @if (Viewer.IsSearchEnabled)
    {
        <text>
    searchBar = $('#searchBarMount').doconutSearchBar({
        docId: 'ctlDoc',
        getRequestParams: () => ({ token }),
        onLayout: refitViewer
    });
    searchBar.attach(objViewer);
        </text>
    }

    @if (Viewer.IsAnnotationEnabled)
    {
        <text>
    annBar = $('#annBarMount').doconutAnnotationBar({
        docId: 'ctlDoc',
        getRequestParams: () => ({ token }),
        onLayout: refitViewer
    });
    annBar.attach(objViewer);
        </text>
    }

    document.getElementById('openSearch').addEventListener('click', () => {
        if (!searchBar) return;
        searchBar.isOpen() ? searchBar.close() : searchBar.open();
    });

    document.getElementById('openAnnotations').addEventListener('click', () => {
        if (!annBar) return;
        annBar.isOpen() ? annBar.close() : annBar.open();
    });
</script>

Les deux composants intégrés génèrent leur propre DOM de ruban. Recherche contient les groupes Trouver, Options et Résultats. Annotation contient ses outils d'édition, contrôles de style, actions d'enregistrement et actions d'exportation/image optionnelles. Les barres exposent open(), close(), reset() et isOpen() ; appelez toujours attach(objViewer) une fois après les avoir créées.

L'exemple ci‑dessus omet les rappels d'hôte optionnels et les points de terminaison d'exportation/image d'Annotation afin de garder le démarrage minimal. Voir Recherche et Annotations pour la configuration complète spécifique aux fonctionnalités, ou Thèmes personnalisés pour styliser ou remplacer la barre d'outils du Viewer détenue par l'hôte.

Ouvrir un document

Le côté serveur possède un seul point d'accès : le service injecté Viewer ouvre le document et renvoie un jeton de session. L'ouverture est asynchrone dans cette version.

csharp
app.MapPost("/api/open", async (Viewer viewer) =>
{
    // Le token est opaque — remettez‑le au widget, ne le journalisez ni ne le persistez.
    string token = await viewer.OpenDocumentAsync("wwwroot/files/Sample.pdf");
    return Results.Ok(new { token });
});

Le client récupère ce jeton et le transmet au widget avec objViewer.View(token) :

javascript
fetch('/api/open', { method: 'POST' })
    .then(resp => resp.json())
    .then(data => {
        token = data.token;
        objViewer.View(token);
    });

Il n'y a rien à préparer avant la première ouverture. Si vous faites évoluer une application
vers l'avant, supprimez tout appel InitCache() ainsi que le drapeau qui le protège — la méthode n'existe plus.

Fermer le document

Appelez objViewer.Close(true) lorsque l'utilisateur quitte le visualiseur ou ouvre un document de remplacement : cela vide le widget et envoie une requête de fermeture au serveur. objViewer.Close() sans argument ne vide que le widget. Dans les flux de travail pilotés par le serveur, viewer.CloseDocument(token) supprime immédiatement la session mise en cache, libère le moteur de rendu, supprime son marqueur de sécurité et révoque le jeton. L'expiration glissante effectue finalement le même nettoyage, mais une fermeture explicite est recommandée pour les gros documents.

Le flux de requête complet est :

text
AddDoconut + middleware
    -> render CSS/scripts and mount div
    -> initialize docViewer
    -> OpenDocumentAsync
    -> return opaque token
    -> objViewer.View(token)
    -> page/search/annotation requests
    -> Close / CloseDocument

Traitez le jeton comme une preuve d'identité : ne l'enregistrez jamais, ne le conservez jamais, remettez‑le uniquement au widget. Il identifie une session de document active sur le serveur et cesse de fonctionner lorsque cette session expire — rouvrez le document pour en obtenir un nouveau.

Exécuter

Placez un PDF à wwwroot/files/Sample.pdf, exécutez dotnet run, et ouvrez la page qui héberge le widget. La première page s'affiche dans le visualiseur, avec un panneau de vignettes à gauche. Si ce n'est pas le cas, consultez Dépannage.

Ce que vous obtenez sans licence

L'absence de licence ne génère pas d'exception. Le visualiseur rend normalement, mais chaque page porte un filigrane d'évaluation. Consultez Configuration de la licence pour savoir comment Doconut trouve une licence et ce qui change une fois qu'elle est trouvée.

Cette page était-elle utile ?