Ricerca

Ricerca di testo nativa nella composizione del Viewer

Il Doconut Viewer fornisce la ricerca normale utilizzando il testo estratto dal visualizzatore di formato o un reindirizzamento PDF basato su testo. Richiede la capacità di licenza Search.

Abilita l'interfaccia di ricerca

La ricerca è un modulo del Viewer, non una barra degli strumenti autonoma. La pagina completa deve includere le risorse del Viewer, la barra degli strumenti del Viewer, il montaggio del Viewer e objViewer inizializzato; il Ribbon di ricerca viene quindi montato e collegato alla stessa istanza.

Ricerca e annotazione sono funzionalità con licenza integrate, non pacchetti AddPlugin<T>(). Richiedi le risorse di ricerca da Viewer; i loro tag vengono generati solo quando la licenza concede la Ricerca. Le viste MVC 5 non hanno @inject, quindi crea i tag nel controller e passali su ViewBag, insieme al flag di licenza di cui la pagina ha bisogno:

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();
    }
}

Scrivili nella vista con @Html.Raw(ViewBag.ViewerCss) e @Html.Raw(ViewBag.ViewerScripts). In Web Forms, espone gli stessi valori dal code-behind e scrivili con <%= %>.

Il ribbon incorporato chiama gli stessi metodi JavaScript disponibili per un'interfaccia personalizzata.

Mantieni la composizione completa del Viewer visibile nel markup, inizializza prima docViewer, quindi collega il Ribbon con licenza:

html
<nav id="toolbar" aria-label="Document viewer controls">
    <!-- Controlli del visualizzatore, incluso il pulsante che apre 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: '/',
        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>

Il if lato server è importante: senza la capacità di Ricerca, ReferenceScripts omette lo script del Ribbon, quindi una chiamata non protetta doconutSearchBar(...) genererebbe un'eccezione e fermerebbe l'avvio della pagina del viewer. In Web Forms, scrivi la stessa guardia come <% if (IsSearchEnabled) { %> … <% } %>.

Il componente inietta i gruppi Trova, Opzioni e Risultati e gestisce la ricerca, la cancellazione, il conteggio delle corrispondenze e la navigazione tra le corrispondenze precedenti/successive. Una barra degli strumenti del Viewer di proprietà dell'host deve solo attivarla/disattivarla:

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

La sua API pubblica è intenzionalmente piccola:

MetodoScopo
attach(objViewer)Collega il Ribbon al viewer inizializzato; richiesto una sola volta
open() / close()Mostra o nascondi il Ribbon; la chiusura cancella anche gli evidenziamenti
reset()Cancella il termine corrente, il conteggio dei risultati e gli evidenziamenti
isOpen()Restituisce se il Ribbon è visibile
setStatus(message)Inoltra un messaggio di stato attraverso il callback configurato

Il callback opzionale onToggle(isOpen) consente all'host di sincronizzare il pulsante di Ricerca, e onLayout gli permette di ridimensionare/riadattare il viewer quando l'altezza del Ribbon cambia. Per la sequenza di avvio combinata di Viewer, Ricerca e Annotazione, vedi Avvio Rapido.

Ricerca da JavaScript

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

Il secondo argomento indica la corrispondenza intera/parola intera. Il conteggio delle corrispondenze arriva nella callback: Search stesso va al server e non restituisce nulla di utile, quindi var n = objViewer.Search(keyword, false) legge sempre undefined — e una pagina costruita in questo modo segnala "nothing found" mentre il visualizzatore evidenzia le corrispondenze. Dopo la callback:

MetodoRisultato
SearchMatchCount()Numero totale di corrispondenze individuali nel documento.
SearchSummary(false)[pageNumber, matchCount] voci senza ridisegno.
SearchSummary(true)Stesso riepilogo e dipinge le evidenziazioni della pagina/miniatura.
GotoSearchMatch(index)Naviga a un indice di corrispondenza basato su zero.

