Démarrage rapide

Rendez votre premier document en quelques minutes

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

Configuration du serveur

AddDoconut() enregistre les services ; UseDoconutResources() et UseDoconut() connectent le middleware. L'appel aux ressources doit être le 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 l'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 ajoutent 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());

Pour une disposition de chemins de type production, mappez le middleware de document vers une branche explicite et maintenez les quatre paramètres de chemin alignés :

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath = Path.Combine(AppContext.BaseDirectory, "wwwroot", "Doconut.Viewer.lic");
    options.MiddlewarePath = "/doconut";
    options.ResourcesPath = "/doconut-res";
    options.UnsafeMode = false;
});
builder.Services.AddDistributedMemoryCache();
builder.Services.AddSession();

app.UseRouting();
app.UseSession();
app.UseDoconutResources();
app.Map("/doconut", branch => branch.UseDoconut());

MiddlewarePath est une valeur de coordination ; elle ne mappe pas une branche ASP.NET Core à elle seule. Dans cet exemple, l'hôte mappe /doconut, ainsi le client utilise BasePath: 'doconut'. ResourcesPath sert le bundle intégré à /doconut-res, et le chemin des ressources d'image du widget est donc ResPath: 'doconut-res/images'. Écrivez les deux sans slash initial : le viewer en ajoute un lui‑même, donc '/doconut' deviendrait //doconut/DocImage.axd, que le navigateur interprète comme une requête vers un hôte nommé doconut, et le viewer échoue avec « The viewer handler could not be reached ».

Ajouter le viewer à une 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. La recherche et l'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. Utilisez cet ordre :

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 ressources du viewer

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

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 Viewer, demandez le Viewer et les ressources des modules 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 ruban de Recherche ou d'Annotation sans eux, le montage du Viewer, et une docViewer instance. ReferenceCss et ReferenceScripts omettent les ressources d'un module optionnel lorsque la licence actuelle ne permet pas cette capacité ; le Viewer de base démarre tout de même.

Initialiser le visualiseur

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

javascript
let searchBar = null;
let annBar = null;

const objViewer = $('#div_ctlDoc').docViewer({
    showThumbs: true,
    autoLoad:   false,
    pageZoom:   100,
    FitType:    'width',
    BasePath:   'doconut',             // pas de '/' au début
    ResPath:    'doconut-res/images',  // pas de '/' au début
    onViewerReady: function () {
        // les pages sont visibles; il est sûr de masquer un indicateur de chargement ici
    },
    // Transmettre 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);
    }
});

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 ; si la casse est incorrecte, l'option est silencieusement ignorée (le widget revient à sa valeur par défaut au lieu de lever une exception).

Quatre autres détails échouent sans message d'erreur :

  • BasePath n'a pas de slash initial. 'doconut' demande /doconut/DocImage.axd ; '/doconut' produit //doconut/DocImage.axd, que le navigateur interprète comme une requête vers un autre hôte.
  • ResPath: 'doconut-res/images' — les icônes se trouvent un dossier en dessous de la racine des ressources. Avec 'doconut-res', chaque icône renvoie un 404 : aucun glyphe de barre d'outils et aucun indicateur de chargement, tandis que le document lui‑-même s'affiche toujours. Un slash initial le casse de la même façon que BasePath.
  • Les rappels sont des options. onViewerReady, onError et les autres sont placés dans l'objet passé à docViewer(...). Une fonction globale nommée d'après le visualiseur, comme ctlDoc_ViewerReady, n'est jamais appelée.
  • Conservez le visualiseur, puis appelez View séparément. docViewer(...) renvoie l'objet contenant 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.

Assembler le package complet du visualiseur

Une page de visualiseur complète installe les parties suivantes ensemble :

Partie du packageExigenceComment c'est connecté
Ressources du visualiseur, montage, et objViewerObligatoireMoteur de rendu de document principal
Barre d'outils du visualiseurObligatoire 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 visualiseur soit du balisage hôte, elle est installée à côté du visualiseur 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 visualiseur :

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>

Les assistants de rotation, vignette, impression, plein écran, mise en page et état des boutons doivent se trouver dans votre propre script de barre d'outils, qui appelle le même objViewer. Chargez‑le après Viewer.ReferenceScripts(...), et conservez‑le avec son balisage <nav id="toolbar">.

Conservez cet ordre d'initialisation :

  1. Émettre le CSS pour le visualiseur et les modules sous licence.
  2. Rendre la barre d'outils du visualiseur, les montages Recherche/Annotation, et le montage du visualiseur ensemble.
  3. Émettre les scripts pour le visualiseur et les modules sous licence.
  4. Charger le script d'assistance de 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 visualiseur et des modules.

Dans un déploiement distribué, la valeur de requête supplémentaire access et les paramètres de nouvelle tentative de rendu asynchrone appartiennent au transport ; ils ne modifient pas la façon dont le visualiseur, la barre d'outils ou les rubans sont assemblés.

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 de plugin 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. La recherche contient les groupes Trouver, Options et Résultats. L'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.

Le exemple ci‑dessus omet les rappels 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 visualiseur détenue par l'hôte.

Ouvrir un document

Le côté serveur est un point de terminaison : le service injecté Viewer ouvre le document et renvoie un jeton de session.

csharp
app.MapPost("/api/open", async (Viewer viewer) =>
{
    // Le jeton est opaque — transmettez‑le au widget, ne le journalisez ni ne le persistez jamais.
    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);
    });

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 donnée d’authentification : ne le consignez jamais, ne le persistez jamais, ne le transmettez qu’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.

Lancer le tout

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

Une licence manquante ne génère pas d’erreur. Le visualiseur s’affiche 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 ?