Recherche

Le Viewer Doconut fournit 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 auprès du Viewer injecté ; leurs balises ne sont émises que lorsque la licence accorde Search.

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

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

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

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

<nav id="toolbar" aria-label="Document viewer controls">
    <!-- Viewer controls, including the button that opens Search -->
</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: '/doconut',
        ResPath: '/doconut-res/images'
    });

    @if (Viewer.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 composant injecte les groupes Find, Options et Results et gère la recherche, le nettoyage, le comptage des correspondances et la navigation vers la correspondance précédente/suivante. Une barre d'outils Viewer appartenant à l'hôte n'a besoin que de l'activer :

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

Son API publique est intentionnellement petite :

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, Search et Annotation, voir Démarrage rapide.

Recherche depuis JavaScript

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

Le deuxième argument correspond à la correspondance mot entier/exacte. Après le rappel :

La route middleware utilise search=<term> et exact=true|false et renvoie du 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 :

X-Doconut-Can-Search: 1

Après l'initialisation, objViewer.CanSearch() expose le même verdict de 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 renvoie true par défaut.

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

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

Activer l'extraction par format

var token = await viewer.OpenDocumentAsync(path, new PdfConfig
{
    AllowSearch = true,
    AllowCopy   = true   // optional: lets the user drag a region and copy its text
});

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

Des adaptateurs de recherche native existent pour PDF, Word, Excel, PowerPoint, TXT, Visio, email, 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 :

// DefaultRender = false → converted to a text-based PDF → searchable
var token = await viewer.OpenDocumentAsync(path, new HtmlConfig { DefaultRender = false });

Pour les rendus natifs, CanSearch() décrit la capacité du viewer ; 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 toujours produire zéro résultat natif.

Comportement normal de la recherche

Le serveur tente les sources de recherche dans cet ordre :

1. Résultats natifs ISearchableViewer.
2. Un index de recherche préconstruit .srh.
3. Une erreur/résultat vide lorsqu'aucune source de recherche n'existe.

CanSearch() peut être vrai pour un viewer 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 active Temporary/Demo accorde Search pendant sa période active. Une licence manquante et le fichier hérité TRIAL n'accordent aucune capacité Search. Sans Search :

• ReferenceCss et ReferenceScripts omettent les bundles de recherche.
• Le middleware refuse la recherche au lieu de renvoyer des résultats sous licence.

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

Dépannage