Recherche

Recherche de texte native dans la composition du Viewer

Le Viewer Doconut offre une recherche normale en utilisant le texte extrait par le visualiseur de format ou une redirection PDF basée sur du texte. Il nécessite la capacité de licence Search.

Activer l'interface de recherche

Search est un module du Viewer, pas une barre d'outils autonome. La page complète doit inclure les ressources du Viewer, la barre d'outils du Viewer, le montage du Viewer, et le objViewer initialisé ; le Ruban Search est alors monté et attaché à cette même instance.

Search et l'annotation sont des fonctionnalités sous licence intégrées, pas des packages AddPlugin<T>(). Demandez les ressources de recherche à Viewer ; leurs balises ne sont émises que lorsque la licence accorde Search. Les vues MVC 5 n'ont pas de @inject, donc construisez les balises dans le contrôleur et transmettez‑les via ViewBag, avec le drapeau de licence requis par la page :

csharp
public class ViewerController : Controller
{
    public ActionResult Index()
    {
        var viewer = Doconut.DoconutHost.Services.GetRequiredService<Viewer>();
        ViewBag.ViewerCss = viewer.ReferenceCss(new CssConfig
        {
            IncludeViewerCss = true,
            IncludeSearchCss = true
        });
        ViewBag.ViewerScripts = viewer.ReferenceScripts(new ScriptConfig
        {
            IncludeJQuery        = true,
            IncludeViewerScripts = true,
            IncludeSearchScripts = true,
            IncludeSearchBar     = true
        });
        ViewBag.IsSearchEnabled = viewer.IsSearchEnabled;
        return View();
    }
}

Écrivez‑les dans la vue avec @Html.Raw(ViewBag.ViewerCss) et @Html.Raw(ViewBag.ViewerScripts). Dans Web Forms, exposez les mêmes valeurs depuis le code‑behind et écrivez‑les avec <%= %>.

Le ruban intégré appelle les mêmes méthodes JavaScript disponibles pour une interface personnalisée.

Gardez la composition complète du Viewer visible dans le balisage, initialisez d'abord docViewer, puis attachez le Ruban sous licence :

html
<nav id="toolbar" aria-label="Document viewer controls">
    <!-- Contrôles du visualiseur, y compris le bouton qui ouvre la recherche -->
</nav>
<div id="searchBarMount"></div>
<div id="divDocViewer"><div id="div_ctlDoc"></div></div>

<script>
    let searchBar = null;
    let currentToken = '';

    const objViewer = $('#div_ctlDoc').docViewer({
        BasePath: '/',
        ResPath: 'doconut-res/images'
    });

    @if ((bool)ViewBag.IsSearchEnabled)
    {
        <text>
    searchBar = $('#searchBarMount').doconutSearchBar({
        docId: 'ctlDoc',
        getRequestParams: () => ({ token: currentToken }),
        onStatus: (message) => console.log(message),
        onToast: (message, type) => console.log(type, message),
        onLayout: () => requestAnimationFrame(() => objViewer.Refit())
    });
    searchBar.attach(objViewer);
        </text>
    }
</script>

Le if côté serveur est important : sans la capacité Search, ReferenceScripts omet le script du Ruban, de sorte qu'un appel non protégé à doconutSearchBar(...) provoquerait une exception et empêcherait la page du viewer de démarrer. Dans Web Forms, écrivez la même protection avec <% if (IsSearchEnabled) { %> … <% } %>.

Le composant injecte les groupes Find, Options et Results et gère la recherche, le nettoyage, le comptage des correspondances et la navigation précédente/suivante. Une barre d'outils Viewer détenue par l'hôte n'a besoin que de l'activer :

javascript
searchBar.isOpen() ? searchBar.close() : searchBar.open();

Son API publique est volontairement petite :

MéthodeObjectif
attach(objViewer)Connecte le Ruban au viewer initialisé ; requis une fois
open() / close()Affiche ou masque le Ruban ; la fermeture supprime également les surlignages
reset()Efface le terme actuel, le nombre de résultats et les surlignages
isOpen()Indique si le Ruban est visible
setStatus(message)Transmet un message d'état via le rappel configuré

Le rappel optionnel onToggle(isOpen) permet à l'hôte de synchroniser son bouton Search, et onLayout lui permet de redimensionner/ajuster le viewer lorsque la hauteur du Ruban change. Pour la séquence de démarrage combinée du Viewer, de Search et de l'Annotation, voir Démarrage rapide.

Recherche depuis JavaScript

javascript
objViewer.Search(keyword, false, function (resultCount) {
    console.log('Matches:', resultCount);
});