DocImage.axd risponde a search=<term> e exact=true|false con XML. Usa l'API del widget invece di analizzare tu stesso quella risposta interna.

Verifica della capacità di ricerca

La risposta di inizializzazione riporta:

text
X-Doconut-Can-Search: 1

Dopo l'inizializzazione, objViewer.CanSearch() espone lo stesso verdetto di formato/sessione. Restituisce false quando il server invia 0; prima della risposta, o con un server più vecchio che omette l'intestazione, il valore predefinito è true.

Tre porte indipendenti non devono essere confuse:

PortaDomanda
CanSearch() / intestazione rispostaIl visualizzatore risolto dispone di un percorso indice/ricerca nativo?
AllowSearchQuesta configurazione di formato ha richiesto l'estrazione del testo dove esiste l'interruttore?
LicenseCapability.SearchL'applicazione è autorizzata a eseguire la ricerca e a ricevere i bundle UI?

Un formato può essere tecnicamente ricercabile mentre la licenza corrente nega l'operazione.

Abilita l'estrazione per formato

csharp
var token = await viewer.OpenDocumentAsync(path, new PdfConfig
{
    AllowSearch = true,
    AllowCopy   = true   // opzionale: consente all'utente di trascinare una regione e copiare il suo testo
});

AllowSearch e AllowCopy esistono su PdfConfig, WordConfig, ExcelConfig e PptConfig. Le proprietà di Office delegano ai loro PdfConfig nidificati. Entrambe hanno come valore predefinito false.

Gli adattatori di ricerca nativi normali esistono per PDF, Word, Excel, PowerPoint, TXT, Visio, email, EPUB e MHT. XPS utilizza il suo percorso PDF per impostazione predefinita. HTML e Microsoft Project beneficiano di un reindirizzamento PDF basato su testo:

csharp
// DefaultRender = false → convertito in un PDF basato su testo → ricercabile
var token = await viewer.OpenDocumentAsync(path, new HtmlConfig { DefaultRender = false });

Per i renderizzatori nativi, CanSearch() descrive la capacità del visualizzatore; non garantisce che un documento specifico contenga testo utilizzabile. Un PDF le cui pagine sono solo immagini scannerizzate può comunque produrre zero risultati nativi.

Comportamento normale della ricerca

Il server prova le fonti di ricerca in questo ordine:

  1. Risultati dal visualizzatore nativo del formato.
  2. Un indice di ricerca predefinito .srh.
  3. Un risultato di errore/vuoto quando non esiste alcuna fonte di ricerca.

CanSearch() può essere vero per un visualizzatore ricercabile anche quando un documento specifico non ha uno strato di testo e quindi non restituisce corrispondenze.

Licenze e comportamento dell'interfaccia

Una licenza Temporanea/Demo attiva concede la Ricerca durante il suo periodo attivo. Una licenza mancante e un file legacy TRIAL non concedono alcuna capacità di Ricerca. Senza Ricerca:

  • ReferenceCss e ReferenceScripts omettono i bundle di ricerca.
  • DocImage.axd rifiuta le richieste di ricerca invece di restituire risultati.

Gestisci la visibilità dell'interfaccia personalizzata da IDoconutLicenseService.IsCapabilityGranted(LicenseCapability.Search) e usa CanSearch() per il verdetto separato di formato/sessione.

Risoluzione dei problemi

SintomoVerifica
La barra di ricerca è assenteCapacità di ricerca e IncludeSearchCss/IncludeSearchScripts/IncludeSearchBar
CanSearch() è falsoVisualizzatore del formato, percorso DefaultRender selezionato e intestazione della risposta di inizializzazione
La ricerca restituisce zero per un PDF scannerizzatoIl documento non ha strato di testo; usa una fonte con testo o una proiezione PDF che preservi il testo
La ricerca funziona ma le evidenziazioni sono sfasatePercorso di rendering, risoluzione, trasformazioni del documento e riquadri delle parole estratte

Questa pagina è stata utile?