Le deuxième argument correspond à une correspondance mot entier/exacte. Le nombre de correspondances arrive dans le rappel : Search lui‑même se rend au serveur et ne renvoie rien d’utile, donc var n = objViewer.Search(keyword, false) lit toujours undefined — et une page construite de cette façon indique « rien trouvé » tandis que le visualiseur met en surbrillance les correspondances. Après le rappel :

MéthodeRésultat
SearchMatchCount()Nombre total de correspondances individuelles dans le document.
SearchSummary(false)[pageNumber, matchCount] entrées sans repeindre.
SearchSummary(true)Même résumé et peint les surbrillances de page/vignette.
GotoSearchMatch(index)Navigue vers un indice de correspondance basé sur zéro.

DocImage.axd répond à search=<term> et exact=true|false avec XML. Utilisez l’API du widget plutôt que d’analyser vous‑même cette réponse interne.

Vérifier la capacité de recherche

La réponse d’initialisation indique :

text
X-Doconut-Can-Search: 1

Après l’initialisation, objViewer.CanSearch() expose le même verdict format/session. Il renvoie false lorsque le serveur envoie 0 ; avant la réponse, ou avec un serveur plus ancien qui omet l’en‑tête, il revient à true.

Trois portes indépendantes ne doivent pas être confondues :

PortailQuestion
CanSearch() / response headerLe visualiseur résolu possède‑t‑il un chemin d’index/recherche natif ?
AllowSearchCette configuration de format a‑t‑elle demandé l’extraction de texte où le commutateur existe ?
LicenseCapability.SearchL’application est‑elle autorisée à exécuter la recherche et à recevoir les paquets UI ?

Un format peut être techniquement recherchable alors que la licence actuelle refuse l’opération.

Activer l’extraction par format

csharp
var token = await viewer.OpenDocumentAsync(path, new PdfConfig
{
    AllowSearch = true,
    AllowCopy   = true   // optionnel: permet à l'utilisateur de faire glisser une région et de copier son texte
});

AllowSearch et AllowCopy existent sur PdfConfig, WordConfig, ExcelConfig et PptConfig. Les propriétés Office délèguent à leurs PdfConfig imbriqués. Les deux sont par défaut false.

Des adaptateurs de recherche native normaux existent pour PDF, Word, Excel, PowerPoint, TXT, Visio, courriel, EPUB et MHT. XPS utilise son chemin PDF par défaut. HTML et Microsoft Project bénéficient d’une redirection PDF basée sur du texte :

csharp
// DefaultRender = false → converti en PDF basé sur du texte → recherchable
var token = await viewer.OpenDocumentAsync(path, new HtmlConfig { DefaultRender = false });

Pour les rendus natifs, CanSearch() décrit la capacité du visualiseur ; cela ne garantit pas qu’un document particulier contienne du texte exploitable. Un PDF dont les pages ne sont que des images numérisées peut néanmoins produire zéro résultat natif.

Comportement normal de la recherche

Le serveur tente les sources de recherche dans cet ordre :

  1. Résultats du visualiseur natif du format.
  2. Un index de recherche .srh préconstruit.
  3. Une erreur/résultat vide lorsqu’aucune source de recherche n’existe.

CanSearch() peut être vrai pour un visualiseur recherchable même lorsqu’un document particulier n’a pas de couche de texte et renvoie donc aucune correspondance.

Licence et comportement de l’interface

Une licence Temporaire/Démo active autorise la Recherche pendant sa période active. Une licence manquante et un fichier legacy TRIAL n’accordent aucune capacité de Recherche. Sans Recherche :

  • ReferenceCss et ReferenceScripts omettent les paquets de recherche.
  • DocImage.axd refuse les requêtes de recherche au lieu de renvoyer des résultats.

Contrôlez la visibilité de l’UI personnalisée depuis IDoconutLicenseService.IsCapabilityGranted(LicenseCapability.Search) et utilisez CanSearch() pour le verdict séparé format/session.

Dépannage

SymptômeVérification
Barre de recherche manquanteCapacité de recherche et IncludeSearchCss/IncludeSearchScripts/IncludeSearchBar
CanSearch() est fauxVisualiseur de format, chemin DefaultRender sélectionné, et en‑tête de réponse d’initialisation
La recherche renvoie zéro pour un PDF numériséLe document n’a pas de couche de texte ; utilisez une source contenant du texte ou une projection PDF qui préserve le texte
La recherche fonctionne mais les surbrillances sont décaléesChemin de rendu, résolution, transformations du document et boîtes de mots extraites

Cette page était-elle utile ?